Fixed comment bug [ 1390056 ] Wrong Documentation for TransferFromWindow
[wxWidgets.git] / wxPython / src / gtk / _windows.py
index 7f31a6179e473daf24614fcd8563762057d90b26..23c3cc6b0709df01ef748680e5de121a4a469bd1 100644 (file)
@@ -413,19 +413,11 @@ class TopLevelWindow(_core.Window):
         return _windows_.TopLevelWindow_IsFullScreen(*args, **kwargs)
 
     def SetTitle(*args, **kwargs):
-        """
-        SetTitle(self, String title)
-
-        Sets the window's title. Applicable only to frames and dialogs.
-        """
+        """SetTitle(self, String title)"""
         return _windows_.TopLevelWindow_SetTitle(*args, **kwargs)
 
     def GetTitle(*args, **kwargs):
-        """
-        GetTitle(self) -> String
-
-        Gets the window's title. Applicable only to frames and dialogs.
-        """
+        """GetTitle(self) -> String"""
         return _windows_.TopLevelWindow_GetTitle(*args, **kwargs)
 
     def SetShape(*args, **kwargs):
@@ -516,8 +508,8 @@ class Frame(TopLevelWindow):
     Command = ProcessCommand 
     def CreateStatusBar(*args, **kwargs):
         """
-        CreateStatusBar(self, int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE
-            int winid=0, String name=StatusLineNameStr) -> StatusBar
+        CreateStatusBar(self, int number=1, long style=DEFAULT_STATUSBAR_STYLE, int winid=0
+            String name=StatusLineNameStr) -> StatusBar
         """
         return _windows_.Frame_CreateStatusBar(*args, **kwargs)
 
@@ -857,7 +849,7 @@ class StatusBar(_core.Window):
         return "<%s.%s; proxy of C++ wxStatusBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
         """
-        __init__(self, Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, 
+        __init__(self, Window parent, int id=-1, long style=DEFAULT_STATUSBAR_STYLE, 
             String name=StatusLineNameStr) -> StatusBar
         """
         newobj = _windows_.new_StatusBar(*args, **kwargs)
@@ -1137,7 +1129,7 @@ class SplitterWindow(_core.Window):
         """
         SetSashSize(self, int width)
 
-        Sets the sash size.  Currently a NOP.
+        Sets the sash size.
         """
         return _windows_.SplitterWindow_SetSashSize(*args, **kwargs)
 
@@ -1972,6 +1964,18 @@ class VScrolledWindow(Panel):
         """GetLineCount(self) -> size_t"""
         return _windows_.VScrolledWindow_GetLineCount(*args, **kwargs)
 
+    def GetVisibleBegin(*args, **kwargs):
+        """GetVisibleBegin(self) -> size_t"""
+        return _windows_.VScrolledWindow_GetVisibleBegin(*args, **kwargs)
+
+    def GetVisibleEnd(*args, **kwargs):
+        """GetVisibleEnd(self) -> size_t"""
+        return _windows_.VScrolledWindow_GetVisibleEnd(*args, **kwargs)
+
+    def IsVisible(*args, **kwargs):
+        """IsVisible(self, size_t line) -> bool"""
+        return _windows_.VScrolledWindow_IsVisible(*args, **kwargs)
+
     def GetFirstVisibleLine(*args, **kwargs):
         """GetFirstVisibleLine(self) -> size_t"""
         return _windows_.VScrolledWindow_GetFirstVisibleLine(*args, **kwargs)
@@ -1980,10 +1984,6 @@ class VScrolledWindow(Panel):
         """GetLastVisibleLine(self) -> size_t"""
         return _windows_.VScrolledWindow_GetLastVisibleLine(*args, **kwargs)
 
-    def IsVisible(*args, **kwargs):
-        """IsVisible(self, size_t line) -> bool"""
-        return _windows_.VScrolledWindow_IsVisible(*args, **kwargs)
-
 
 class VScrolledWindowPtr(VScrolledWindow):
     def __init__(self, this):
