]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/msw/controls.py
Added some more docstrings, and also a few little tweaks along the way.
[wxWidgets.git] / wxPython / src / msw / controls.py
index f93c22635fce7a6259f8734ce82391f08b8e4b07..1ee35df06695e08f7f1eb74cb22aa69da28dfb57 100644 (file)
@@ -53,16 +53,8 @@ class Button(core.Control):
         """
         return _controls.Button_SetDefault(*args, **kwargs)
 
-    def SetImageLabel(*args, **kwargs):
-        """SetImageLabel(Bitmap bitmap)"""
-        return _controls.Button_SetImageLabel(*args, **kwargs)
-
-    def SetImageMargins(*args, **kwargs):
-        """SetImageMargins(int x, int y)"""
-        return _controls.Button_SetImageMargins(*args, **kwargs)
-
     def GetDefaultSize(*args, **kwargs):
-        """Button.GetDefaultSize() -> Size"""
+        """GetDefaultSize() -> Size"""
         return _controls.Button_GetDefaultSize(*args, **kwargs)
 
     GetDefaultSize = staticmethod(GetDefaultSize)
@@ -91,7 +83,13 @@ def Button_GetDefaultSize(*args, **kwargs):
     return _controls.Button_GetDefaultSize(*args, **kwargs)
 
 class BitmapButton(Button):
-    """A Buttont that contains a bitmap."""
+    """
+    A Button that contains a bitmap.  A bitmap button can be supplied with a
+    single bitmap, and wxWindows will draw all button states using this bitmap. If
+    the application needs more control, additional bitmaps for the selected state,
+    unpressed focused state, and greyed-out state may be supplied.
+
+    """
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxBitmapButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -101,7 +99,7 @@ class BitmapButton(Button):
             Validator validator=DefaultValidator, 
             String name=ButtonNameStr) -> BitmapButton
 
-        Create and show a button.
+        Create and show a button with a bitmap for the label.
         """
         newobj = _controls.new_BitmapButton(*args, **kwargs)
         self.this = newobj.this
@@ -297,7 +295,7 @@ class Choice(core.ControlWithItems):
     def __init__(self, *args, **kwargs):
         """
         __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ChoiceNameStr) -> Choice
         """
@@ -310,7 +308,7 @@ class Choice(core.ControlWithItems):
     def Create(*args, **kwargs):
         """
         Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ChoiceNameStr) -> bool
         """
@@ -360,7 +358,7 @@ class ComboBox(Choice):
         """
         __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, 
             Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ComboBoxNameStr) -> ComboBox
         """
@@ -374,7 +372,7 @@ class ComboBox(Choice):
         """
         Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, 
             Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ComboBoxNameStr) -> bool
         """
@@ -605,7 +603,7 @@ class StaticLine(core.Control):
         return _controls.StaticLine_IsVertical(*args, **kwargs)
 
     def GetDefaultSize(*args, **kwargs):
-        """StaticLine.GetDefaultSize() -> int"""
+        """GetDefaultSize() -> int"""
         return _controls.StaticLine_GetDefaultSize(*args, **kwargs)
 
     GetDefaultSize = staticmethod(GetDefaultSize)
@@ -723,7 +721,7 @@ class ListBox(core.ControlWithItems):
     def __init__(self, *args, **kwargs):
         """
         __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ListBoxNameStr) -> ListBox
         """
@@ -736,7 +734,7 @@ class ListBox(core.ControlWithItems):
     def Create(*args, **kwargs):
         """
         Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ListBoxNameStr) -> bool
         """
@@ -802,6 +800,18 @@ class ListBox(core.ControlWithItems):
         """IsSorted() -> bool"""
         return _controls.ListBox_IsSorted(*args, **kwargs)
 
+    def SetItemForegroundColour(*args, **kwargs):
+        """SetItemForegroundColour(int item, Colour c)"""
+        return _controls.ListBox_SetItemForegroundColour(*args, **kwargs)
+
+    def SetItemBackgroundColour(*args, **kwargs):
+        """SetItemBackgroundColour(int item, Colour c)"""
+        return _controls.ListBox_SetItemBackgroundColour(*args, **kwargs)
+
+    def SetItemFont(*args, **kwargs):
+        """SetItemFont(int item, Font f)"""
+        return _controls.ListBox_SetItemFont(*args, **kwargs)
+
 
 class ListBoxPtr(ListBox):
     def __init__(self, this):
@@ -825,7 +835,7 @@ class CheckListBox(ListBox):
     def __init__(self, *args, **kwargs):
         """
         __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ListBoxNameStr) -> CheckListBox
         """
