.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.popupctl

.. highlight:: python



.. _wx.lib.popupctl.PopupControl:

==========================================================================================================================================
|phoenix_title|  **wx.lib.popupctl.PopupControl**
==========================================================================================================================================

Control(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, validator: Validator=DefaultValidator, name: str=ControlNameStr) -> None
Control() -> None

This is the base class for a control or "widget".



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PopupControl</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.popupctl.PopupControl_inheritance.svg" alt="Inheritance diagram of PopupControl" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.popupctl.PopupControl.html" title="Control(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, validator: Validator=DefaultValidator, name: str=ControlNameStr) -> None" alt="" coords="5,389,243,418"/> <area shape="rect" id="node2" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="72,313,177,341"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="69,236,180,265"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="50,159,198,188"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="58,82,191,111"/> <area shape="rect" id="node6" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="8,5,107,34"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="131,5,254,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Control`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.popupctl.PopupControl.__init__`                                   Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.popupctl.PopupControl.DoGetBestSize`                              DoGetBestSize(self) -> Size
:meth:`~wx.lib.popupctl.PopupControl.Enable`                                     Enable(enable: bool=True) -> bool
:meth:`~wx.lib.popupctl.PopupControl.FormatContent`                              
:meth:`~wx.lib.popupctl.PopupControl.GetFont`                                    GetFont() -> Font
:meth:`~wx.lib.popupctl.PopupControl.GetValue`                                   
:meth:`~wx.lib.popupctl.PopupControl.OnButton`                                   
:meth:`~wx.lib.popupctl.PopupControl.OnFocus`                                    
:meth:`~wx.lib.popupctl.PopupControl.OnSize`                                     
:meth:`~wx.lib.popupctl.PopupControl.PopDown`                                    
:meth:`~wx.lib.popupctl.PopupControl.SetFont`                                    SetFont(font : Font) -> bool
:meth:`~wx.lib.popupctl.PopupControl.SetPopupAlignment`                          
:meth:`~wx.lib.popupctl.PopupControl.SetPopupContent`                            
:meth:`~wx.lib.popupctl.PopupControl.SetValue`                                   
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.lib.popupctl.PopupControl.buttonWidth`                                
:attr:`~wx.lib.popupctl.PopupControl.marginWidth`                                
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: PopupControl(wx.Control)

   Control(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, validator: Validator=DefaultValidator, name: str=ControlNameStr) -> None
   Control() -> None
   
   This is the base class for a control or "widget".

   .. method:: __init__(self,\*_args,\*\*_kwargs)

      Initialize self.  See help(type(self)) for accurate signature.


   .. method:: DoGetBestSize(self)

      DoGetBestSize(self) -> Size


   .. method:: Enable(self, flag)

      Enable(enable: bool=True) -> bool
      
      Enable or disable the window for user input.


   .. method:: FormatContent(self)


   .. method:: GetFont(self)

      GetFont() -> Font
      
      Returns the font for this window.


   .. method:: GetValue(self)


   .. method:: OnButton(self, evt)


   .. method:: OnFocus(self,evt)


   .. method:: OnSize(self, evt)


   .. method:: PopDown(self)


   .. method:: SetFont(self, font)

      SetFont(font : Font) -> bool
      
      Sets the font for this window.


   .. method:: SetPopupAlignment(self, align)


   .. method:: SetPopupContent(self, content)


   .. method:: SetValue(self, value)