+#---------------------------------------------------------------------------
+
+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):
+ """
+ A search control is a composite of a `wx.TextCtrl` with optional
+ bitmap buttons and a drop-down menu. Controls like this can typically
+ be found on a toolbar of applications that support some form of search
+ functionality. On the Mac this control is implemented using the
+ native HISearchField control, on the other platforms a generic control
+ is used, although that may change in the future as more platforms
+ introduce native search widgets.
+
+ If you wish to use a drop-down menu with your wx.SearchCtrl then you
+ will need to manage its content and handle the menu events yourself,
+ but this is an easy thing to do. Simply build the menu, pass it to
+ `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+ This gives you the flexibility to use the drop-down menu however you
+ wish, such as for a history of searches, or as a way to select
+ different kinds of searches. The ToolBar.py sample in the demo shows
+ one way to do this.
+
+ Since the control derives from `wx.TextCtrl` it is convenient to use
+ the styles and events designed for `wx.TextCtrl`. For example you can
+ use the ``wx.TE_PROCESS_ENTER`` style and catch the
+ ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+ Enter key in the control and wishes to start a search.
+
+ """
+ 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
+
+ A search control is a composite of a `wx.TextCtrl` with optional
+ bitmap buttons and a drop-down menu. Controls like this can typically
+ be found on a toolbar of applications that support some form of search
+ functionality. On the Mac this control is implemented using the
+ native HISearchField control, on the other platforms a generic control
+ is used, although that may change in the future as more platforms
+ introduce native search widgets.
+
+ If you wish to use a drop-down menu with your wx.SearchCtrl then you
+ will need to manage its content and handle the menu events yourself,
+ but this is an easy thing to do. Simply build the menu, pass it to
+ `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+ This gives you the flexibility to use the drop-down menu however you
+ wish, such as for a history of searches, or as a way to select
+ different kinds of searches. The ToolBar.py sample in the demo shows
+ one way to do this.
+
+ Since the control derives from `wx.TextCtrl` it is convenient to use
+ the styles and events designed for `wx.TextCtrl`. For example you can
+ use the ``wx.TE_PROCESS_ENTER`` style and catch the
+ ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+ Enter key in the control and wishes to start a search.
+
+ """
+ _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)
+
+ Sets the search control's menu object. If there is already a menu
+ associated with the search control it is deleted.
+ """
+ return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
+
+ def GetMenu(*args, **kwargs):
+ """
+ GetMenu(self) -> Menu
+
+ Returns a pointer to the search control's menu object or None if there
+ is no menu attached.
+ """
+ return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
+
+ def ShowSearchButton(*args, **kwargs):
+ """
+ ShowSearchButton(self, bool show)
+
+ Sets the search button visibility value on the search control. If
+ there is a menu attached, the search button will be visible regardless
+ of the search button visibility value. This has no effect in Mac OS X
+ v10.3
+ """
+ return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
+
+ def IsSearchButtonVisible(*args, **kwargs):
+ """
+ IsSearchButtonVisible(self) -> bool
+
+ Returns the search button visibility value. If there is a menu
+ attached, the search button will be visible regardless of the search
+ button visibility value. This always returns false in Mac OS X v10.3
+ """
+ return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
+
+ def ShowCancelButton(*args, **kwargs):
+ """
+ ShowCancelButton(self, bool show)
+
+ Shows or hides the cancel button.
+ """
+ return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
+
+ def IsCancelButtonVisible(*args, **kwargs):
+ """
+ IsCancelButtonVisible(self) -> bool
+
+ Indicates whether the cancel button is visible.
+ """
+ return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
+
+ def SetDescriptiveText(*args, **kwargs):
+ """
+ SetDescriptiveText(self, String text)
+
+ Set the text to be displayed when the user has not yet typed anything
+ in the control.
+ """
+ return _controls_.SearchCtrl_SetDescriptiveText(*args, **kwargs)
+
+ def GetDescriptiveText(*args, **kwargs):
+ """
+ GetDescriptiveText(self) -> String
+
+ Get the text to be displayed when the user has not yet typed anything
+ in the control.
+ """
+ return _controls_.SearchCtrl_GetDescriptiveText(*args, **kwargs)
+
+ def SetSearchBitmap(*args, **kwargs):
+ """
+ SetSearchBitmap(self, Bitmap ?)
+
+ Sets the bitmap to use for the search button. This currently does not
+ work on the Mac.
+ """
+ return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
+
+ def SetSearchMenuBitmap(*args, **kwargs):
+ """
+ SetSearchMenuBitmap(self, Bitmap ?)
+
+ Sets the bitmap to use for the search button when there is a drop-down
+ menu associated with the search control. This currently does not work
+ on the Mac.
+ """
+ return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
+
+ def SetCancelBitmap(*args, **kwargs):
+ """
+ SetCancelBitmap(self, Bitmap ?)
+
+ Sets the bitmap to use for the cancel button. This currently does not
+ work on the Mac.
+ """
+ return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
+
+ Menu = property(GetMenu,SetMenu)
+ SearchButtonVisible = property(IsSearchButtonVisible,ShowSearchButton)
+ CancelButtonVisible = property(IsCancelButtonVisible,ShowCancelButton)
+ DescriptiveText = property(GetDescriptiveText,SetDescriptiveText)
+_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_BTN = _controls_.wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN
+wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN = _controls_.wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN
+EVT_SEARCHCTRL_CANCEL_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN, 1)
+EVT_SEARCHCTRL_SEARCH_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN, 1)
+
projects / wxWidgets.git / blobdiff