]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/gtk/_controls.py
Add docstrings and a dummy class to be used in builds that don't have wxSearchCtrl.
[wxWidgets.git] / wxPython / src / gtk / _controls.py
index c9b4862f13771ab753b2bc40ca4d638e13db6944..2046f1f4fc6d932a2779af5f2bbbea542afd3242 100644 (file)
@@ -707,14 +707,6 @@ class ComboBox(_core.Control,_core.ItemContainer):
         """
         return _controls_.ComboBox_SetStringSelection(*args, **kwargs)
 
-    def SetString(*args, **kwargs):
-        """
-        SetString(self, int n, String string)
-
-        Set the label for the n'th item (zero based) in the list.
-        """
-        return _controls_.ComboBox_SetString(*args, **kwargs)
-
     def SetEditable(*args, **kwargs):
         """SetEditable(self, bool editable)"""
         return _controls_.ComboBox_SetEditable(*args, **kwargs)
@@ -1026,6 +1018,7 @@ _controls_.StaticBox_swigregister(StaticBox)
 StaticBitmapNameStr = cvar.StaticBitmapNameStr
 StaticBoxNameStr = cvar.StaticBoxNameStr
 StaticTextNameStr = cvar.StaticTextNameStr
+StaticLineNameStr = cvar.StaticLineNameStr
 
 def PreStaticBox(*args, **kwargs):
     """PreStaticBox() -> StaticBox"""
@@ -1059,7 +1052,7 @@ class StaticLine(_core.Control):
         """
         __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, 
             Size size=DefaultSize, long style=LI_HORIZONTAL, 
-            String name=StaticTextNameStr) -> StaticLine
+            String name=StaticLineNameStr) -> StaticLine
         """
         _controls_.StaticLine_swiginit(self,_controls_.new_StaticLine(*args, **kwargs))
         self._setOORInfo(self)
@@ -1068,7 +1061,7 @@ class StaticLine(_core.Control):
         """
         Create(self, Window parent, int id=-1, Point pos=DefaultPosition, 
             Size size=DefaultSize, long style=LI_HORIZONTAL, 
-            String name=StaticTextNameStr) -> bool
+            String name=StaticLineNameStr) -> bool
         """
         return _controls_.StaticLine_Create(*args, **kwargs)
 
@@ -1930,6 +1923,10 @@ class TextCtrl(_core.Control):
         """SetEditable(self, bool editable)"""
         return _controls_.TextCtrl_SetEditable(*args, **kwargs)
 
+    def MacCheckSpelling(*args, **kwargs):
+        """MacCheckSpelling(self, bool check)"""
+        return _controls_.TextCtrl_MacCheckSpelling(*args, **kwargs)
+
     def SendTextUpdatedEvent(*args, **kwargs):
         """SendTextUpdatedEvent(self)"""
         return _controls_.TextCtrl_SendTextUpdatedEvent(*args, **kwargs)
@@ -3471,6 +3468,10 @@ TOOL_STYLE_SEPARATOR = _controls_.TOOL_STYLE_SEPARATOR
 TOOL_STYLE_CONTROL = _controls_.TOOL_STYLE_CONTROL
 TB_HORIZONTAL = _controls_.TB_HORIZONTAL
 TB_VERTICAL = _controls_.TB_VERTICAL
+TB_TOP = _controls_.TB_TOP
+TB_LEFT = _controls_.TB_LEFT
+TB_BOTTOM = _controls_.TB_BOTTOM
+TB_RIGHT = _controls_.TB_RIGHT
 TB_3DBUTTONS = _controls_.TB_3DBUTTONS
 TB_FLAT = _controls_.TB_FLAT
 TB_DOCKABLE = _controls_.TB_DOCKABLE
@@ -3481,7 +3482,6 @@ TB_NOALIGN = _controls_.TB_NOALIGN
 TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT
 TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT
 TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS
-TB_BOTTOM = _controls_.TB_BOTTOM
 class ToolBarToolBase(_core.Object):
     """Proxy of C++ ToolBarToolBase class"""
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
@@ -4452,7 +4452,7 @@ class ListCtrl(_core.Control):
             Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl
         """
         _controls_.ListCtrl_swiginit(self,_controls_.new_ListCtrl(*args, **kwargs))
-        self._setOORInfo(self);self._setCallbackInfo(self, ListCtrl)
+        self._setOORInfo(self);ListCtrl._setCallbackInfo(self, self, ListCtrl)
 
     def Create(*args, **kwargs):
         """
@@ -5175,7 +5175,7 @@ class TreeCtrl(_core.Control):
             String name=TreeCtrlNameStr) -> TreeCtrl
         """
         _controls_.TreeCtrl_swiginit(self,_controls_.new_TreeCtrl(*args, **kwargs))
-        self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl)
+        self._setOORInfo(self);TreeCtrl._setCallbackInfo(self, self, TreeCtrl)
 
     def Create(*args, **kwargs):
         """
@@ -5737,16 +5737,13 @@ class PyControl(_core.Control):
             String name=ControlNameStr) -> PyControl
         """
         _controls_.PyControl_swiginit(self,_controls_.new_PyControl(*args, **kwargs))
