X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/70b63a9909bd6accf8ffd385ada2243ba44423b7..b3f62dd5210576c97fcb5f3a74c210e7d5201494:/wxPython/src/mac/_controls.py?ds=sidebyside diff --git a/wxPython/src/mac/_controls.py b/wxPython/src/mac/_controls.py index eb81e91d6a..4cc5f878e7 100644 --- a/wxPython/src/mac/_controls.py +++ b/wxPython/src/mac/_controls.py @@ -99,7 +99,7 @@ class Button(_core.Control): def SetDefault(*args, **kwargs): """ - SetDefault(self) + SetDefault(self) -> Window This sets the button to be the default item for the panel or dialog box. """ @@ -579,7 +579,7 @@ class ComboBox(_core.Control,_core.ItemContainer): __repr__ = _swig_repr def __init__(self, *args, **kwargs): """ - __init__(Window parent, int id, String value=EmptyString, + __init__(Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, List choices=EmptyList, long style=0, Validator validator=DefaultValidator, String name=ComboBoxNameStr) -> ComboBox @@ -591,7 +591,7 @@ class ComboBox(_core.Control,_core.ItemContainer): def Create(*args, **kwargs): """ - Create(Window parent, int id, String value=EmptyString, + Create(Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, List choices=EmptyList, long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool @@ -1116,6 +1116,11 @@ def StaticLine_GetClassDefaultAttributes(*args, **kwargs): #--------------------------------------------------------------------------- +ST_NO_AUTORESIZE = _controls_.ST_NO_AUTORESIZE +ST_MARKUP = _controls_.ST_MARKUP +ST_ELLIPSIZE_START = _controls_.ST_ELLIPSIZE_START +ST_ELLIPSIZE_MIDDLE = _controls_.ST_ELLIPSIZE_MIDDLE +ST_ELLIPSIZE_END = _controls_.ST_ELLIPSIZE_END class StaticText(_core.Control): """Proxy of C++ StaticText class""" thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') @@ -1148,6 +1153,32 @@ class StaticText(_core.Control): """ return _controls_.StaticText_Wrap(*args, **kwargs) + def IsEllipsized(*args, **kwargs): + """IsEllipsized(self) -> bool""" + return _controls_.StaticText_IsEllipsized(*args, **kwargs) + + def RemoveMarkup(*args, **kwargs): + """ + RemoveMarkup(String str) -> String + + Removes the markup accepted by wx.StaticText when wx.ST_MARKUP is + used, and then returns the cleaned string. + + """ + return _controls_.StaticText_RemoveMarkup(*args, **kwargs) + + RemoveMarkup = staticmethod(RemoveMarkup) + def EscapeMarkup(*args, **kwargs): + """ + EscapeMarkup(String str) -> String + + Escapes the alls special symbols (<>"'&) present inside the given + string using the corresponding entities (< > " ' + &) + """ + return _controls_.StaticText_EscapeMarkup(*args, **kwargs) + + EscapeMarkup = staticmethod(EscapeMarkup) def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes @@ -1173,6 +1204,26 @@ def PreStaticText(*args, **kwargs): val = _controls_.new_PreStaticText(*args, **kwargs) return val +def StaticText_RemoveMarkup(*args, **kwargs): + """ + StaticText_RemoveMarkup(String str) -> String + + Removes the markup accepted by wx.StaticText when wx.ST_MARKUP is + used, and then returns the cleaned string. + + """ + return _controls_.StaticText_RemoveMarkup(*args, **kwargs) + +def StaticText_EscapeMarkup(*args, **kwargs): + """ + StaticText_EscapeMarkup(String str) -> String + + Escapes the alls special symbols (<>"'&) present inside the given + string using the corresponding entities (< > " ' + &) + """ + return _controls_.StaticText_EscapeMarkup(*args, **kwargs) + def StaticText_GetClassDefaultAttributes(*args, **kwargs): """ StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes @@ -1493,6 +1544,9 @@ TE_BESTWRAP = _controls_.TE_BESTWRAP TE_RICH2 = _controls_.TE_RICH2 TE_CAPITALIZE = _controls_.TE_CAPITALIZE TE_LINEWRAP = TE_CHARWRAP +PROCESS_ENTER = TE_PROCESS_ENTER +PASSWORD = TE_PASSWORD + TEXT_ALIGNMENT_DEFAULT = _controls_.TEXT_ALIGNMENT_DEFAULT TEXT_ALIGNMENT_LEFT = _controls_.TEXT_ALIGNMENT_LEFT TEXT_ALIGNMENT_CENTRE = _controls_.TEXT_ALIGNMENT_CENTRE @@ -3771,11 +3825,11 @@ class ToolBarBase(_core.Control): return _controls_.ToolBarBase_InsertToolItem(*args, **kwargs) def AddControl(*args, **kwargs): - """AddControl(self, Control control) -> ToolBarToolBase""" + """AddControl(self, Control control, String label=wxEmptyString) -> ToolBarToolBase""" return _controls_.ToolBarBase_AddControl(*args, **kwargs) def InsertControl(*args, **kwargs): - """InsertControl(self, size_t pos, Control control) -> ToolBarToolBase""" + """InsertControl(self, size_t pos, Control control, String label=wxEmptyString) -> ToolBarToolBase""" return _controls_.ToolBarBase_InsertControl(*args, **kwargs) def FindControl(*args, **kwargs): @@ -3966,6 +4020,14 @@ class ToolBar(ToolBarBase): """ return _controls_.ToolBar_Create(*args, **kwargs) + def SetToolNormalBitmap(*args, **kwargs): + """SetToolNormalBitmap(self, int id, Bitmap bitmap)""" + return _controls_.ToolBar_SetToolNormalBitmap(*args, **kwargs) + + def SetToolDisabledBitmap(*args, **kwargs): + """SetToolDisabledBitmap(self, int id, Bitmap bitmap)""" + return _controls_.ToolBar_SetToolDisabledBitmap(*args, **kwargs) + def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes @@ -4831,7 +4893,6 @@ class ListCtrl(_core.Control): CountPerPage = property(GetCountPerPage,doc="See `GetCountPerPage`") EditControl = property(GetEditControl,doc="See `GetEditControl`") FocusedItem = property(GetFocusedItem,doc="See `GetFocusedItem`") - ImageList = property(GetImageList,SetImageList,doc="See `GetImageList` and `SetImageList`") ItemCount = property(GetItemCount,SetItemCount,doc="See `GetItemCount` and `SetItemCount`") MainWindow = property(GetMainWindow,doc="See `GetMainWindow`") SelectedItemCount = property(GetSelectedItemCount,doc="See `GetSelectedItemCount`") @@ -5319,6 +5380,10 @@ class TreeCtrl(_core.Control): """IsBold(self, TreeItemId item) -> bool""" return _controls_.TreeCtrl_IsBold(*args, **kwargs) + def IsEmpty(*args, **kwargs): + """IsEmpty(self) -> bool""" + return _controls_.TreeCtrl_IsEmpty(*args, **kwargs) + def GetChildrenCount(*args, **kwargs): """GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t""" return _controls_.TreeCtrl_GetChildrenCount(*args, **kwargs) @@ -5431,6 +5496,14 @@ class TreeCtrl(_core.Control): """Collapse(self, TreeItemId item)""" return _controls_.TreeCtrl_Collapse(*args, **kwargs) + def CollapseAllChildren(*args, **kwargs): + """CollapseAllChildren(self, TreeItemId item)""" + return _controls_.TreeCtrl_CollapseAllChildren(*args, **kwargs) + + def CollapseAll(*args, **kwargs): + """CollapseAll(self)""" + return _controls_.TreeCtrl_CollapseAll(*args, **kwargs) + def CollapseAndReset(*args, **kwargs): """CollapseAndReset(self, TreeItemId item)""" return _controls_.TreeCtrl_CollapseAndReset(*args, **kwargs) @@ -7125,7 +7198,31 @@ _controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent) #--------------------------------------------------------------------------- class SearchCtrl(TextCtrl): - """Proxy of C++ SearchCtrl class""" + """ + 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): @@ -7134,6 +7231,30 @@ class SearchCtrl(TextCtrl): 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) @@ -7148,44 +7269,110 @@ class SearchCtrl(TextCtrl): return _controls_.SearchCtrl_Create(*args, **kwargs) def SetMenu(*args, **kwargs): - """SetMenu(self, Menu menu)""" + """ + 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""" + """ + 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)""" + """ + 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""" + """ + 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)""" + """ + ShowCancelButton(self, bool show) + + Shows or hides the cancel button. + """ return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs) def IsCancelButtonVisible(*args, **kwargs): - """IsCancelButtonVisible(self) -> bool""" + """ + 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 ?)""" + """ + 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 ?)""" + """ + 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 ?)""" + """ + 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 @@ -7198,10 +7385,10 @@ def PreSearchCtrl(*args, **kwargs): 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) +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)