@@ -838,7 +848,7 @@ class CheckListBox(ListBox):
     def Create(*args, **kwargs):
         """
         Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, 
-            int choices=0, String choices_array=None
+            wxArrayString choices=wxPyEmptyStringArray
             long style=0, Validator validator=DefaultValidator, 
             String name=ListBoxNameStr) -> bool
         """
@@ -916,6 +926,11 @@ TEXT_ATTR_ALIGNMENT = _controls.TEXT_ATTR_ALIGNMENT
 TEXT_ATTR_LEFT_INDENT = _controls.TEXT_ATTR_LEFT_INDENT
 TEXT_ATTR_RIGHT_INDENT = _controls.TEXT_ATTR_RIGHT_INDENT
 TEXT_ATTR_TABS = _controls.TEXT_ATTR_TABS
+TE_HT_UNKNOWN = _controls.TE_HT_UNKNOWN
+TE_HT_BEFORE = _controls.TE_HT_BEFORE
+TE_HT_ON_TEXT = _controls.TE_HT_ON_TEXT
+TE_HT_BELOW = _controls.TE_HT_BELOW
+TE_HT_BEYOND = _controls.TE_HT_BEYOND
 class TextAttr(object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxTextAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -929,6 +944,12 @@ class TextAttr(object):
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
+    def __del__(self, destroy=_controls.delete_TextAttr):
+        """__del__()"""
+        try:
+            if self.thisown: destroy(self)
+        except: pass
+
     def Init(*args, **kwargs):
         """Init()"""
         return _controls.TextAttr_Init(*args, **kwargs)
@@ -1034,7 +1055,7 @@ class TextAttr(object):
         return _controls.TextAttr_IsDefault(*args, **kwargs)
 
     def Combine(*args, **kwargs):
-        """TextAttr.Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
+        """Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
         return _controls.TextAttr_Combine(*args, **kwargs)
 
     Combine = staticmethod(Combine)
@@ -1200,6 +1221,16 @@ class TextCtrl(core.Control):
         """ShowPosition(long pos)"""
         return _controls.TextCtrl_ShowPosition(*args, **kwargs)
 
+    def HitTest(*args, **kwargs):
+        """
+        HitTest(Point pt) -> (result, row, col)
+
+        Find the character at position given in pixels.
+        NB: pt is in device coords (not adjusted for the client area
+        origin nor scrolling)
+        """
+        return _controls.TextCtrl_HitTest(*args, **kwargs)
+
     def Copy(*args, **kwargs):
         """Copy()"""
         return _controls.TextCtrl_Copy(*args, **kwargs)
@@ -1590,12 +1621,13 @@ class RadioBox(core.Control):
         return "<%s.%s; proxy of C++ wxRadioBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
         """
-        __init__(Window parent, int id, String label, Point point=DefaultPosition, 
-            Size size=DefaultSize, int choices=0
-            String choices_array=None, int majorDimension=0, 
+        __init__(Window parent, int id, String label, Point pos=DefaultPosition, 
+            Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray
+            int majorDimension=0, 
             long style=RA_HORIZONTAL, Validator validator=DefaultValidator, 
             String name=RadioBoxNameStr) -> RadioBox
         """
+        if kwargs.has_key('point'): kwargs['pos'] = kwargs['point']
         newobj = _controls.new_RadioBox(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
@@ -1604,9 +1636,9 @@ class RadioBox(core.Control):
 
     def Create(*args, **kwargs):
         """
-        Create(Window parent, int id, String label, Point point=DefaultPosition, 
-            Size size=DefaultSize, int choices=0
-            String choices_array=None, int majorDimension=0, 
+        Create(Window parent, int id, String label, Point pos=DefaultPosition, 
+            Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray
+            int majorDimension=0, 
             long style=RA_HORIZONTAL, Validator validator=DefaultValidator, 
             String name=RadioBoxNameStr) -> bool
         """
@@ -1737,10 +1769,11 @@ class Slider(core.Control):
     def __init__(self, *args, **kwargs):
         """
         __init__(Window parent, int id, int value, int minValue, int maxValue, 
-            Point point=DefaultPosition, Size size=DefaultSize, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=SL_HORIZONTAL, Validator validator=DefaultValidator, 
             String name=SliderNameStr) -> Slider
         """
+        if kwargs.has_key('point'): kwargs['pos'] = kwargs['point']
         newobj = _controls.new_Slider(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
@@ -1750,7 +1783,7 @@ class Slider(core.Control):
     def Create(*args, **kwargs):
         """
         Create(Window parent, int id, int value, int minValue, int maxValue, 
-            Point point=DefaultPosition, Size size=DefaultSize, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=SL_HORIZONTAL, Validator validator=DefaultValidator, 
             String name=SliderNameStr) -> bool
         """
@@ -1809,7 +1842,7 @@ class Slider(core.Control):
         return _controls.Slider_GetThumbLength(*args, **kwargs)
 
     def SetTickFreq(*args, **kwargs):
-        """SetTickFreq(int n, int pos)"""
+        """SetTickFreq(int n, int pos=1)"""
         return _controls.Slider_SetTickFreq(*args, **kwargs)
 
     def GetTickFreq(*args, **kwargs):
@@ -1942,9 +1975,7 @@ class BookCtrl(core.Control):
 
     def AssignImageList(*args, **kwargs):
         """AssignImageList(ImageList imageList)"""
-        val = _controls.BookCtrl_AssignImageList(*args, **kwargs)
-        args[1].thisown = 0
-        return val
+        return _controls.BookCtrl_AssignImageList(*args, **kwargs)
 
     def GetImageList(*args, **kwargs):
         """GetImageList() -> ImageList"""
@@ -2091,7 +2122,7 @@ class Notebook(BookCtrl):
         """
         HitTest(Point pt) -> (tab, where)
 
-        Returns the tab which is hit, and flags indicating where using wxNB_HITTEST_ flags.
+        Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags.
         """
         return _controls.Notebook_HitTest(*args, **kwargs)
 
@@ -3403,9 +3434,7 @@ class ListCtrl(core.Control):
 
     def AssignImageList(*args, **kwargs):
         """AssignImageList(ImageList imageList, int which)"""
-        val = _controls.ListCtrl_AssignImageList(*args, **kwargs)
-        args[1].thisown = 0
-        return val
+        return _controls.ListCtrl_AssignImageList(*args, **kwargs)
 
     def IsVirtual(*args, **kwargs):
         """IsVirtual() -> bool"""
@@ -3979,15 +4008,11 @@ class TreeCtrl(core.Control):
 
     def AssignImageList(*args, **kwargs):
         """AssignImageList(ImageList imageList)"""
-        val = _controls.TreeCtrl_AssignImageList(*args, **kwargs)
-        args[1].thisown = 0
-        return val
+        return _controls.TreeCtrl_AssignImageList(*args, **kwargs)
 
     def AssignStateImageList(*args, **kwargs):
         """AssignStateImageList(ImageList imageList)"""
-        val = _controls.TreeCtrl_AssignStateImageList(*args, **kwargs)
-        args[1].thisown = 0
-        return val
+        return _controls.TreeCtrl_AssignStateImageList(*args, **kwargs)
 
     def GetItemText(*args, **kwargs):
         """GetItemText(TreeItemId item) -> String"""
@@ -4104,7 +4129,7 @@ class TreeCtrl(core.Control):
         return _controls.TreeCtrl_GetFirstChild(*args, **kwargs)
 
     def GetNextChild(*args, **kwargs):
-        """GetNextChild(TreeItemId item, wxTreeItemIdValue cookie) -> PyObject"""
+        """GetNextChild(TreeItemId item, void cookie) -> PyObject"""
         return _controls.TreeCtrl_GetNextChild(*args, **kwargs)
 
     def GetLastChild(*args, **kwargs):
@@ -4195,14 +4220,22 @@ class TreeCtrl(core.Control):
         """Unselect()"""
         return _controls.TreeCtrl_Unselect(*args, **kwargs)
 
+    def UnselectItem(*args, **kwargs):
+        """UnselectItem(TreeItemId item)"""
+        return _controls.TreeCtrl_UnselectItem(*args, **kwargs)
+
     def UnselectAll(*args, **kwargs):
         """UnselectAll()"""
         return _controls.TreeCtrl_UnselectAll(*args, **kwargs)
 
     def SelectItem(*args, **kwargs):
-        """SelectItem(TreeItemId item)"""
+        """SelectItem(TreeItemId item, bool select=True)"""
         return _controls.TreeCtrl_SelectItem(*args, **kwargs)
 
+    def ToggleItemSelection(*args, **kwargs):
+        """ToggleItemSelection(TreeItemId item)"""
+        return _controls.TreeCtrl_ToggleItemSelection(*args, **kwargs)
+
     def EnsureVisible(*args, **kwargs):
         """EnsureVisible(TreeItemId item)"""
         return _controls.TreeCtrl_EnsureVisible(*args, **kwargs)
@@ -4635,12 +4668,12 @@ class HelpProvider(object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def Set(*args, **kwargs):
-        """HelpProvider.Set(HelpProvider helpProvider) -> HelpProvider"""
+        """Set(HelpProvider helpProvider) -> HelpProvider"""
         return _controls.HelpProvider_Set(*args, **kwargs)
 
     Set = staticmethod(Set)
     def Get(*args, **kwargs):
-        """HelpProvider.Get() -> HelpProvider"""
+        """Get() -> HelpProvider"""
         return _controls.HelpProvider_Get(*args, **kwargs)
 
     Get = staticmethod(Get)