-        self._setOORInfo(self); self._setCallbackInfo(self, PyControl)
+        self._setOORInfo(self);PyControl._setCallbackInfo(self, self, PyControl)
 
     def _setCallbackInfo(*args, **kwargs):
         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
         return _controls_.PyControl__setCallbackInfo(*args, **kwargs)
 
-    def SetBestSize(*args, **kwargs):
-        """SetBestSize(self, Size size)"""
-        return _controls_.PyControl_SetBestSize(*args, **kwargs)
-
+    SetBestSize = wx.Window.SetInitialSize 
     def DoEraseBackground(*args, **kwargs):
         """DoEraseBackground(self, DC dc) -> bool"""
         return _controls_.PyControl_DoEraseBackground(*args, **kwargs)
@@ -6946,7 +6943,7 @@ class FontPickerCtrl(PickerBase):
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
         """
-        __init__(self, Window parent, int id=-1, Font initial=*wxNORMAL_FONT
+        __init__(self, Window parent, int id=-1, Font initial=wxNullFont
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=FNTP_DEFAULT_STYLE, Validator validator=DefaultValidator, 
             String name=FontPickerCtrlNameStr) -> FontPickerCtrl
@@ -6956,7 +6953,7 @@ class FontPickerCtrl(PickerBase):
 
     def Create(*args, **kwargs):
         """
