Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docstring fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32132 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2005-02-18 04:46:57 +00:00
parent 24054d48e9
commit 7c1f6b54a5
4 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wxPython/src/_cursor.i
View File

@@ -72,7 +72,7 @@ public:
"Construct a Cursor from a file. Specify the type of file using "Construct a Cursor from a file. Specify the type of file using
wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
file."," file.","
:see: Alternate constructors `wx.StockCursor`,`wx.CursorFromImage`, `wx.CursorFromBits`"); :see: Alternate constructors `wx.StockCursor`,`wx.CursorFromImage`");
wxCursor(const wxString& cursorName, long type, int hotSpotX=0, int hotSpotY=0) { wxCursor(const wxString& cursorName, long type, int hotSpotX=0, int hotSpotY=0) {
%#ifdef __WXGTK__ %#ifdef __WXGTK__
wxImage img(cursorName, type); wxImage img(cursorName, type);
@@ -97,7 +97,7 @@ stock cursors are available on all platforms.", "",
DocCtorStrName( DocCtorStrName(
wxCursor(const wxImage& image), wxCursor(const wxImage& image),
"Constructs a cursor from a `wx.Image`. The mask (if any) will be used "Constructs a cursor from a `wx.Image`. The mask (if any) will be used
as transparent.", for setting the transparent portions of the cursor.",
" "
In MSW the cursor is resized to 32x32. In MSW the cursor is resized to 32x32.

2
wxPython/src/_listctrl.i
View File

@@ -650,7 +650,7 @@ public:
long, HitTest(const wxPoint& point, int& OUTPUT), long, HitTest(const wxPoint& point, int& OUTPUT),
"HitTest(Point point) -> (item, where)", "HitTest(Point point) -> (item, where)",
"Determines which item (if any) is at the specified point, giving "Determines which item (if any) is at the specified point, giving
details in the second return value (see wxLIST_HITTEST_... flags.)", ""); details in the second return value (see wx.LIST_HITTEST flags.)", "");
// Inserts an item, returning the index of the new item if successful, // Inserts an item, returning the index of the new item if successful,
// -1 otherwise. // -1 otherwise.

13
wxPython/src/_splitter.i
View File

@@ -179,13 +179,13 @@ splitter window. The child window is shown if it is currently hidden.", "");
wxWindow *window2, wxWindow *window2,
int sashPosition = 0), int sashPosition = 0),
"Initializes the left and right panes of the splitter window. The "Initializes the left and right panes of the splitter window. The
child windows are shown if they are currently hidden.", child windows are shown if they are currently hidden.","
"
:param window1: The left pane. :param window1: The left pane.
:param window2: The right pane. :param window2: The right pane.
:param sashPosition: The initial position of the sash. If this :param sashPosition: The initial position of the sash. If this
value is positive, it specifies the size of the left value is positive, it specifies the size of the left
pane. If it is negative, it is absolute value gives pane. If it is negative, its absolute value gives
the size of the right pane. Finally, specify 0 the size of the right pane. Finally, specify 0
(default) to choose the default position (half of (default) to choose the default position (half of
the total window width). the total window width).
@@ -205,13 +205,13 @@ application should check that the window is not currently split using
wxWindow *window2, wxWindow *window2,
int sashPosition = 0), int sashPosition = 0),
"Initializes the top and bottom panes of the splitter window. The "Initializes the top and bottom panes of the splitter window. The
child windows are shown if they are currently hidden.", child windows are shown if they are currently hidden.","
"
:param window1: The top pane. :param window1: The top pane.
:param window2: The bottom pane. :param window2: The bottom pane.
:param sashPosition: The initial position of the sash. If this :param sashPosition: The initial position of the sash. If this
value is positive, it specifies the size of the value is positive, it specifies the size of the
upper pane. If it is negative, it is absolute value upper pane. If it is negative, its absolute value
gives the size of the lower pane. Finally, specify 0 gives the size of the lower pane. Finally, specify 0
(default) to choose the default position (half of (default) to choose the default position (half of
the total window height). the total window height).
@@ -319,6 +319,7 @@ Example values:
automaticaly resized. automaticaly resized.
0.5 Both windows grow equally. 0.5 Both windows grow equally.
1.0 Only left/top window grows. 1.0 Only left/top window grows.
======= =======================================
The default value of sash gravity is 0.0. That value is compatible The default value of sash gravity is 0.0. That value is compatible
with the previous (before gravity was introduced) behaviour of the with the previous (before gravity was introduced) behaviour of the

4
wxPython/src/_window.i
View File

@@ -1677,8 +1677,8 @@ toplevel parent of the window.", "");
"Physically scrolls the pixels in the window and move child windows "Physically scrolls the pixels in the window and move child windows
accordingly. Use this function to optimise your scrolling accordingly. Use this function to optimise your scrolling
implementations, to minimise the area that must be redrawn. Note that implementations, to minimise the area that must be redrawn. Note that
it is rarely required to call this function from a user program.", it is rarely required to call this function from a user program.","
"
:param dx: Amount to scroll horizontally. :param dx: Amount to scroll horizontally.
:param dy: Amount to scroll vertically. :param dy: Amount to scroll vertically.