@@ -2640,11 +2640,22 @@ class MultiChoiceDialog(Dialog):
         return "<%s.%s; proxy of C++ wxMultiChoiceDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
         """
-        __init__(Window parent, String message, String caption,
-            List choices=[], long style=CHOICEDLG_STYLE,
+        __init__(self, Window parent, String message, String caption,
+            List choices=EmptyList, long style=CHOICEDLG_STYLE,
             Point pos=DefaultPosition) -> MultiChoiceDialog
 
-        Constructor.  Use ShowModal method to show the dialog.
+        Constructor.  Use the `ShowModal` method to show the dialog.
+
+            :param parent: The parent window.
+            :param message: Text to display above the list of selections.
+            :param caption: Text to use in the title bar of the dialog.
+            :param choices: A list of strings or unicode objects that the
+                user is allowed to choose from.
+            :param style: Styles to apply to the dialog.  The default value is
+                equivallent to wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.OK|wx.CANCEL|wx.CENTER.
+            :param pos: Where to position the dialog (not used on Windows)
+
+
         """
         newobj = _windows_.new_MultiChoiceDialog(*args, **kwargs)
         self.this = newobj.this
@@ -2657,7 +2668,8 @@ class MultiChoiceDialog(Dialog):
         SetSelections(List selections)
 
         Specify the items in the list that should be selected, using a list of
-        integers.
+        integers.  The list should specify the indexes of the items that
+        should be selected.
         """
         return _windows_.MultiChoiceDialog_SetSelections(*args, **kwargs)
 
@@ -2666,6 +2678,7 @@ class MultiChoiceDialog(Dialog):
         GetSelections() -> [selections]
 
         Returns a list of integers representing the items that are selected.
+        If an item is selected then its index will appear in the list.
         """
         return _windows_.MultiChoiceDialog_GetSelections(*args, **kwargs)
 
@@ -2684,7 +2697,7 @@ class SingleChoiceDialog(Dialog):
     def __init__(self, *args, **kwargs):
         """
         __init__(Window parent, String message, String caption,
-            List choices=[], long style=CHOICEDLG_STYLE,
+            List choices=EmptyList, long style=CHOICEDLG_STYLE,
             Point pos=DefaultPosition) -> SingleChoiceDialog
 
         Constructor.  Use ShowModal method to show the dialog.
@@ -3380,7 +3393,7 @@ class MDIParentFrame(Frame):
         return _windows_.MDIParentFrame_GetToolBar(*args, **kwargs)
 
     def Tile(*args, **kwargs):
-        """Tile(self)"""
+        """Tile(self, int orient=HORIZONTAL)"""
         return _windows_.MDIParentFrame_Tile(*args, **kwargs)
 
 
@@ -3504,6 +3517,10 @@ class PyWindow(_core.Window):
         """SetBestSize(self, Size size)"""
         return _windows_.PyWindow_SetBestSize(*args, **kwargs)
 
+    def DoEraseBackground(*args, **kwargs):
+        """DoEraseBackground(self, DC dc) -> bool"""
+        return _windows_.PyWindow_DoEraseBackground(*args, **kwargs)
+
     def base_DoMoveWindow(*args, **kwargs):
         """base_DoMoveWindow(self, int x, int y, int width, int height)"""
         return _windows_.PyWindow_base_DoMoveWindow(*args, **kwargs)
@@ -3580,14 +3597,14 @@ class PyWindow(_core.Window):
         """base_ShouldInheritColours(self) -> bool"""
         return _windows_.PyWindow_base_ShouldInheritColours(*args, **kwargs)
 
-    def base_ApplyParentThemeBackground(*args, **kwargs):
-        """base_ApplyParentThemeBackground(self, Colour c)"""
-        return _windows_.PyWindow_base_ApplyParentThemeBackground(*args, **kwargs)
-
     def base_GetDefaultAttributes(*args, **kwargs):
         """base_GetDefaultAttributes(self) -> VisualAttributes"""
         return _windows_.PyWindow_base_GetDefaultAttributes(*args, **kwargs)
 
+    def base_OnInternalIdle(*args, **kwargs):
+        """base_OnInternalIdle(self)"""
+        return _windows_.PyWindow_base_OnInternalIdle(*args, **kwargs)
+
 
 class PyWindowPtr(PyWindow):
     def __init__(self, this):
@@ -3625,6 +3642,10 @@ class PyPanel(Panel):
         """SetBestSize(self, Size size)"""
         return _windows_.PyPanel_SetBestSize(*args, **kwargs)
 
+    def DoEraseBackground(*args, **kwargs):
+        """DoEraseBackground(self, DC dc) -> bool"""
+        return _windows_.PyPanel_DoEraseBackground(*args, **kwargs)
+
     def base_DoMoveWindow(*args, **kwargs):
         """base_DoMoveWindow(self, int x, int y, int width, int height)"""
         return _windows_.PyPanel_base_DoMoveWindow(*args, **kwargs)
@@ -3701,14 +3722,14 @@ class PyPanel(Panel):
         """base_ShouldInheritColours(self) -> bool"""
         return _windows_.PyPanel_base_ShouldInheritColours(*args, **kwargs)
 
-    def base_ApplyParentThemeBackground(*args, **kwargs):
-        """base_ApplyParentThemeBackground(self, Colour c)"""
-        return _windows_.PyPanel_base_ApplyParentThemeBackground(*args, **kwargs)
-
     def base_GetDefaultAttributes(*args, **kwargs):
         """base_GetDefaultAttributes(self) -> VisualAttributes"""
         return _windows_.PyPanel_base_GetDefaultAttributes(*args, **kwargs)
 
+    def base_OnInternalIdle(*args, **kwargs):
+        """base_OnInternalIdle(self)"""
+        return _windows_.PyPanel_base_OnInternalIdle(*args, **kwargs)
+
 
 class PyPanelPtr(PyPanel):
     def __init__(self, this):
@@ -3736,7 +3757,7 @@ class PyScrolledWindow(ScrolledWindow):
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-        self._setOORInfo(self); self._setCallbackInfo(self, PyPanel)
+        self._setOORInfo(self); self._setCallbackInfo(self, PyScrolledWindow)
 
     def _setCallbackInfo(*args, **kwargs):
         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
@@ -3746,6 +3767,10 @@ class PyScrolledWindow(ScrolledWindow):
         """SetBestSize(self, Size size)"""
         return _windows_.PyScrolledWindow_SetBestSize(*args, **kwargs)
 
+    def DoEraseBackground(*args, **kwargs):
+        """DoEraseBackground(self, DC dc) -> bool"""
+        return _windows_.PyScrolledWindow_DoEraseBackground(*args, **kwargs)
+
     def base_DoMoveWindow(*args, **kwargs):
         """base_DoMoveWindow(self, int x, int y, int width, int height)"""
         return _windows_.PyScrolledWindow_base_DoMoveWindow(*args, **kwargs)
@@ -3822,14 +3847,14 @@ class PyScrolledWindow(ScrolledWindow):
         """base_ShouldInheritColours(self) -> bool"""
         return _windows_.PyScrolledWindow_base_ShouldInheritColours(*args, **kwargs)
 
-    def base_ApplyParentThemeBackground(*args, **kwargs):
-        """base_ApplyParentThemeBackground(self, Colour c)"""
-        return _windows_.PyScrolledWindow_base_ApplyParentThemeBackground(*args, **kwargs)
-
     def base_GetDefaultAttributes(*args, **kwargs):
         """base_GetDefaultAttributes(self) -> VisualAttributes"""
         return _windows_.PyScrolledWindow_base_GetDefaultAttributes(*args, **kwargs)
 
+    def base_OnInternalIdle(*args, **kwargs):
+        """base_OnInternalIdle(self)"""
+        return _windows_.PyScrolledWindow_base_OnInternalIdle(*args, **kwargs)
+
 
 class PyScrolledWindowPtr(PyScrolledWindow):
     def __init__(self, this):
@@ -3994,78 +4019,6 @@ class PrintData(_core.Object):
         """SetPrivData(self, PyObject data)"""
         return _windows_.PrintData_SetPrivData(*args, **kwargs)
 
-    def GetPrinterCommand(*args, **kwargs):
-        """GetPrinterCommand(self) -> String"""
-        return _windows_.PrintData_GetPrinterCommand(*args, **kwargs)
-
-    def GetPrinterOptions(*args, **kwargs):
-        """GetPrinterOptions(self) -> String"""
-        return _windows_.PrintData_GetPrinterOptions(*args, **kwargs)
-
-    def GetPreviewCommand(*args, **kwargs):
-        """GetPreviewCommand(self) -> String"""
-        return _windows_.PrintData_GetPreviewCommand(*args, **kwargs)
-
-    def GetFontMetricPath(*args, **kwargs):
-        """GetFontMetricPath(self) -> String"""
-        return _windows_.PrintData_GetFontMetricPath(*args, **kwargs)
-
-    def GetPrinterScaleX(*args, **kwargs):
-        """GetPrinterScaleX(self) -> double"""
-        return _windows_.PrintData_GetPrinterScaleX(*args, **kwargs)
-
-    def GetPrinterScaleY(*args, **kwargs):
-        """GetPrinterScaleY(self) -> double"""
-        return _windows_.PrintData_GetPrinterScaleY(*args, **kwargs)
-
-    def GetPrinterTranslateX(*args, **kwargs):
-        """GetPrinterTranslateX(self) -> long"""
-        return _windows_.PrintData_GetPrinterTranslateX(*args, **kwargs)
-
-    def GetPrinterTranslateY(*args, **kwargs):
-        """GetPrinterTranslateY(self) -> long"""
-        return _windows_.PrintData_GetPrinterTranslateY(*args, **kwargs)
-
-    def SetPrinterCommand(*args, **kwargs):
-        """SetPrinterCommand(self, String command)"""
-        return _windows_.PrintData_SetPrinterCommand(*args, **kwargs)
-
-    def SetPrinterOptions(*args, **kwargs):
-        """SetPrinterOptions(self, String options)"""
-        return _windows_.PrintData_SetPrinterOptions(*args, **kwargs)
-
-    def SetPreviewCommand(*args, **kwargs):
-        """SetPreviewCommand(self, String command)"""
-        return _windows_.PrintData_SetPreviewCommand(*args, **kwargs)
-
-    def SetFontMetricPath(*args, **kwargs):
-        """SetFontMetricPath(self, String path)"""
-        return _windows_.PrintData_SetFontMetricPath(*args, **kwargs)
-
-    def SetPrinterScaleX(*args, **kwargs):
-        """SetPrinterScaleX(self, double x)"""
-        return _windows_.PrintData_SetPrinterScaleX(*args, **kwargs)
-
-    def SetPrinterScaleY(*args, **kwargs):
-        """SetPrinterScaleY(self, double y)"""
-        return _windows_.PrintData_SetPrinterScaleY(*args, **kwargs)
-
-    def SetPrinterScaling(*args, **kwargs):
-        """SetPrinterScaling(self, double x, double y)"""
-        return _windows_.PrintData_SetPrinterScaling(*args, **kwargs)
-
-    def SetPrinterTranslateX(*args, **kwargs):
-        """SetPrinterTranslateX(self, long x)"""
-        return _windows_.PrintData_SetPrinterTranslateX(*args, **kwargs)
-
-    def SetPrinterTranslateY(*args, **kwargs):
-        """SetPrinterTranslateY(self, long y)"""
-        return _windows_.PrintData_SetPrinterTranslateY(*args, **kwargs)
-
-    def SetPrinterTranslation(*args, **kwargs):
-        """SetPrinterTranslation(self, long x, long y)"""
-        return _windows_.PrintData_SetPrinterTranslation(*args, **kwargs)
-
 
 class PrintDataPtr(PrintData):
     def __init__(self, this):
@@ -4315,14 +4268,6 @@ class PrintDialogData(_core.Object):
         """GetPrintToFile(self) -> bool"""
         return _windows_.PrintDialogData_GetPrintToFile(*args, **kwargs)
 
-    def GetSetupDialog(*args, **kwargs):
-        """GetSetupDialog(self) -> bool"""
-        return _windows_.PrintDialogData_GetSetupDialog(*args, **kwargs)
-
-    def SetSetupDialog(*args, **kwargs):
-        """SetSetupDialog(self, bool flag)"""
-        return _windows_.PrintDialogData_SetSetupDialog(*args, **kwargs)
-
     def SetFromPage(*args, **kwargs):
         """SetFromPage(self, int v)"""
         return _windows_.PrintDialogData_SetFromPage(*args, **kwargs)