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

Docstring updates

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39009 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2006-05-04 02:04:22 +00:00
parent 57ffa5851d
commit 4ba3af91ab
2 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
wxPython/src/_cmndlgs.i
View File

@ -665,7 +665,13 @@ Window Styles
wx.PD_CAN_ABORT This flag tells the dialog that it should have wx.PD_CAN_ABORT This flag tells the dialog that it should have
a \"Cancel\" button which the user may press. If a \"Cancel\" button which the user may press. If
this happens, the next call to Update() will this happens, the next call to Update() will
return false. return False in the first component of its return
value.
wx.PD_CAN_SKIP This flag tells the dialog that it should have a
\"Skip\" button which the user may press. If this
happens, the next call to Update() will return
True in the second component of its return value.
wx.PD_ELAPSED_TIME This flag tells the dialog that it should show wx.PD_ELAPSED_TIME This flag tells the dialog that it should show
elapsed time (since creating the dialog). elapsed time (since creating the dialog).
@ -703,17 +709,22 @@ parent window only.", "");
// TODO: support getting the skipped value back in the return value, but // TODO: support getting the skipped value back in the return value, but
// only if style is set. This is so the API doesn't change for existing // only if style is set. This is so the API doesn't change for existing
// users... // users...
DocDeclStr( DocDeclAStr(
virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString), virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString,
bool *OUTPUT),
"Update(self, int value, String newmsg) --> (continue, skip)",
"Updates the dialog, setting the progress bar to the new value and, if "Updates the dialog, setting the progress bar to the new value and, if
given changes the message above it. The value given should be less 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 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 dialog is closed if it is equal to the maximum. Returns a tuple of
the Cancel button has been pressed. boolean values, ``(continue, skip)`` where ``continue`` is ``True``
unless the Cancel button has been pressed, and ``skip`` is ``False``
unless the Skip button (if any) has been pressed.
If false is returned, the application can either immediately destroy If the ``continue`` return value is ``false``, the application can either
the dialog or ask the user for the confirmation and if the abort is immediately destroy the dialog or ask the user for confirmation, and if the
not confirmed the dialog may be resumed with Resume function.", ""); abort is not confirmed the dialog may be resumed with `Resume` function.
", "");
DocDeclStr( DocDeclStr(
void , Resume(), void , Resume(),

11
wxPython/src/_sizers.i
View File

@ -23,10 +23,13 @@
DocStr(wxSizerItem, DocStr(wxSizerItem,
"The wx.SizerItem class is used to track the position, size and other "The wx.SizerItem class is used to track the position, size and other
attributes of each item managed by a `wx.Sizer`. In normal usage user attributes of each item managed by a `wx.Sizer`. It is not usually
code should never need to deal directly with a wx.SizerItem, but necessary to use this class because the sizer elements can also be
custom classes derived from `wx.PySizer` will probably need to use the identified by their positions or window or sizer references but
collection of wx.SizerItems held by wx.Sizer when calculating layout. sometimes it may be more convenient to use wx.SizerItem directly.
Also, custom classes derived from `wx.PySizer` will probably need to
use the collection of wx.SizerItems held by wx.Sizer when calculating
layout.
:see: `wx.Sizer`, `wx.GBSizerItem`", ""); :see: `wx.Sizer`, `wx.GBSizerItem`", "");