Some docstring additions, reformats and epydoc markup.
Removed RefDoc macros, instead made all the normal Docstring macros take an extra parameter to be used for the optional details postion of the docstring. The intent is that the docstrings put in the generated .py files checked in to CVS and delivered in releases will be only a paragraph or two, but when used for generating the epydoc reference docs they can optionally contain a lot more details. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
@@ -38,28 +38,32 @@ EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2)
|
||||
//----------------------------------------------------------------------
|
||||
|
||||
DocStr(wxHelpEvent,
|
||||
"A help event is sent when the user has requested
|
||||
context-sensitive help. This can either be caused by the
|
||||
application requesting context-sensitive help mode via
|
||||
wx.ContextHelp, or (on MS Windows) by the system generating a
|
||||
WM_HELP message when the user pressed F1 or clicked on the query
|
||||
button in a dialog caption.
|
||||
"A help event is sent when the user has requested context-sensitive
|
||||
help. This can either be caused by the application requesting
|
||||
context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
|
||||
the system generating a WM_HELP message when the user pressed F1 or
|
||||
clicked on the query button in a dialog caption.
|
||||
|
||||
A help event is sent to the window that the user clicked on, and
|
||||
is propagated up the window hierarchy until the event is
|
||||
processed or there are no more event handlers. The application
|
||||
should call event.GetId to check the identity of the clicked-on
|
||||
window, and then either show some suitable help or call
|
||||
event.Skip if the identifier is unrecognised. Calling Skip is
|
||||
important because it allows wxWindows to generate further events
|
||||
for ancestors of the clicked-on window. Otherwise it would be
|
||||
impossible to show help for container windows, since processing
|
||||
would stop after the first window found.
|
||||
A help event is sent to the window that the user clicked on, and is
|
||||
propagated up the window hierarchy until the event is processed or
|
||||
there are no more event handlers. The application should call
|
||||
event.GetId to check the identity of the clicked-on window, and then
|
||||
either show some suitable help or call event.Skip if the identifier is
|
||||
unrecognised. Calling Skip is important because it allows wxWindows to
|
||||
generate further events for ancestors of the clicked-on
|
||||
window. Otherwise it would be impossible to show help for container
|
||||
windows, since processing would stop after the first window found.",
|
||||
"
|
||||
|
||||
Events
|
||||
Events
|
||||
-------
|
||||
============== =========================================
|
||||
EVT_HELP Sent when the user has requested context-
|
||||
sensitive help.
|
||||
EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
|
||||
============== =========================================
|
||||
|
||||
:see: `wx.ContextHelp`, `wx.ContextHelpButton`
|
||||
");
|
||||
|
||||
|
||||
@@ -70,36 +74,36 @@ public:
|
||||
wxHelpEvent(wxEventType type = wxEVT_NULL,
|
||||
wxWindowID winid = 0,
|
||||
const wxPoint& pt = wxDefaultPosition),
|
||||
"");
|
||||
"", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
const wxPoint , GetPosition() const,
|
||||
"Returns the left-click position of the mouse, in screen\n"
|
||||
"coordinates. This allows the application to position the help\n"
|
||||
"appropriately.");
|
||||
"Returns the left-click position of the mouse, in screen
|
||||
coordinates. This allows the application to position the help
|
||||
appropriately.", "");
|
||||
|
||||
DocDeclStr(
|
||||
void , SetPosition(const wxPoint& pos),
|
||||
"Sets the left-click position of the mouse, in screen coordinates.");
|
||||
"Sets the left-click position of the mouse, in screen coordinates.", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
const wxString& , GetLink() const,
|
||||
"Get an optional link to further help");
|
||||
"Get an optional link to further help", "");
|
||||
|
||||
DocDeclStr(
|
||||
void , SetLink(const wxString& link),
|
||||
"Set an optional link to further help");
|
||||
"Set an optional link to further help", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
const wxString& , GetTarget() const,
|
||||
"Get an optional target to display help in. E.g. a window specification");
|
||||
"Get an optional target to display help in. E.g. a window specification", "");
|
||||
|
||||
DocDeclStr(
|
||||
void , SetTarget(const wxString& target),
|
||||
"Set an optional target to display help in. E.g. a window specification");
|
||||
"Set an optional target to display help in. E.g. a window specification", "");
|
||||
|
||||
};
|
||||
|
||||
@@ -107,52 +111,53 @@ public:
|
||||
|
||||
|
||||
DocStr(wxContextHelp,
|
||||
"This class changes the cursor to a query and puts the application
|
||||
into a 'context-sensitive help mode'. When the user left-clicks
|
||||
on a window within the specified window, a EVT_HELP event is sent
|
||||
to that control, and the application may respond to it by popping
|
||||
up some help.
|
||||
"This class changes the cursor to a query and puts the application into
|
||||
a 'context-sensitive help mode'. When the user left-clicks on a window
|
||||
within the specified window, a ``EVT_HELP`` event is sent to that
|
||||
control, and the application may respond to it by popping up some
|
||||
help.
|
||||
|
||||
There are a couple of ways to invoke this behaviour implicitly:
|
||||
|
||||
* Use the wx.DIALOG_EX_CONTEXTHELP extended style for a
|
||||
dialog (Windows only). This will put a question mark in the
|
||||
titlebar, and Windows will put the application into
|
||||
context-sensitive help mode automatically, with further
|
||||
programming.
|
||||
* Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
|
||||
(Windows only). This will put a question mark in the titlebar,
|
||||
and Windows will put the application into context-sensitive help
|
||||
mode automatically, with further programming.
|
||||
|
||||
* Create a wx.ContextHelpButton, whose predefined behaviour
|
||||
is to create a context help object. Normally you will write
|
||||
your application so that this button is only added to a
|
||||
dialog for non-Windows platforms (use
|
||||
wx.DIALOG_EX_CONTEXTHELP on Windows).
|
||||
");
|
||||
* Create a `wx.ContextHelpButton`, whose predefined behaviour is
|
||||
to create a context help object. Normally you will write your
|
||||
application so that this button is only added to a dialog for
|
||||
non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
|
||||
Windows).
|
||||
|
||||
:see: `wx.ContextHelpButton`
|
||||
", "");
|
||||
|
||||
class wxContextHelp : public wxObject {
|
||||
public:
|
||||
DocCtorStr(
|
||||
wxContextHelp(wxWindow* window = NULL, bool doNow = True),
|
||||
"Constructs a context help object, calling BeginContextHelp if\n"
|
||||
"doNow is true (the default).\n"
|
||||
"\n"
|
||||
"If window is None, the top window is used.");
|
||||
"Constructs a context help object, calling BeginContextHelp if doNow is
|
||||
true (the default).
|
||||
|
||||
If window is None, the top window is used.", "");
|
||||
|
||||
~wxContextHelp();
|
||||
|
||||
DocDeclStr(
|
||||
bool , BeginContextHelp(wxWindow* window = NULL),
|
||||
"Puts the application into context-sensitive help mode. window is\n"
|
||||
"the window which will be used to catch events; if NULL, the top\n"
|
||||
"window will be used.\n"
|
||||
"\n"
|
||||
"Returns true if the application was successfully put into\n"
|
||||
"context-sensitive help mode. This function only returns when the\n"
|
||||
"event loop has finished.");
|
||||
"Puts the application into context-sensitive help mode. window is the
|
||||
window which will be used to catch events; if NULL, the top window
|
||||
will be used.
|
||||
|
||||
Returns true if the application was successfully put into
|
||||
context-sensitive help mode. This function only returns when the event
|
||||
loop has finished.", "");
|
||||
|
||||
DocDeclStr(
|
||||
bool , EndContextHelp(),
|
||||
"Ends context-sensitive help mode. Not normally called by the\n"
|
||||
"application.");
|
||||
"Ends context-sensitive help mode. Not normally called by the
|
||||
application.", "");
|
||||
|
||||
};
|
||||
|
||||
@@ -160,17 +165,18 @@ public:
|
||||
//----------------------------------------------------------------------
|
||||
|
||||
DocStr(wxContextHelpButton,
|
||||
"Instances of this class may be used to add a question mark button
|
||||
that when pressed, puts the application into context-help
|
||||
mode. It does this by creating a wx.ContextHelp object which
|
||||
itself generates a EVT_HELP event when the user clicks on a
|
||||
window.
|
||||
"Instances of this class may be used to add a question mark button that
|
||||
when pressed, puts the application into context-help mode. It does
|
||||
this by creating a wx.ContextHelp object which itself generates a
|
||||
``EVT_HELP`` event when the user clicks on a window.
|
||||
|
||||
On Windows, you may add a question-mark icon to a dialog by use
|
||||
of the wx.DIALOG_EX_CONTEXTHELP extra style, but on other
|
||||
platforms you will have to add a button explicitly, usually next
|
||||
to OK, Cancel or similar buttons.
|
||||
");
|
||||
On Windows, you may add a question-mark icon to a dialog by use of the
|
||||
``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
|
||||
will have to add a button explicitly, usually next to OK, Cancel or
|
||||
similar buttons.
|
||||
|
||||
:see: `wx.ContextHelp`, `wx.ContextHelpButton`
|
||||
", "");
|
||||
|
||||
class wxContextHelpButton : public wxBitmapButton {
|
||||
public:
|
||||
@@ -181,7 +187,7 @@ public:
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxBU_AUTODRAW),
|
||||
"Constructor, creating and showing a context help button.");
|
||||
"Constructor, creating and showing a context help button.", "");
|
||||
};
|
||||
|
||||
|
||||
@@ -193,54 +199,51 @@ implementing context-sensitive help to show the help text for the
|
||||
given window.
|
||||
|
||||
The current help provider must be explicitly set by the
|
||||
application using wx.HelpProvider.Set().");
|
||||
application using wx.HelpProvider.Set().", "");
|
||||
|
||||
class wxHelpProvider
|
||||
{
|
||||
public:
|
||||
DocDeclStr(
|
||||
static wxHelpProvider *, Set(wxHelpProvider *helpProvider),
|
||||
"Sset the current, application-wide help provider. Returns the\n"
|
||||
"previous one. Unlike some other classes, the help provider is\n"
|
||||
"not created on demand. This must be explicitly done by the\n"
|
||||
"application.");
|
||||
"Sset the current, application-wide help provider. Returns the previous
|
||||
one. Unlike some other classes, the help provider is not created on
|
||||
demand. This must be explicitly done by the application.", "");
|
||||
|
||||
DocDeclStr(
|
||||
static wxHelpProvider *, Get(),
|
||||
"Return the current application-wide help provider.");
|
||||
"Return the current application-wide help provider.", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
wxString , GetHelp(const wxWindow *window),
|
||||
"Gets the help string for this window. Its interpretation is\n"
|
||||
"dependent on the help provider except that empty string always\n"
|
||||
"means that no help is associated with the window.");
|
||||
"Gets the help string for this window. Its interpretation is dependent
|
||||
on the help provider except that empty string always means that no
|
||||
help is associated with the window.", "");
|
||||
|
||||
DocDeclStr(
|
||||
bool , ShowHelp(wxWindow *window),
|
||||
"Shows help for the given window. Uses GetHelp internally if\n"
|
||||
"applicable.\n"
|
||||
"\n"
|
||||
"Returns true if it was done, or false if no help was available\n"
|
||||
"for this window.");
|
||||
"Shows help for the given window. Uses GetHelp internally if
|
||||
applicable. Returns True if it was done, or False if no help was
|
||||
available for this window.", "");
|
||||
|
||||
DocDeclStr(
|
||||
void , AddHelp(wxWindow *window, const wxString& text),
|
||||
"Associates the text with the given window.");
|
||||
"Associates the text with the given window.", "");
|
||||
|
||||
DocDeclStrName(
|
||||
void , AddHelp(wxWindowID id, const wxString& text),
|
||||
"This version associates the given text with all windows with this\n"
|
||||
"id. May be used to set the same help string for all Cancel\n"
|
||||
"buttons in the application, for example.",
|
||||
"This version associates the given text with all windows with this
|
||||
id. May be used to set the same help string for all Cancel buttons in
|
||||
the application, for example.", "",
|
||||
AddHelpById);
|
||||
|
||||
DocDeclStr(
|
||||
void , RemoveHelp(wxWindow* window),
|
||||
"Removes the association between the window pointer and the help\n"
|
||||
"text. This is called by the wx.Window destructor. Without this,\n"
|
||||
"the table of help strings will fill up and when window pointers\n"
|
||||
"are reused, the wrong help string will be found.");
|
||||
"Removes the association between the window pointer and the help
|
||||
text. This is called by the wx.Window destructor. Without this, the
|
||||
table of help strings will fill up and when window pointers are
|
||||
reused, the wrong help string will be found.", "");
|
||||
|
||||
|
||||
%extend { void Destroy() { delete self; } }
|
||||
@@ -250,9 +253,9 @@ public:
|
||||
//----------------------------------------------------------------------
|
||||
|
||||
DocStr(wxSimpleHelpProvider,
|
||||
"wx.SimpleHelpProvider is an implementation of wx.HelpProvider
|
||||
which supports only plain text help strings, and shows the string
|
||||
associated with the control (if any) in a tooltip.");
|
||||
"wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
|
||||
supports only plain text help strings, and shows the string associated
|
||||
with the control (if any) in a tooltip.", "");
|
||||
|
||||
class wxSimpleHelpProvider : public wxHelpProvider
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user