37f9912de4
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25893 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
843 lines
28 KiB
OpenEdge ABL
843 lines
28 KiB
OpenEdge ABL
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: _cmndlgs.i
|
|
// Purpose: SWIG interface for the "Common Dialog" classes
|
|
//
|
|
// Author: Robin Dunn
|
|
//
|
|
// Created: 25-July-1998
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) 2003 by Total Control Software
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Not a %module
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
%newgroup
|
|
|
|
MAKE_CONST_WXSTRING(FileSelectorPromptStr);
|
|
MAKE_CONST_WXSTRING(DirSelectorPromptStr);
|
|
MAKE_CONST_WXSTRING(DirDialogNameStr);
|
|
MAKE_CONST_WXSTRING(FileSelectorDefaultWildcardStr);
|
|
MAKE_CONST_WXSTRING(GetTextFromUserPromptStr);
|
|
MAKE_CONST_WXSTRING(MessageBoxCaptionStr);
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
DocStr(wxColourData,
|
|
"This class holds a variety of information related to colour dialogs.");
|
|
|
|
class wxColourData : public wxObject {
|
|
public:
|
|
DocCtorStr(
|
|
wxColourData(),
|
|
"Constructor, sets default values.");
|
|
|
|
~wxColourData();
|
|
|
|
|
|
DocDeclStr(
|
|
bool , GetChooseFull(),
|
|
"Under Windows, determines whether the Windows colour dialog will display\n"
|
|
"the full dialog with custom colour selection controls. Has no meaning\n"
|
|
"under other platforms. The default value is true.");
|
|
|
|
DocDeclStr(
|
|
wxColour , GetColour(),
|
|
"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\n"
|
|
"be an integer between 0 and 15. The default custom colours are all white.");
|
|
|
|
DocDeclStr(
|
|
void , SetChooseFull(int flag),
|
|
"Under Windows, tells the Windows colour dialog to display the full dialog\n"
|
|
"with custom colour selection controls. Under other platforms, has no effect.\n"
|
|
"The default value is true.");
|
|
|
|
DocDeclStr(
|
|
void , SetColour(const wxColour& colour),
|
|
"Sets the default colour for the colour dialog. The default colour is black.");
|
|
|
|
DocDeclStr(
|
|
void , SetCustomColour(int i, const wxColour& colour),
|
|
"Sets the i'th custom colour for the colour dialog. i should be an integer\n"
|
|
"between 0 and 15. The default custom colours are all white.");
|
|
|
|
};
|
|
|
|
|
|
DocStr(wxColourDialog,
|
|
"This class represents the colour chooser dialog.");
|
|
|
|
class wxColourDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxColourDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorStr(
|
|
wxColourDialog(wxWindow* parent, wxColourData* data = NULL),
|
|
"Constructor. Pass a parent window, and optionally a ColourData, which\n"
|
|
"will be copied to the colour dialog's internal ColourData instance.");
|
|
|
|
DocDeclStr(
|
|
wxColourData& , GetColourData(),
|
|
"Returns a reference to the ColourData used by the dialog.");
|
|
};
|
|
|
|
|
|
//--------------------------------------------------------------------------------
|
|
|
|
|
|
DocStr(wxDirDialog,
|
|
"This class represents the directory chooser dialog.");
|
|
|
|
RefDoc(wxDirDialog, "
|
|
Styles
|
|
wxDD_NEW_DIR_BUTTON Add \"Create new directory\" button and allow
|
|
directory names to be editable. On Windows the new
|
|
directory button is only available with recent
|
|
versions of the common dialogs.");
|
|
|
|
class wxDirDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxDirDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorStr(
|
|
wxDirDialog(wxWindow* parent,
|
|
const wxString& message = wxPyDirSelectorPromptStr,
|
|
const wxString& defaultPath = wxPyEmptyString,
|
|
long style = 0,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
const wxString& name = wxPyDirDialogNameStr),
|
|
"Constructor. Use ShowModal method to show the dialog.");
|
|
|
|
|
|
DocDeclStr(
|
|
wxString , GetPath(),
|
|
"Returns the default or user-selected path.");
|
|
|
|
DocDeclStr(
|
|
wxString , GetMessage(),
|
|
"Returns the message that will be displayed on the dialog.");
|
|
|
|
DocDeclStr(
|
|
long , GetStyle(),
|
|
"Returns the dialog style.");
|
|
|
|
DocDeclStr(
|
|
void , SetMessage(const wxString& message),
|
|
"Sets the message that will be displayed on the dialog.");
|
|
|
|
DocDeclStr(
|
|
void , SetPath(const wxString& path),
|
|
"Sets the default path.");
|
|
|
|
};
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
DocStr(wxFileDialog,
|
|
"This class represents the file chooser dialog.");
|
|
|
|
RefDoc(wxFileDialog, "
|
|
In Windows, this is the common file selector dialog. In X, this is a file
|
|
selector box with somewhat less functionality. The path and filename are
|
|
distinct elements of a full file pathname. If path is \"\", the current
|
|
directory will be used. If filename is \"\", no default filename will be
|
|
supplied. The wildcard determines what files are 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 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:
|
|
|
|
\"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"
|
|
|
|
Styles
|
|
wx.OPEN This is an open 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.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.CHANGE_DIR Change the current working directory to the directory
|
|
where the file(s) chosen by the user are.
|
|
");
|
|
|
|
|
|
|
|
class wxFileDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxFileDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorStr(
|
|
wxFileDialog(wxWindow* parent,
|
|
const wxString& message = wxPyFileSelectorPromptStr,
|
|
const wxString& defaultDir = wxPyEmptyString,
|
|
const wxString& defaultFile = wxPyEmptyString,
|
|
const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
|
|
long style = 0,
|
|
const wxPoint& pos = wxDefaultPosition),
|
|
"Constructor. Use ShowModal method to show the dialog.");
|
|
|
|
|
|
DocDeclStr(
|
|
void , SetMessage(const wxString& message),
|
|
"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\n"
|
|
"be returned when the dialog is dismissed).");
|
|
|
|
DocDeclStr(
|
|
void , SetDirectory(const wxString& dir),
|
|
"Sets the default directory.");
|
|
|
|
DocDeclStr(
|
|
void , SetFilename(const wxString& name),
|
|
"Sets the default filename.");
|
|
|
|
DocDeclStr(
|
|
void , SetWildcard(const wxString& wildCard),
|
|
"Sets the wildcard, which can contain multiple file types, for example:\n"
|
|
" \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"");
|
|
|
|
DocDeclStr(
|
|
void , SetStyle(long style),
|
|
"Sets the dialog style.");
|
|
|
|
DocDeclStr(
|
|
void , SetFilterIndex(int filterIndex),
|
|
"Sets the default filter index, starting from zero.");
|
|
|
|
|
|
DocDeclStr(
|
|
wxString , GetMessage() const,
|
|
"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.");
|
|
|
|
DocDeclStr(
|
|
wxString , GetDirectory() const,
|
|
"Returns the default directory.");
|
|
|
|
DocDeclStr(
|
|
wxString , GetFilename() const,
|
|
"Returns the default filename.");
|
|
|
|
DocDeclStr(
|
|
wxString , GetWildcard() const,
|
|
"Returns the file dialog wildcard.");
|
|
|
|
DocDeclStr(
|
|
long , GetStyle() const,
|
|
"Returns the dialog style.");
|
|
|
|
DocDeclStr(
|
|
int , GetFilterIndex() const,
|
|
"Returns the index into the list of filters supplied, optionally, in\n"
|
|
"the wildcard parameter. Before the dialog is shown, this is the index\n"
|
|
"which will be used when the dialog is first displayed. After the dialog\n"
|
|
"is shown, this is the index selected by the user.");
|
|
|
|
|
|
DocStr(GetFilenames,
|
|
"Returns a list of filenames chosen in the dialog. This function should\n"
|
|
"only be used with the dialogs which have wx.MULTIPLE style, use\n"
|
|
"GetFilename for the others.");
|
|
|
|
DocStr(GetPaths,
|
|
"Fills the array paths with the full paths of the files chosen. This\n"
|
|
"function should only be used with the dialogs which have wx.MULTIPLE style,\n"
|
|
"use GetPath for the others.");
|
|
|
|
%extend {
|
|
PyObject* GetFilenames() {
|
|
wxArrayString arr;
|
|
self->GetFilenames(arr);
|
|
return wxArrayString2PyList_helper(arr);
|
|
}
|
|
|
|
PyObject* GetPaths() {
|
|
wxArrayString arr;
|
|
self->GetPaths(arr);
|
|
return wxArrayString2PyList_helper(arr);
|
|
}
|
|
}
|
|
|
|
// TODO
|
|
// // Utility functions
|
|
|
|
// // Parses the wildCard, returning the number of filters.
|
|
// // Returns 0 if none or if there's a problem,
|
|
// // The arrays will contain an equal number of items found before the error.
|
|
// // wildCard is in the form:
|
|
// // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
|
|
// static int ParseWildcard(const wxString& wildCard,
|
|
// wxArrayString& descriptions,
|
|
// wxArrayString& filters);
|
|
|
|
// // Append first extension to filePath from a ';' separated extensionList
|
|
// // if filePath = "path/foo.bar" just return it as is
|
|
// // if filePath = "foo[.]" and extensionList = "*.jpg;*.png" return "foo.jpg"
|
|
// // if the extension is "*.j?g" (has wildcards) or "jpg" then return filePath
|
|
// static wxString AppendExtension(const wxString &filePath,
|
|
// const wxString &extensionList);
|
|
|
|
|
|
};
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
enum { wxCHOICEDLG_STYLE };
|
|
|
|
|
|
DocStr(wxMultiChoiceDialog,
|
|
"A simple dialog with a multi selection listbox.");
|
|
|
|
class wxMultiChoiceDialog : public wxDialog
|
|
{
|
|
public:
|
|
%pythonAppend wxMultiChoiceDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorAStr(
|
|
wxMultiChoiceDialog(wxWindow *parent,
|
|
const wxString& message,
|
|
const wxString& caption,
|
|
int choices=0, wxString* choices_array,
|
|
long style = wxCHOICEDLG_STYLE,
|
|
const wxPoint& pos = wxDefaultPosition),
|
|
"__init__(Window parent, String message, String caption,\n"
|
|
" List choices=[], long style=CHOICEDLG_STYLE,\n"
|
|
" Point pos=DefaultPosition) -> MultiChoiceDialog",
|
|
"Constructor. Use ShowModal method to show the dialog.");
|
|
|
|
|
|
DocDeclAStr(
|
|
void, SetSelections(const wxArrayInt& selections),
|
|
"SetSelections(List selections)",
|
|
"Specify the items in the list that shoudl be selected, using a list of integers.");
|
|
|
|
DocAStr(GetSelections,
|
|
"GetSelections() -> [selections]",
|
|
"Returns a list of integers representing the items that are selected.");
|
|
%extend {
|
|
PyObject* GetSelections() {
|
|
return wxArrayInt2PyList_helper(self->GetSelections());
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
DocStr(wxSingleChoiceDialog,
|
|
"A simple dialog with a single selection listbox.");
|
|
|
|
class wxSingleChoiceDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxSingleChoiceDialog "self._setOORInfo(self)"
|
|
|
|
DocAStr(wxSingleChoiceDialog,
|
|
"__init__(Window parent, String message, String caption,\n"
|
|
" List choices=[], long style=CHOICEDLG_STYLE,\n"
|
|
" Point pos=DefaultPosition) -> SingleChoiceDialog",
|
|
"Constructor. Use ShowModal method to show the dialog.");
|
|
|
|
%extend {
|
|
// TODO: ignoring clientData for now... FIX THIS
|
|
// SWIG is messing up the &/*'s for some reason.
|
|
wxSingleChoiceDialog(wxWindow* parent,
|
|
const wxString& message,
|
|
const wxString& caption,
|
|
int choices, wxString* choices_array,
|
|
//char** clientData = NULL,
|
|
long style = wxCHOICEDLG_STYLE,
|
|
const wxPoint& pos = wxDefaultPosition) {
|
|
return new wxSingleChoiceDialog(parent, message, caption,
|
|
choices, choices_array, NULL, style, pos);
|
|
}
|
|
}
|
|
|
|
DocDeclStr(
|
|
int , GetSelection(),
|
|
"Get the index of teh currently selected item.");
|
|
|
|
DocDeclStr(
|
|
wxString , GetStringSelection(),
|
|
"Returns the string value of the currently selected item");
|
|
|
|
DocDeclStr(
|
|
void , SetSelection(int sel),
|
|
"Set the current selected item to sel");
|
|
};
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
DocStr(wxTextEntryDialog,
|
|
"A dialog with text control, [ok] and [cancel] buttons");
|
|
|
|
class wxTextEntryDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxTextEntryDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorStr(
|
|
wxTextEntryDialog(wxWindow* parent,
|
|
const wxString& message,
|
|
const wxString& caption = wxPyGetTextFromUserPromptStr,
|
|
const wxString& defaultValue = wxPyEmptyString,
|
|
long style = wxOK | wxCANCEL | wxCENTRE,
|
|
const wxPoint& pos = wxDefaultPosition),
|
|
"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,\n"
|
|
"or the original value if the user has pressed Cancel.");
|
|
|
|
DocDeclStr(
|
|
void , SetValue(const wxString& value),
|
|
"Sets the default text value.");
|
|
};
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
DocStr(wxFontData,
|
|
"This class holds a variety of information related to font dialogs.");
|
|
|
|
|
|
class wxFontData : public wxObject {
|
|
public:
|
|
wxFontData();
|
|
~wxFontData();
|
|
|
|
DocDeclStr(
|
|
void , EnableEffects(bool enable),
|
|
"Enables or disables 'effects' under MS Windows only. This refers\n"
|
|
"to the controls for manipulating colour, strikeout and underline\n"
|
|
"properties. The default value is true.");
|
|
|
|
DocDeclStr(
|
|
bool , GetAllowSymbols(),
|
|
"Under MS Windows, returns a flag determining whether symbol fonts can be\n"
|
|
"selected. Has no effect on other platforms. The default value is true.");
|
|
|
|
DocDeclStr(
|
|
wxColour , GetColour(),
|
|
"Gets the colour associated with the font dialog. The default value is black.");
|
|
|
|
DocDeclStr(
|
|
wxFont , GetChosenFont(),
|
|
"Gets the font chosen by the user.");
|
|
|
|
DocDeclStr(
|
|
bool , GetEnableEffects(),
|
|
"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\n"
|
|
"previously been set by the application.");
|
|
|
|
DocDeclStr(
|
|
bool , GetShowHelp(),
|
|
"Returns true if the Help button will be shown (Windows only). The default\n"
|
|
"value is false.");
|
|
|
|
DocDeclStr(
|
|
void , SetAllowSymbols(bool allowSymbols),
|
|
"Under MS Windows, determines whether symbol fonts can be selected. Has no\n"
|
|
"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 (for internal use only).");
|
|
|
|
DocDeclStr(
|
|
void , SetColour(const wxColour& colour),
|
|
"Sets the colour that will be used for the font foreground colour. The default\n"
|
|
"colour is black.");
|
|
|
|
DocDeclStr(
|
|
void , SetInitialFont(const wxFont& font),
|
|
"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\n"
|
|
"0, 0 (unrestricted range).");
|
|
|
|
DocDeclStr(
|
|
void , SetShowHelp(bool showHelp),
|
|
"Determines whether the Help button will be displayed in the font dialog\n"
|
|
"(Windows only). The default value is false.");
|
|
};
|
|
|
|
|
|
|
|
|
|
DocStr(wxFontDialog,
|
|
"This class represents the font chooser dialog.");
|
|
|
|
class wxFontDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxFontDialog "self._setOORInfo(self)"
|
|
|
|
DocStr(wxFontDialog,
|
|
"Constructor. Pass a parent window and the FontData object to be\n"
|
|
"used to initialize the dialog controls.");
|
|
wxFontDialog(wxWindow* parent, const wxFontData& data);
|
|
|
|
|
|
DocDeclStr(
|
|
wxFontData& , GetFontData(),
|
|
"Returns a reference to the internal FontData used by the FontDialog.");
|
|
};
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
DocStr(wxMessageDialog,
|
|
"This class provides a dialog that shows a single or multi-line message, with\n"
|
|
"a choice of OK, Yes, No and Cancel buttons.");
|
|
|
|
RefDoc(wxMessageDialog, "
|
|
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).
|
|
");
|
|
|
|
|
|
class wxMessageDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxMessageDialog "self._setOORInfo(self)"
|
|
|
|
wxMessageDialog(wxWindow* parent,
|
|
const wxString& message,
|
|
const wxString& caption = wxPyMessageBoxCaptionStr,
|
|
long style = wxOK | wxCANCEL | wxCENTRE,
|
|
const wxPoint& pos = wxDefaultPosition);
|
|
|
|
};
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
DocStr(wxProgressDialog,
|
|
"A dialog that shows a short message and a progress bar. Optionally, it can\n"
|
|
"display an ABORT button.");
|
|
|
|
RefDoc(wxProgressDialog, "
|
|
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_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_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_REMAINING_TIME: This flag tells the dialog that it should show
|
|
remaining time.
|
|
");
|
|
|
|
|
|
class wxProgressDialog : public wxFrame {
|
|
public:
|
|
%pythonAppend wxProgressDialog "self._setOORInfo(self)"
|
|
|
|
DocCtorStr(
|
|
wxProgressDialog(const wxString& title,
|
|
const wxString& message,
|
|
int maximum = 100,
|
|
wxWindow* parent = NULL,
|
|
int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL ),
|
|
"Constructor. Creates the dialog, displays it and disables user input for other\n"
|
|
"windows, or, if wxPD_APP_MODAL flag is not given, for its parent window only.");
|
|
|
|
DocDeclStr(
|
|
bool , Update(int value, const wxString& newmsg = wxPyEmptyString),
|
|
"Updates the dialog, setting the progress bar to the new value and, if given\n"
|
|
"changes the message above it. Returns true unless the Cancel button has been\n"
|
|
"pressed.\n\n"
|
|
"If false is returned, the application can either immediately destroy the\n"
|
|
"dialog or ask the user for the confirmation and if the abort is not confirmed\n"
|
|
"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.");
|
|
|
|
};
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
enum wxFindReplaceFlags
|
|
{
|
|
// downward search/replace selected (otherwise - upwards)
|
|
wxFR_DOWN = 1,
|
|
|
|
// whole word search/replace selected
|
|
wxFR_WHOLEWORD = 2,
|
|
|
|
// case sensitive search/replace selected (otherwise - case insensitive)
|
|
wxFR_MATCHCASE = 4
|
|
};
|
|
|
|
|
|
enum wxFindReplaceDialogStyles
|
|
{
|
|
// replace dialog (otherwise find dialog)
|
|
wxFR_REPLACEDIALOG = 1,
|
|
|
|
// don't allow changing the search direction
|
|
wxFR_NOUPDOWN = 2,
|
|
|
|
// don't allow case sensitive searching
|
|
wxFR_NOMATCHCASE = 4,
|
|
|
|
// don't allow whole word searching
|
|
wxFR_NOWHOLEWORD = 8
|
|
};
|
|
|
|
|
|
|
|
%constant wxEventType wxEVT_COMMAND_FIND;
|
|
%constant wxEventType wxEVT_COMMAND_FIND_NEXT;
|
|
%constant wxEventType wxEVT_COMMAND_FIND_REPLACE;
|
|
%constant wxEventType wxEVT_COMMAND_FIND_REPLACE_ALL;
|
|
%constant wxEventType wxEVT_COMMAND_FIND_CLOSE;
|
|
|
|
|
|
%pythoncode {
|
|
EVT_FIND = wx.PyEventBinder( wxEVT_COMMAND_FIND, 1 )
|
|
EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_COMMAND_FIND_NEXT, 1 )
|
|
EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE, 1 )
|
|
EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE_ALL, 1 )
|
|
EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_COMMAND_FIND_CLOSE, 1 )
|
|
|
|
%# For backwards compatibility. Should they be removed?
|
|
EVT_COMMAND_FIND = EVT_FIND
|
|
EVT_COMMAND_FIND_NEXT = EVT_FIND_NEXT
|
|
EVT_COMMAND_FIND_REPLACE = EVT_FIND_REPLACE
|
|
EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL
|
|
EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE
|
|
}
|
|
|
|
|
|
DocStr(wxFindDialogEvent,
|
|
"Events for the FindReplaceDialog");
|
|
|
|
class wxFindDialogEvent : public wxCommandEvent
|
|
{
|
|
public:
|
|
wxFindDialogEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
|
|
|
|
DocDeclStr(
|
|
int , GetFlags(),
|
|
"Get the currently selected flags: this is the combination of\n"
|
|
"wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.");
|
|
|
|
DocDeclStr(
|
|
const wxString& , GetFindString(),
|
|
"Return the string to find (never empty).");
|
|
|
|
DocDeclStr(
|
|
const wxString& , GetReplaceString(),
|
|
"Return the string to replace the search string with (only\n"
|
|
"for replace and replace all events).");
|
|
|
|
DocDeclStr(
|
|
wxFindReplaceDialog *, GetDialog(),
|
|
"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),
|
|
"");
|
|
};
|
|
|
|
|
|
|
|
DocStr(wxFindReplaceData,
|
|
"FindReplaceData holds the data for FindReplaceDialog. It is used to initialize
|
|
the dialog with the default values and will keep the last values from the
|
|
dialog when it is closed. It is also updated each time a wxFindDialogEvent is
|
|
generated so instead of using the wxFindDialogEvent 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.
|
|
|
|
Flags
|
|
wxFR_DOWN: downward search/replace selected (otherwise, upwards)
|
|
|
|
wxFR_WHOLEWORD: whole word search/replace selected
|
|
|
|
wxFR_MATCHCASE: case sensitive search/replace selected (otherwise,
|
|
case insensitive)
|
|
");
|
|
|
|
|
|
|
|
|
|
class wxFindReplaceData : public wxObject
|
|
{
|
|
public:
|
|
DocCtorStr(
|
|
wxFindReplaceData(int flags=0),
|
|
"Constuctor initializes the flags to default value (0).");
|
|
|
|
~wxFindReplaceData();
|
|
|
|
|
|
DocDeclStr(
|
|
const wxString& , GetFindString(),
|
|
"Get the string to find.");
|
|
|
|
DocDeclStr(
|
|
const wxString& , GetReplaceString(),
|
|
"Get the replacement string.");
|
|
|
|
DocDeclStr(
|
|
int , GetFlags(),
|
|
"Get the combination of flag values.");
|
|
|
|
DocDeclStr(
|
|
void , SetFlags(int flags),
|
|
"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).");
|
|
|
|
DocDeclStr(
|
|
void , SetReplaceString(const wxString& str),
|
|
"Set the replacement string (used as initial value by the dialog).");
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
DocStr(wxFindReplaceDialog,
|
|
"FindReplaceDialog is a standard modeless dialog which is used to allow the
|
|
user to search for some text (and possibly replace it with 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.");
|
|
|
|
RefDoc(wxFindReplaceDialog, "
|
|
Styles
|
|
wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog)
|
|
|
|
wx.FR_NOUPDOWN: don't allow changing the search direction
|
|
|
|
wx.FR_NOMATCHCASE: don't allow case sensitive searching
|
|
|
|
wx.FR_NOWHOLEWORD: don't allow whole word searching
|
|
");
|
|
|
|
class wxFindReplaceDialog : public wxDialog {
|
|
public:
|
|
%pythonAppend wxFindReplaceDialog "self._setOORInfo(self)"
|
|
%pythonAppend wxFindReplaceDialog() ""
|
|
|
|
DocCtorStr(
|
|
wxFindReplaceDialog(wxWindow *parent,
|
|
wxFindReplaceData *data,
|
|
const wxString &title,
|
|
int style = 0),
|
|
"Create a FindReplaceDialog. The parent and data parameters must be\n"
|
|
"non-None. Use Show to display the dialog.");
|
|
|
|
DocCtorStrName(
|
|
wxFindReplaceDialog(),
|
|
"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.");
|
|
|
|
|
|
DocDeclStr(
|
|
const wxFindReplaceData *, GetData(),
|
|
"Get the FindReplaceData object used by this dialog.");
|
|
|
|
DocDeclStr(
|
|
void , SetData(wxFindReplaceData *data),
|
|
"Set the FindReplaceData object used by this dialog.");
|
|
|
|
};
|
|
|
|
//---------------------------------------------------------------------------
|
|
//---------------------------------------------------------------------------
|