X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/908b74cdd65b7008c87809882a48a95e5851f249..c72066194932cc6760f59be3de66be77798efcd6:/wxPython/src/gtk/_controls.py diff --git a/wxPython/src/gtk/_controls.py b/wxPython/src/gtk/_controls.py index 89076dc3fc..a4cbe12200 100644 --- a/wxPython/src/gtk/_controls.py +++ b/wxPython/src/gtk/_controls.py @@ -451,6 +451,8 @@ class Choice(_core.ControlWithItems): Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, List choices=[], long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool + + Actually create the GUI Choice control for 2-phase creation """ return _controls_.Choice_Create(*args, **kwargs) @@ -567,6 +569,8 @@ class ComboBox(_core.Control,_core.ItemContainer): Point pos=DefaultPosition, Size size=DefaultSize, List choices=[], long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool + + Actually create the GUI wxComboBox control for 2-phase creation """ return _controls_.ComboBox_Create(*args, **kwargs) @@ -1666,7 +1670,11 @@ class TextCtrl(_core.Control): return _controls_.TextCtrl_IsMultiLine(*args, **kwargs) def GetSelection(*args, **kwargs): - """GetSelection() -> (from, to)""" + """ + GetSelection() -> (from, to) + + If the return values from and to are the same, there is no selection. + """ return _controls_.TextCtrl_GetSelection(*args, **kwargs) def GetStringSelection(*args, **kwargs): @@ -1746,7 +1754,12 @@ class TextCtrl(_core.Control): return _controls_.TextCtrl_ShowPosition(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt) -> (result, row, col)""" + """ + HitTest(Point pt) -> (result, row, col) + + Find the character at position given in pixels. NB: pt is in device + coords but is not adjusted for the client area origin nor scrolling + """ return _controls_.TextCtrl_HitTest(*args, **kwargs) def Copy(*args, **kwargs): @@ -2960,7 +2973,12 @@ class Notebook(BookCtrl): return _controls_.Notebook_SetTabSize(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt) -> (tab, where)""" + """ + HitTest(Point pt) -> (tab, where) + + Returns the tab which is hit, and flags indicating where using + wx.NB_HITTEST flags. + """ return _controls_.Notebook_HitTest(*args, **kwargs) def CalcSizeFromPage(*args, **kwargs): @@ -4434,7 +4452,12 @@ class ListCtrl(_core.Control): return _controls_.ListCtrl_FindItemAtPos(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point) -> (item, where)""" + """ + HitTest(Point point) -> (item, where) + + Determines which item (if any) is at the specified point, giving + in the second return value (see wxLIST_HITTEST_... flags.) + """ return _controls_.ListCtrl_HitTest(*args, **kwargs) def InsertItem(*args, **kwargs): @@ -5224,7 +5247,14 @@ class TreeCtrl(_core.Control): return _controls_.TreeCtrl_SortChildren(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point) -> (item, where)""" + """ + HitTest(Point point) -> (item, where) + + Determine which item (if any) belongs the given point. The coordinates + specified are relative to the client area of tree ctrl and the where return + value is set to a bitmask of wxTREE_HITTEST_xxx constants. + + """ return _controls_.TreeCtrl_HitTest(*args, **kwargs) def GetBoundingRect(*args, **kwargs): @@ -5375,7 +5405,15 @@ class GenericDirCtrl(_core.Control): return _controls_.GenericDirCtrl_GetFilterListCtrl(*args, **kwargs) def FindChild(*args, **kwargs): - """FindChild(wxTreeItemId parentId, wxString path) -> (item, done)""" + """ + FindChild(wxTreeItemId parentId, wxString path) -> (item, done) + + Find the child that matches the first part of 'path'. E.g. if a child + path is "/usr" and 'path' is "/usr/include" then the child for + /usr is returned. If the path string has been used (we're at the + leaf), done is set to True. + + """ return _controls_.GenericDirCtrl_FindChild(*args, **kwargs) def DoResize(*args, **kwargs):