documented return value of Find[Absolute]ValidPath() correctly

[wxWidgets.git] / wxPython / src / mac / _windows.py

diff --git a/wxPython/src/mac/_windows.py b/wxPython/src/mac/_windows.py
index 20110b173d1323c81e7d8a9bdddc05e96841ab16..7ecf54af71d78188034d9ff075ffd258346d8758 100644 (file)
--- a/wxPython/src/mac/_windows.py
+++ b/wxPython/src/mac/_windows.py
@@ -137,7 +137,11 @@ class ScrolledWindow(Panel):
         return _windows_.ScrolledWindow_SetScrollRate(*args, **kwargs)
 
     def GetScrollPixelsPerUnit(*args, **kwargs):
         return _windows_.ScrolledWindow_SetScrollRate(*args, **kwargs)
 
     def GetScrollPixelsPerUnit(*args, **kwargs):

-        """GetScrollPixelsPerUnit() -> (xUnit, yUnit)"""
+        """
+        GetScrollPixelsPerUnit() -> (xUnit, yUnit)
+
+        Get the size of one logical unit in physical units.
+        """

         return _windows_.ScrolledWindow_GetScrollPixelsPerUnit(*args, **kwargs)
 
     def EnableScrolling(*args, **kwargs):
         return _windows_.ScrolledWindow_GetScrollPixelsPerUnit(*args, **kwargs)
 
     def EnableScrolling(*args, **kwargs):


@@ -145,7 +149,11 @@ class ScrolledWindow(Panel):
         return _windows_.ScrolledWindow_EnableScrolling(*args, **kwargs)
 
     def GetViewStart(*args, **kwargs):
         return _windows_.ScrolledWindow_EnableScrolling(*args, **kwargs)
 
     def GetViewStart(*args, **kwargs):

-        """GetViewStart() -> (x,y)"""
+        """
+        GetViewStart() -> (x,y)
+
+        Get the view start
+        """

         return _windows_.ScrolledWindow_GetViewStart(*args, **kwargs)
 
     def SetScale(*args, **kwargs):
         return _windows_.ScrolledWindow_GetViewStart(*args, **kwargs)
 
     def SetScale(*args, **kwargs):


@@ -1736,14 +1744,7 @@ class VScrolledWindow(Panel):
         return _windows_.VScrolledWindow_ScrollToLine(*args, **kwargs)
 
     def ScrollLines(*args, **kwargs):
         return _windows_.VScrolledWindow_ScrollToLine(*args, **kwargs)
 
     def ScrollLines(*args, **kwargs):

-        """
-        ScrollLines(self, int lines) -> bool
-
-        If the platform and window class supports it, scrolls the window by
-        the given number of lines down, if lines is positive, or up if lines
-        is negative.  Returns True if the window was scrolled, False if it was
-        already on top/bottom and nothing was done.
-        """
+        """ScrollLines(self, int lines) -> bool"""

         return _windows_.VScrolledWindow_ScrollLines(*args, **kwargs)
 
     def ScrollPages(*args, **kwargs):
         return _windows_.VScrolledWindow_ScrollLines(*args, **kwargs)
 
     def ScrollPages(*args, **kwargs):


@@ -1766,19 +1767,11 @@ class VScrolledWindow(Panel):
         return _windows_.VScrolledWindow_RefreshLines(*args, **kwargs)
 
     def HitTestXT(*args, **kwargs):
         return _windows_.VScrolledWindow_RefreshLines(*args, **kwargs)
 
     def HitTestXT(*args, **kwargs):

-        """
-        HitTestXT(self, int x, int y) -> int
-
-        Test where the given (in client coords) point lies
-        """
+        """HitTestXT(self, int x, int y) -> int"""

         return _windows_.VScrolledWindow_HitTestXT(*args, **kwargs)
 
     def HitTest(*args, **kwargs):
         return _windows_.VScrolledWindow_HitTestXT(*args, **kwargs)
 
     def HitTest(*args, **kwargs):

-        """
-        HitTest(self, Point pt) -> int
-
-        Test where the given (in client coords) point lies
-        """
+        """HitTest(self, Point pt) -> int"""

         return _windows_.VScrolledWindow_HitTest(*args, **kwargs)
 
     def RefreshAll(*args, **kwargs):
         return _windows_.VScrolledWindow_HitTest(*args, **kwargs)
 
     def RefreshAll(*args, **kwargs):