-        Create(self, Window parent, int id=-1, Font initial=*wxNORMAL_FONT
+        Create(self, Window parent, int id=-1, Font initial=wxNullFont
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=FNTP_DEFAULT_STYLE, Validator validator=DefaultValidator, 
             String name=FontPickerCtrlNameStr) -> bool
@@ -7010,5 +7007,208 @@ class FontPickerEvent(_core.CommandEvent):
     Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") 
 _controls_.FontPickerEvent_swigregister(FontPickerEvent)
 
+#---------------------------------------------------------------------------
+
+CP_DEFAULT_STYLE = _controls_.CP_DEFAULT_STYLE
+CP_NO_TLW_RESIZE = _controls_.CP_NO_TLW_RESIZE
+class CollapsiblePane(_core.Control):
+    """
+    A collapsable pane is a container with an embedded button-like
+    control which can be used by the user to collapse or expand the pane's
+    contents.
+
+    Once constructed you should use the `GetPane` function to access the
+    pane and add your controls inside it (i.e. use the window returned
+    from `GetPane` as the parent for the controls which must go in the
+    pane, NOT the wx.CollapsiblePane itself!).
+
+    Note that because of its nature of control which can dynamically (and
+    drastically) change its size at run-time under user-input, when
+    putting a wx.CollapsiblePane inside a `wx.Sizer` you should be careful
+    to add it with a proportion value of zero; this is because otherwise
+    all other windows with non-zero proportion values would automatically
+    get resized each time the user expands or collapses the pane window,
+    usually resulting a weird, flickering effect.
+    """
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
+        """
+        __init__(self, Window parent, int winid=-1, String label=EmptyString, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=CP_DEFAULT_STYLE, Validator val=DefaultValidator, 
+            String name=CollapsiblePaneNameStr) -> CollapsiblePane
+
+        Create and show a wx.CollapsiblePane
+        """
+        _controls_.CollapsiblePane_swiginit(self,_controls_.new_CollapsiblePane(*args, **kwargs))
+        self._setOORInfo(self)
+
+    def Create(*args, **kwargs):
+        """
+        Create(self, Window parent, int winid=-1, String label=EmptyString, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=CP_DEFAULT_STYLE, Validator val=DefaultValidator, 
+            String name=CollapsiblePaneNameStr) -> bool
+        """
+        return _controls_.CollapsiblePane_Create(*args, **kwargs)
+
+    def Collapse(*args, **kwargs):
+        """
+        Collapse(self, bool collapse=True)
+
+        Collapses or expands the pane window.
+        """
+        return _controls_.CollapsiblePane_Collapse(*args, **kwargs)
+
+    def Expand(*args, **kwargs):
+        """
+        Expand(self)
+
+        Same as Collapse(False).
+        """
+        return _controls_.CollapsiblePane_Expand(*args, **kwargs)
+
+    def IsCollapsed(*args, **kwargs):
+        """
+        IsCollapsed(self) -> bool
+
+        Returns ``True`` if the pane window is currently hidden.
+        """
+        return _controls_.CollapsiblePane_IsCollapsed(*args, **kwargs)
+
+    def IsExpanded(*args, **kwargs):
+        """
+        IsExpanded(self) -> bool
+
+        Returns ``True`` if the pane window is currently shown.
+        """
+        return _controls_.CollapsiblePane_IsExpanded(*args, **kwargs)
+
+    def GetPane(*args, **kwargs):
+        """
+        GetPane(self) -> Window
+
+        Returns a reference to the pane window.  Use the returned `wx.Window`
+        as the parent of widgets to make them part of the collapsible area.
+        """
+        return _controls_.CollapsiblePane_GetPane(*args, **kwargs)
+
+    Expanded = property(IsExpanded) 
+    Collapsed = property(IsCollapsed) 
+_controls_.CollapsiblePane_swigregister(CollapsiblePane)
+CollapsiblePaneNameStr = cvar.CollapsiblePaneNameStr
+
+def PreCollapsiblePane(*args, **kwargs):
+    """
+    PreCollapsiblePane() -> CollapsiblePane
+
+    Precreate a wx.CollapsiblePane for 2-phase creation.
+    """
+    val = _controls_.new_PreCollapsiblePane(*args, **kwargs)
+    return val
+
+wxEVT_COMMAND_COLLPANE_CHANGED = _controls_.wxEVT_COMMAND_COLLPANE_CHANGED
+EVT_COLLAPSIBLEPANE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_COLLPANE_CHANGED, 1 )
+
+class CollapsiblePaneEvent(_core.CommandEvent):
+    """Proxy of C++ CollapsiblePaneEvent class"""
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
+        """__init__(self, Object generator, int id, bool collapsed) -> CollapsiblePaneEvent"""
+        _controls_.CollapsiblePaneEvent_swiginit(self,_controls_.new_CollapsiblePaneEvent(*args, **kwargs))
+    def GetCollapsed(*args, **kwargs):
+        """GetCollapsed(self) -> bool"""
+        return _controls_.CollapsiblePaneEvent_GetCollapsed(*args, **kwargs)
+
+    def SetCollapsed(*args, **kwargs):
+        """SetCollapsed(self, bool c)"""
+        return _controls_.CollapsiblePaneEvent_SetCollapsed(*args, **kwargs)
+
+    Collapsed = property(GetCollapsed,SetCollapsed) 
+_controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent)
+
+#---------------------------------------------------------------------------
+
+class SearchCtrl(TextCtrl):
+    """Proxy of C++ SearchCtrl class"""
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
+        """
+        __init__(self, Window parent, int id=-1, String value=wxEmptyString, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=0, Validator validator=DefaultValidator, 
+            String name=SearchCtrlNameStr) -> SearchCtrl
+        """
+        _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
+        self._setOORInfo(self)
+
+    def Create(*args, **kwargs):
+        """
+        Create(self, Window parent, int id=-1, String value=wxEmptyString, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=0, Validator validator=DefaultValidator, 
+            String name=SearchCtrlNameStr) -> bool
+        """
+        return _controls_.SearchCtrl_Create(*args, **kwargs)
+
+    def SetMenu(*args, **kwargs):
+        """SetMenu(self, Menu menu)"""
+        return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
+
+    def GetMenu(*args, **kwargs):
+        """GetMenu(self) -> Menu"""
+        return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
+
+    def ShowSearchButton(*args, **kwargs):
+        """ShowSearchButton(self, bool show)"""
+        return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
+
+    def IsSearchButtonVisible(*args, **kwargs):
+        """IsSearchButtonVisible(self) -> bool"""
+        return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
+
+    def ShowCancelButton(*args, **kwargs):
+        """ShowCancelButton(self, bool show)"""
+        return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
+
+    def IsCancelButtonVisible(*args, **kwargs):
+        """IsCancelButtonVisible(self) -> bool"""
+        return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
+
+    def SetSearchBitmap(*args, **kwargs):
+        """SetSearchBitmap(self, Bitmap bitmap)"""
+        return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
+
+    def SetSearchMenuBitmap(*args, **kwargs):
+        """SetSearchMenuBitmap(self, Bitmap bitmap)"""
+        return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
+
+    def SetCancelBitmap(*args, **kwargs):
+        """SetCancelBitmap(self, Bitmap bitmap)"""
+        return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
+
+    Menu = property(GetMenu,SetMenu) 
+    SearchButtonVisible = property(IsSearchButtonVisible,ShowSearchButton) 
+    CancelButtonVisible = property(IsCancelButtonVisible,ShowCancelButton) 
+_controls_.SearchCtrl_swigregister(SearchCtrl)
+SearchCtrlNameStr = cvar.SearchCtrlNameStr
+
+def PreSearchCtrl(*args, **kwargs):
+    """
+    PreSearchCtrl() -> SearchCtrl
+
+    Precreate a wx.SearchCtrl for 2-phase creation.
+    """
+    val = _controls_.new_PreSearchCtrl(*args, **kwargs)
+    return val
+
+wxEVT_COMMAND_SEARCHCTRL_CANCEL = _controls_.wxEVT_COMMAND_SEARCHCTRL_CANCEL
+wxEVT_COMMAND_SEARCHCTRL_SEARCH = _controls_.wxEVT_COMMAND_SEARCHCTRL_SEARCH
+EVT_SEARCHCTRL_CANCEL = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_CANCEL, 1)
+EVT_SEARCHCTRL_SEARCH = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_SEARCH, 1)
+