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

Some docstring additions, reformats and epydoc markup.

Browse Source 
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
2004-05-12 00:17:48 +00:00
parent 0b9c95225e
commit d07d2bc9d0
41 changed files with 1657 additions and 1537 deletions
Download Patch File Download Diff File Expand all files Collapse all files

298
wxPython/src/_cmndlgs.i
View File

@@ -29,13 +29,13 @@ MAKE_CONST_WXSTRING(MessageBoxCaptionStr);
DocStr(wxColourData,
"This class holds a variety of information related to the colour
chooser dialog, used to transfer settings and results to and from the
`wx.ColourDialog`.");
`wx.ColourDialog`.", "");
class wxColourData : public wxObject {
public:
DocCtorStr(
wxColourData(),
"Constructor, sets default values.");
"Constructor, sets default values.", "");
~wxColourData();
@@ -44,33 +44,33 @@ public:
bool , GetChooseFull(),
"Under Windows, determines whether the Windows colour dialog will
display the full dialog with custom colour selection controls. Has no
meaning under other platforms. The default value is true.");
meaning under other platforms. The default value is true.", "");
DocDeclStr(
wxColour , GetColour(),
"Gets the colour (pre)selected by the dialog.");
"Gets the colour (pre)selected by the dialog.", "");
DocDeclStr(
wxColour , GetCustomColour(int i),
"Gets the i'th custom colour associated with the colour dialog. i
should be an integer between 0 and 15. The default custom colours are
all white.");
all white.", "");
DocDeclStr(
void , SetChooseFull(int flag),
"Under Windows, tells the Windows colour dialog to display the full
dialog with custom colour selection controls. Under other platforms,
has no effect. The default value is true.");
has no effect. The default value is true.", "");
DocDeclStr(
void , SetColour(const wxColour& colour),
"Sets the default colour for the colour dialog. The default colour is
black.");
black.", "");
DocDeclStr(
void , SetCustomColour(int i, const wxColour& colour),
"Sets the i'th custom colour for the colour dialog. i should be an
integer between 0 and 15. The default custom colours are all white.");
integer between 0 and 15. The default custom colours are all white.", "");
};
@@ -78,7 +78,7 @@ integer between 0 and 15. The default custom colours are all white.");
DocStr(wxColourDialog,
"This class represents the colour chooser dialog.");
"This class represents the colour chooser dialog.", "");
class wxColourDialog : public wxDialog {
public:
@@ -88,11 +88,11 @@ public:
wxColourDialog(wxWindow* parent, wxColourData* data = NULL),
"Constructor. Pass a parent window, and optionally a `wx.ColourData`,
which will be copied to the colour dialog's internal ColourData
instance.");
instance.", "");
DocDeclStr(
wxColourData& , GetColourData(),
"Returns a reference to the `wx.ColourData` used by the dialog.");
"Returns a reference to the `wx.ColourData` used by the dialog.", "");
};
@@ -101,8 +101,7 @@ instance.");
DocStr(wxDirDialog,
"wx.DirDialog allows the user to select a directory by browising the
file system.
file system.", "
Window Styles
--------------
@@ -118,8 +117,6 @@ class wxDirDialog : public wxDialog {
public:
%pythonAppend wxDirDialog "self._setOORInfo(self)"
RefDoc(wxDirDialog, ""); // turn it off for the ctors
DocCtorStr(
wxDirDialog(wxWindow* parent,
const wxString& message = wxPyDirSelectorPromptStr,
@@ -128,28 +125,28 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
const wxString& name = wxPyDirDialogNameStr),
"Constructor. Use ShowModal method to show the dialog.");
"Constructor. Use ShowModal method to show the dialog.", "");
DocDeclStr(
wxString , GetPath(),
"Returns the default or user-selected path.");
"Returns the default or user-selected path.", "");
DocDeclStr(
wxString , GetMessage(),
"Returns the message that will be displayed on the dialog.");
"Returns the message that will be displayed on the dialog.", "");
DocDeclStr(
long , GetStyle(),
"Returns the dialog style.");
"Returns the dialog style.", "");
DocDeclStr(
void , SetMessage(const wxString& message),
"Sets the message that will be displayed on the dialog.");
"Sets the message that will be displayed on the dialog.", "");
DocDeclStr(
void , SetPath(const wxString& path),
"Sets the default path.");
"Sets the default path.", "");
};
@@ -158,7 +155,7 @@ public:
DocStr(wxFileDialog,
"wx.FileDialog allows the user to select one or more files from the
filesystem.
filesystem.", "
In Windows, this is the common file selector dialog. On X based
platforms a generic alternative is used. The path and filename are
@@ -169,7 +166,7 @@ displayed in the file selector, and file extension supplies a type
extension for the required filename.
Both the X and Windows versions implement a wildcard filter. Typing a
filename containing wildcards (*, ?) in the filename text item, and
filename containing wildcards (\*, ?) in the filename text item, and
clicking on Ok, will result in only those files matching the pattern
being displayed. The wildcard may be a specification for multiple
types of file with a description for each, such as::
@@ -179,24 +176,24 @@ types of file with a description for each, such as::
Window Styles
--------------
================== ==========================================
wx.OPEN This is an open dialog.
=================== ==========================================
wx.OPEN This is an open dialog.
wx.SAVE This is a save dialog.
wx.SAVE This is a save dialog.
wx.HIDE_READONLY For open dialog only: hide the checkbox
allowing to open the file in read-only mode.
wx.HIDE_READONLY For open dialog only: hide the checkbox
allowing to open the file in read-only mode.
wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation
if a file will be overwritten.
wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation
if a file will be overwritten.
wx.MULTIPLE For open dialog only: allows selecting multiple
files.
wx.MULTIPLE For open dialog only: allows selecting multiple
files.
wx.CHANGE_DIR Change the current working directory to the
directory where the file(s) chosen by the user
are.
================== ==========================================
wx.CHANGE_DIR Change the current working directory to the
directory where the file(s) chosen by the user
are.
=================== ==========================================
");
@@ -205,8 +202,6 @@ class wxFileDialog : public wxDialog {
public:
%pythonAppend wxFileDialog "self._setOORInfo(self)"
RefDoc(wxFileDialog, ""); // turn it off for the ctors
DocCtorStr(
wxFileDialog(wxWindow* parent,
const wxString& message = wxPyFileSelectorPromptStr,
@@ -215,25 +210,25 @@ public:
const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
long style = 0,
const wxPoint& pos = wxDefaultPosition),
"Constructor. Use ShowModal method to show the dialog.");
"Constructor. Use ShowModal method to show the dialog.", "");
DocDeclStr(
void , SetMessage(const wxString& message),
"Sets the message that will be displayed on the dialog.");
"Sets the message that will be displayed on the dialog.", "");
DocDeclStr(
void , SetPath(const wxString& path),
"Sets the path (the combined directory and filename that will be
returned when the dialog is dismissed).");
returned when the dialog is dismissed).", "");
DocDeclStr(
void , SetDirectory(const wxString& dir),
"Sets the default directory.");
"Sets the default directory.", "");
DocDeclStr(
void , SetFilename(const wxString& name),
"Sets the default filename.");
"Sets the default filename.", "");
DocDeclStr(
void , SetWildcard(const wxString& wildCard),
@@ -241,58 +236,58 @@ returned when the dialog is dismissed).");
example::
\"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"
");
", "");
DocDeclStr(
void , SetStyle(long style),
"Sets the dialog style.");
"Sets the dialog style.", "");
DocDeclStr(
void , SetFilterIndex(int filterIndex),
"Sets the default filter index, starting from zero.");
"Sets the default filter index, starting from zero.", "");
DocDeclStr(
wxString , GetMessage() const,
"Returns the message that will be displayed on the dialog.");
"Returns the message that will be displayed on the dialog.", "");
DocDeclStr(
wxString , GetPath() const,
"Returns the full path (directory and filename) of the selected file.");
"Returns the full path (directory and filename) of the selected file.", "");
DocDeclStr(
wxString , GetDirectory() const,
"Returns the default directory.");
"Returns the default directory.", "");
DocDeclStr(
wxString , GetFilename() const,
"Returns the default filename.");
"Returns the default filename.", "");
DocDeclStr(
wxString , GetWildcard() const,
"Returns the file dialog wildcard.");
"Returns the file dialog wildcard.", "");
DocDeclStr(
long , GetStyle() const,
"Returns the dialog style.");
"Returns the dialog style.", "");
DocDeclStr(
int , GetFilterIndex() const,
"Returns the index into the list of filters supplied, optionally, in
the wildcard parameter. Before the dialog is shown, this is the index
which will be used when the dialog is first displayed. After the
dialog is shown, this is the index selected by the user.");
dialog is shown, this is the index selected by the user.", "");
DocStr(GetFilenames,
"Returns a list of filenames chosen in the dialog. This function
should only be used with the dialogs which have wx.MULTIPLE style, use
GetFilename for the others.");
GetFilename for the others.", "");
DocStr(GetPaths,
"Fills the array paths with the full paths of the files chosen. This
function should only be used with the dialogs which have wx.MULTIPLE
style, use GetPath for the others.");
style, use GetPath for the others.", "");
%extend {
PyObject* GetFilenames() {
@@ -337,7 +332,7 @@ enum { wxCHOICEDLG_STYLE };
DocStr(wxMultiChoiceDialog,
"A simple dialog with a multi selection listbox.");
"A simple dialog with a multi selection listbox.", "");
class wxMultiChoiceDialog : public wxDialog
{
@@ -354,18 +349,18 @@ public:
"__init__(Window parent, String message, String caption,
List choices=[], long style=CHOICEDLG_STYLE,
Point pos=DefaultPosition) -> MultiChoiceDialog",
"Constructor. Use ShowModal method to show the dialog.");
"Constructor. Use ShowModal method to show the dialog.", "");
DocDeclAStr(
void, SetSelections(const wxArrayInt& selections),
"SetSelections(List selections)",
"Specify the items in the list that should be selected, using a list of
integers.");
integers.", "");
DocAStr(GetSelections,
"GetSelections() -> [selections]",
"Returns a list of integers representing the items that are selected.");
"Returns a list of integers representing the items that are selected.", "");
%extend {
PyObject* GetSelections() {
return wxArrayInt2PyList_helper(self->GetSelections());
@@ -377,7 +372,7 @@ integers.");
//---------------------------------------------------------------------------
DocStr(wxSingleChoiceDialog,
"A simple dialog with a single selection listbox.");
"A simple dialog with a single selection listbox.", "");
class wxSingleChoiceDialog : public wxDialog {
public:
@@ -387,7 +382,7 @@ public:
"__init__(Window parent, String message, String caption,
List choices=[], long style=CHOICEDLG_STYLE,
Point pos=DefaultPosition) -> SingleChoiceDialog",
"Constructor. Use ShowModal method to show the dialog.");
"Constructor. Use ShowModal method to show the dialog.", "");
%extend {
// TODO: ignoring clientData for now... FIX THIS
@@ -406,22 +401,22 @@ public:
DocDeclStr(
int , GetSelection(),
"Get the index of teh currently selected item.");
"Get the index of teh currently selected item.", "");
DocDeclStr(
wxString , GetStringSelection(),
"Returns the string value of the currently selected item");
"Returns the string value of the currently selected item", "");
DocDeclStr(
void , SetSelection(int sel),
"Set the current selected item to sel");
"Set the current selected item to sel", "");
};
//---------------------------------------------------------------------------
DocStr(wxTextEntryDialog,
"A dialog with text control, [ok] and [cancel] buttons");
"A dialog with text control, [ok] and [cancel] buttons", "");
class wxTextEntryDialog : public wxDialog {
public:
@@ -434,16 +429,16 @@ public:
const wxString& defaultValue = wxPyEmptyString,
long style = wxOK | wxCANCEL | wxCENTRE,
const wxPoint& pos = wxDefaultPosition),
"Constructor. Use ShowModal method to show the dialog.");
"Constructor. Use ShowModal method to show the dialog.", "");
DocDeclStr(
wxString , GetValue(),
"Returns the text that the user has entered if the user has pressed OK,
or the original value if the user has pressed Cancel.");
or the original value if the user has pressed Cancel.", "");
DocDeclStr(
void , SetValue(const wxString& value),
"Sets the default text value.");
"Sets the default text value.", "");
};
//---------------------------------------------------------------------------
@@ -451,7 +446,7 @@ or the original value if the user has pressed Cancel.");
DocStr(wxFontData,
"This class holds a variety of information related to font dialogs and
is used to transfer settings to and results from a `wx.FontDialog`.");
is used to transfer settings to and results from a `wx.FontDialog`.", "");
class wxFontData : public wxObject {
@@ -463,65 +458,65 @@ public:
void , EnableEffects(bool enable),
"Enables or disables 'effects' under MS Windows only. This refers to
the controls for manipulating colour, strikeout and underline
properties. The default value is true.");
properties. The default value is true.", "");
DocDeclStr(
bool , GetAllowSymbols(),
"Under MS Windows, returns a flag determining whether symbol fonts can
be selected. Has no effect on other platforms. The default value is
true.");
true.", "");
DocDeclStr(
wxColour , GetColour(),
"Gets the colour associated with the font dialog. The default value is
black.");
black.", "");
DocDeclStr(
wxFont , GetChosenFont(),
"Gets the font chosen by the user.");
"Gets the font chosen by the user.", "");
DocDeclStr(
bool , GetEnableEffects(),
"Determines whether 'effects' are enabled under Windows.");
"Determines whether 'effects' are enabled under Windows.", "");
DocDeclStr(
wxFont , GetInitialFont(),
"Gets the font that will be initially used by the font dialog. This
should have previously been set by the application.");
should have previously been set by the application.", "");
DocDeclStr(
bool , GetShowHelp(),
"Returns true if the Help button will be shown (Windows only). The
default value is false.");
default value is false.", "");
DocDeclStr(
void , SetAllowSymbols(bool allowSymbols),
"Under MS Windows, determines whether symbol fonts can be selected. Has
no effect on other platforms. The default value is true.");
no effect on other platforms. The default value is true.", "");
DocDeclStr(
void , SetChosenFont(const wxFont& font),
"Sets the font that will be returned to the user (normally for internal
use only).");
use only).", "");
DocDeclStr(
void , SetColour(const wxColour& colour),
"Sets the colour that will be used for the font foreground colour. The
default colour is black.");
default colour is black.", "");
DocDeclStr(
void , SetInitialFont(const wxFont& font),
"Sets the font that will be initially used by the font dialog.");
"Sets the font that will be initially used by the font dialog.", "");
DocDeclStr(
void , SetRange(int min, int max),
"Sets the valid range for the font point size (Windows only). The
default is 0, 0 (unrestricted range).");
default is 0, 0 (unrestricted range).", "");
DocDeclStr(
void , SetShowHelp(bool showHelp),
"Determines whether the Help button will be displayed in the font
dialog (Windows only). The default value is false.");
dialog (Windows only). The default value is false.", "");
};
@@ -531,7 +526,7 @@ DocStr(wxFontDialog,
"wx.FontDialog allows the user to select a system font and its attributes.
:see: `wx.FontData`
");
", "");
class wxFontDialog : public wxDialog {
public:
@@ -541,14 +536,14 @@ public:
"Constructor. Pass a parent window and the `wx.FontData` object to be
used to initialize the dialog controls. Call `ShowModal` to display
the dialog. If ShowModal returns ``wx.ID_OK`` then you can fetch the
results with via the `wx.FontData` returned by `GetFontData`.");
results with via the `wx.FontData` returned by `GetFontData`.", "");
wxFontDialog(wxWindow* parent, const wxFontData& data);
DocDeclStr(
wxFontData& , GetFontData(),
"Returns a reference to the internal `wx.FontData` used by the
wx.FontDialog.");
wx.FontDialog.", "");
};
@@ -557,27 +552,26 @@ wx.FontDialog.");
DocStr(wxMessageDialog,
"This class provides a simple dialog that shows a single or multi-line
message, with a choice of OK, Yes, No and/or Cancel buttons.
message, with a choice of OK, Yes, No and/or Cancel buttons.", "
Window Styles
--------------
================= =============================================
wx.OK Show an OK button.
wx.CANCEL Show a Cancel button.
wx.YES_NO Show Yes and No buttons.
wx.YES_DEFAULT Used with wxYES_NO, makes Yes button the
default - which is the default behaviour.
wx.NO_DEFAULT Used with wxYES_NO, makes No button the default.
wx.ICON_EXCLAMATION Shows an exclamation mark icon.
wx.ICON_HAND Shows an error icon.
wx.ICON_ERROR Shows an error icon - the same as wxICON_HAND.
wx.ICON_QUESTION Shows a question mark icon.
wx.ICON_INFORMATION Shows an information (i) icon.
wx.STAY_ON_TOP The message box stays on top of all other
window, even those of the other applications
(Windows only).
================= =============================================
=================== =============================================
wx.OK Show an OK button.
wx.CANCEL Show a Cancel button.
wx.YES_NO Show Yes and No buttons.
wx.YES_DEFAULT Used with wxYES_NO, makes Yes button the
default - which is the default behaviour.
wx.NO_DEFAULT Used with wxYES_NO, makes No button the default.
wx.ICON_EXCLAMATION Shows an exclamation mark icon.
wx.ICON_HAND Shows an error icon.
wx.ICON_ERROR Shows an error icon - the same as wxICON_HAND.
wx.ICON_QUESTION Shows a question mark icon.
wx.ICON_INFORMATION Shows an information (i) icon.
wx.STAY_ON_TOP The message box stays on top of all other
window, even those of the other applications
(Windows only).
=================== =============================================
");
@@ -585,15 +579,13 @@ class wxMessageDialog : public wxDialog {
public:
%pythonAppend wxMessageDialog "self._setOORInfo(self)"
RefDoc(wxMessageDialog, ""); // turn it off for the ctors
DocCtorStr(
wxMessageDialog(wxWindow* parent,
const wxString& message,
const wxString& caption = wxPyMessageBoxCaptionStr,
long style = wxOK | wxCANCEL | wxCENTRE,
const wxPoint& pos = wxDefaultPosition),
"Constructor, use `ShowModal` to display the dialog.");
"Constructor, use `ShowModal` to display the dialog.", "");
};
@@ -602,34 +594,34 @@ public:
DocStr(wxProgressDialog,
"A dialog that shows a short message and a progress bar. Optionally, it
can display an ABORT button.
can display an ABORT button.", "
Window Styles
--------------
================= =============================================
wx.PD_APP_MODAL Make the progress dialog modal. If this flag is
not given, it is only \"locally\" modal -
that is the input to the parent window is
disabled, but not to the other ones.
==================== =============================================
wx.PD_APP_MODAL Make the progress dialog modal. If this flag is
not given, it is only \"locally\" modal -
that is the input to the parent window is
disabled, but not to the other ones.
wx.PD_AUTO_HIDE Causes the progress dialog to disappear from
screen as soon as the maximum value of the
progress meter has been reached.
wx.PD_AUTO_HIDE Causes the progress dialog to disappear from
screen as soon as the maximum value of the
progress meter has been reached.
wx.PD_CAN_ABORT This flag tells the dialog that it should have
a \"Cancel\" button which the user may press. If
this happens, the next call to Update() will
return false.
wx.PD_CAN_ABORT This flag tells the dialog that it should have
a \"Cancel\" button which the user may press. If
this happens, the next call to Update() will
return false.
wx.PD_ELAPSED_TIME This flag tells the dialog that it should show
elapsed time (since creating the dialog).
wx.PD_ELAPSED_TIME This flag tells the dialog that it should show
elapsed time (since creating the dialog).
wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show
estimated time.
wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show
estimated time.
wx.PD_REMAINING_TIME This flag tells the dialog that it should show
remaining time.
================= =============================================
wx.PD_REMAINING_TIME This flag tells the dialog that it should show
remaining time.
==================== =============================================
");
@@ -637,8 +629,6 @@ class wxProgressDialog : public wxFrame {
public:
%pythonAppend wxProgressDialog "self._setOORInfo(self)"
RefDoc(wxProgressDialog, ""); // turn it off for the ctors
DocCtorStr(
wxProgressDialog(const wxString& title,
const wxString& message,
@@ -647,7 +637,7 @@ public:
int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL ),
"Constructor. Creates the dialog, displays it and disables user input
for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
parent window only.");
parent window only.", "");
DocDeclStr(
virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString),
@@ -657,12 +647,12 @@ 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
not confirmed the dialog may be resumed with Resume function.");
not confirmed the dialog may be resumed with Resume function.", "");
DocDeclStr(
void , Resume(),
"Can be used to continue with the dialog, after the user had chosen to
abort.");
abort.", "");
};
@@ -722,7 +712,7 @@ EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE
DocStr(wxFindDialogEvent,
"Events for the FindReplaceDialog");
"Events for the FindReplaceDialog", "");
class wxFindDialogEvent : public wxCommandEvent
{
@@ -732,32 +722,32 @@ public:
DocDeclStr(
int , GetFlags(),
"Get the currently selected flags: this is the combination of
wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.");
wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.", "");
DocDeclStr(
const wxString& , GetFindString(),
"Return the string to find (never empty).");
"Return the string to find (never empty).", "");
DocDeclStr(
const wxString& , GetReplaceString(),
"Return the string to replace the search string with (only for replace
and replace all events).");
and replace all events).", "");
DocDeclStr(
wxFindReplaceDialog *, GetDialog(),
"Return the pointer to the dialog which generated this event.");
"Return the pointer to the dialog which generated this event.", "");
DocDeclStr(
void , SetFlags(int flags),
"");
"", "");
DocDeclStr(
void , SetFindString(const wxString& str),
"");
"", "");
DocDeclStr(
void , SetReplaceString(const wxString& str),
"");
"", "");
};
@@ -770,7 +760,7 @@ time a `wx.FindDialogEvent` is generated so instead of using the
`wx.FindDialogEvent` methods you can also directly query this object.
Note that all SetXXX() methods may only be called before showing the
dialog and calling them has no effect later.
dialog and calling them has no effect later.", "
Flags
-----
@@ -793,34 +783,34 @@ class wxFindReplaceData : public wxObject
public:
DocCtorStr(
wxFindReplaceData(int flags=0),
"Constuctor initializes the flags to default value (0).");
"Constuctor initializes the flags to default value (0).", "");
~wxFindReplaceData();
DocDeclStr(
const wxString& , GetFindString(),
"Get the string to find.");
"Get the string to find.", "");
DocDeclStr(
const wxString& , GetReplaceString(),
"Get the replacement string.");
"Get the replacement string.", "");
DocDeclStr(
int , GetFlags(),
"Get the combination of flag values.");
"Get the combination of flag values.", "");
DocDeclStr(
void , SetFlags(int flags),
"Set the flags to use to initialize the controls of the dialog.");
"Set the flags to use to initialize the controls of the dialog.", "");
DocDeclStr(
void , SetFindString(const wxString& str),
"Set the string to find (used as initial value by the dialog).");
"Set the string to find (used as initial value by the dialog).", "");
DocDeclStr(
void , SetReplaceString(const wxString& str),
"Set the replacement string (used as initial value by the dialog).");
"Set the replacement string (used as initial value by the dialog).", "");
};
@@ -834,7 +824,7 @@ something else). The actual searching is supposed to be done in the
owner window which is the parent of this dialog. Note that it means
that unlike for the other standard dialogs this one must have a parent
window. Also note that there is no way to use this dialog in a modal
way; it is always, by design and implementation, modeless.
way; it is always, by design and implementation, modeless.", "
Window Styles
@@ -856,35 +846,33 @@ public:
%pythonAppend wxFindReplaceDialog "self._setOORInfo(self)"
%pythonAppend wxFindReplaceDialog() ""
RefDoc(wxFindReplaceDialog, ""); // turn it off for the ctors
DocCtorStr(
wxFindReplaceDialog(wxWindow *parent,
wxFindReplaceData *data,
const wxString &title,
int style = 0),
"Create a FindReplaceDialog. The parent and data parameters must be
non-None. Use Show to display the dialog.");
non-None. Use Show to display the dialog.", "");
DocCtorStrName(
wxFindReplaceDialog(),
"Precreate a FindReplaceDialog for 2-phase creation",
"Precreate a FindReplaceDialog for 2-phase creation", "",
PreFindReplaceDialog);
DocDeclStr(
bool , Create(wxWindow *parent, wxFindReplaceData *data,
const wxString &title, int style = 0),
"Create the dialog, for 2-phase create.");
"Create the dialog, for 2-phase create.", "");
DocDeclStr(
const wxFindReplaceData *, GetData(),
"Get the FindReplaceData object used by this dialog.");
"Get the FindReplaceData object used by this dialog.", "");
DocDeclStr(
void , SetData(wxFindReplaceData *data),
"Set the FindReplaceData object used by this dialog.");
"Set the FindReplaceData object used by this dialog.", "");
};