@@ -1865,11 +1858,11 @@ class VListBox(VScrolledWindow):
         return _windows_.VListBox_GetSelectedCount(*args, **kwargs)
 
     def GetFirstSelected(*args, **kwargs):
         return _windows_.VListBox_GetSelectedCount(*args, **kwargs)
 
     def GetFirstSelected(*args, **kwargs):

-        """GetFirstSelected(self, unsigned long cookie) -> int"""
+        """GetFirstSelected(self) -> PyObject"""

         return _windows_.VListBox_GetFirstSelected(*args, **kwargs)
 
     def GetNextSelected(*args, **kwargs):
         return _windows_.VListBox_GetFirstSelected(*args, **kwargs)
 
     def GetNextSelected(*args, **kwargs):

-        """GetNextSelected(self, unsigned long cookie) -> int"""
+        """GetNextSelected(self, unsigned long cookie) -> PyObject"""

         return _windows_.VListBox_GetNextSelected(*args, **kwargs)
 
     def GetMargins(*args, **kwargs):
         return _windows_.VListBox_GetNextSelected(*args, **kwargs)
 
     def GetMargins(*args, **kwargs):


@@ -2445,7 +2438,12 @@ class MultiChoiceDialog(Dialog):
         self._setOORInfo(self)
 
     def SetSelections(*args, **kwargs):
         self._setOORInfo(self)
 
     def SetSelections(*args, **kwargs):

-        """SetSelections(List selections)"""
+        """
+        SetSelections(List selections)
+
+        Specify the items in the list that should be selected, using a list of
+        integers.
+        """

         return _windows_.MultiChoiceDialog_SetSelections(*args, **kwargs)
 
     def GetSelections(*args, **kwargs):
         return _windows_.MultiChoiceDialog_SetSelections(*args, **kwargs)
 
     def GetSelections(*args, **kwargs):


@@ -2802,8 +2800,10 @@ class ProgressDialog(Frame):
         Update(self, int value, String newmsg=EmptyString) -> bool
 
         Updates the dialog, setting the progress bar to the new value and, if
         Update(self, int value, String newmsg=EmptyString) -> bool
 
         Updates the dialog, setting the progress bar to the new value and, if

-        given changes the message above it. Returns true unless the Cancel
-        button has been pressed.
+        given changes the message above it. The value given should be less
+        than or equal to the maximum value given to the constructor and the
+        dialog is closed if it is equal to the maximum.  Returns true unless
+        the Cancel button has been pressed.

 
         If false is returned, the application can either immediately destroy
         the dialog or ask the user for the confirmation and if the abort is
 
         If false is returned, the application can either immediately destroy
         the dialog or ask the user for the confirmation and if the abort is


@@ -3608,9 +3608,12 @@ PRINT_MODE_STREAM = _windows_.PRINT_MODE_STREAM
 class PrintData(_core.Object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPrintData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
 class PrintData(_core.Object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPrintData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)

-    def __init__(self, *args, **kwargs):
-        """__init__(self) -> PrintData"""
-        newobj = _windows_.new_PrintData(*args, **kwargs)
+    def __init__(self, *args):
+        """
+        __init__(self) -> PrintData
+        __init__(self, PrintData data) -> PrintData
+        """
+        newobj = _windows_.new_PrintData(*args)

         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown


@@ -3806,9 +3809,12 @@ PreviewCanvasNameStr = cvar.PreviewCanvasNameStr
 class PageSetupDialogData(_core.Object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPageSetupDialogData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
 class PageSetupDialogData(_core.Object):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPageSetupDialogData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)

-    def __init__(self, *args, **kwargs):
-        """__init__(self) -> PageSetupDialogData"""
-        newobj = _windows_.new_PageSetupDialogData(*args, **kwargs)
+    def __init__(self, *args):
+        """
+        __init__(self) -> PageSetupDialogData
+        __init__(self, PageSetupDialogData data) -> PageSetupDialogData
+        """
+        newobj = _windows_.new_PageSetupDialogData(*args)

         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown