X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/02a34c4c56065ff2802c1deef9dd02919c565fda..4d2962b127e734c37095f72a578457bea84c89da:/wxPython/src/mac/windows.py?ds=inline diff --git a/wxPython/src/mac/windows.py b/wxPython/src/mac/windows.py index 05133e33bb..ad2feffbe6 100644 --- a/wxPython/src/mac/windows.py +++ b/wxPython/src/mac/windows.py @@ -1600,10 +1600,15 @@ EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK ) #--------------------------------------------------------------------------- class ColourData(core.Object): + """This class holds a variety of information related to colour dialogs.""" def __repr__(self): return "<%s.%s; proxy of C++ wxColourData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__() -> ColourData""" + """ + __init__() -> ColourData + + Constructor, sets default values. + """ newobj = _windows.new_ColourData(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1615,27 +1620,57 @@ class ColourData(core.Object): except: pass def GetChooseFull(*args, **kwargs): - """GetChooseFull() -> bool""" + """ + GetChooseFull() -> bool + + 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. + """ return _windows.ColourData_GetChooseFull(*args, **kwargs) def GetColour(*args, **kwargs): - """GetColour() -> Colour""" + """ + GetColour() -> Colour + + Gets the colour (pre)selected by the dialog. + """ return _windows.ColourData_GetColour(*args, **kwargs) def GetCustomColour(*args, **kwargs): - """GetCustomColour(int i) -> Colour""" + """ + GetCustomColour(int i) -> Colour + + 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. + """ return _windows.ColourData_GetCustomColour(*args, **kwargs) def SetChooseFull(*args, **kwargs): - """SetChooseFull(int flag)""" + """ + 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. + """ return _windows.ColourData_SetChooseFull(*args, **kwargs) def SetColour(*args, **kwargs): - """SetColour(Colour colour)""" + """ + SetColour(Colour colour) + + Sets the default colour for the colour dialog. The default colour is black. + """ return _windows.ColourData_SetColour(*args, **kwargs) def SetCustomColour(*args, **kwargs): - """SetCustomColour(int i, Colour colour)""" + """ + SetCustomColour(int i, Colour 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. + """ return _windows.ColourData_SetCustomColour(*args, **kwargs) @@ -1653,10 +1688,16 @@ GetTextFromUserPromptStr = cvar.GetTextFromUserPromptStr MessageBoxCaptionStr = cvar.MessageBoxCaptionStr class ColourDialog(Dialog): + """This class represents the colour chooser dialog.""" def __repr__(self): return "<%s.%s; proxy of C++ wxColourDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, ColourData data=None) -> ColourDialog""" + """ + __init__(Window parent, ColourData data=None) -> ColourDialog + + Constructor. Pass a parent window, and optionally a ColourData, which + will be copied to the colour dialog's internal ColourData instance. + """ newobj = _windows.new_ColourDialog(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1664,12 +1705,12 @@ class ColourDialog(Dialog): self._setOORInfo(self) def GetColourData(*args, **kwargs): - """GetColourData() -> ColourData""" - return _windows.ColourDialog_GetColourData(*args, **kwargs) + """ + GetColourData() -> ColourData - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.ColourDialog_ShowModal(*args, **kwargs) + Returns a reference to the ColourData used by the dialog. + """ + return _windows.ColourDialog_GetColourData(*args, **kwargs) class ColourDialogPtr(ColourDialog): @@ -1680,6 +1721,7 @@ class ColourDialogPtr(ColourDialog): _windows.ColourDialog_swigregister(ColourDialogPtr) class DirDialog(Dialog): + """This class represents the directory chooser dialog.""" def __repr__(self): return "<%s.%s; proxy of C++ wxDirDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1688,6 +1730,8 @@ class DirDialog(Dialog): String defaultPath=EmptyString, long style=0, Point pos=DefaultPosition, Size size=DefaultSize, String name=DirDialogNameStr) -> DirDialog + + Constructor. Use ShowModal method to show the dialog. """ newobj = _windows.new_DirDialog(*args, **kwargs) self.this = newobj.this @@ -1696,28 +1740,44 @@ class DirDialog(Dialog): self._setOORInfo(self) def GetPath(*args, **kwargs): - """GetPath() -> String""" + """ + GetPath() -> String + + Returns the default or user-selected path. + """ return _windows.DirDialog_GetPath(*args, **kwargs) def GetMessage(*args, **kwargs): - """GetMessage() -> String""" + """ + GetMessage() -> String + + Returns the message that will be displayed on the dialog. + """ return _windows.DirDialog_GetMessage(*args, **kwargs) def GetStyle(*args, **kwargs): - """GetStyle() -> long""" + """ + GetStyle() -> long + + Returns the dialog style. + """ return _windows.DirDialog_GetStyle(*args, **kwargs) def SetMessage(*args, **kwargs): - """SetMessage(String message)""" + """ + SetMessage(String message) + + Sets the message that will be displayed on the dialog. + """ return _windows.DirDialog_SetMessage(*args, **kwargs) def SetPath(*args, **kwargs): - """SetPath(String path)""" - return _windows.DirDialog_SetPath(*args, **kwargs) + """ + SetPath(String path) - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.DirDialog_ShowModal(*args, **kwargs) + Sets the default path. + """ + return _windows.DirDialog_SetPath(*args, **kwargs) class DirDialogPtr(DirDialog): @@ -1728,6 +1788,7 @@ class DirDialogPtr(DirDialog): _windows.DirDialog_swigregister(DirDialogPtr) class FileDialog(Dialog): + """This class represents the file chooser dialog.""" def __repr__(self): return "<%s.%s; proxy of C++ wxFileDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1736,6 +1797,8 @@ class FileDialog(Dialog): String defaultDir=EmptyString, String defaultFile=EmptyString, String wildcard=FileSelectorDefaultWildcardStr, long style=0, Point pos=DefaultPosition) -> FileDialog + + Constructor. Use ShowModal method to show the dialog. """ newobj = _windows.new_FileDialog(*args, **kwargs) self.this = newobj.this @@ -1744,67 +1807,140 @@ class FileDialog(Dialog): self._setOORInfo(self) def SetMessage(*args, **kwargs): - """SetMessage(String message)""" + """ + SetMessage(String message) + + Sets the message that will be displayed on the dialog. + """ return _windows.FileDialog_SetMessage(*args, **kwargs) def SetPath(*args, **kwargs): - """SetPath(String path)""" + """ + SetPath(String path) + + Sets the path (the combined directory and filename that will + be returned when the dialog is dismissed). + """ return _windows.FileDialog_SetPath(*args, **kwargs) def SetDirectory(*args, **kwargs): - """SetDirectory(String dir)""" + """ + SetDirectory(String dir) + + Sets the default directory. + """ return _windows.FileDialog_SetDirectory(*args, **kwargs) def SetFilename(*args, **kwargs): - """SetFilename(String name)""" + """ + SetFilename(String name) + + Sets the default filename. + """ return _windows.FileDialog_SetFilename(*args, **kwargs) def SetWildcard(*args, **kwargs): - """SetWildcard(String wildCard)""" + """ + SetWildcard(String wildCard) + + Sets the wildcard, which can contain multiple file types, for example: + "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" + """ return _windows.FileDialog_SetWildcard(*args, **kwargs) def SetStyle(*args, **kwargs): - """SetStyle(long style)""" + """ + SetStyle(long style) + + Sets the dialog style. + """ return _windows.FileDialog_SetStyle(*args, **kwargs) def SetFilterIndex(*args, **kwargs): - """SetFilterIndex(int filterIndex)""" + """ + SetFilterIndex(int filterIndex) + + Sets the default filter index, starting from zero. + """ return _windows.FileDialog_SetFilterIndex(*args, **kwargs) def GetMessage(*args, **kwargs): - """GetMessage() -> String""" + """ + GetMessage() -> String + + Returns the message that will be displayed on the dialog. + """ return _windows.FileDialog_GetMessage(*args, **kwargs) def GetPath(*args, **kwargs): - """GetPath() -> String""" + """ + GetPath() -> String + + Returns the full path (directory and filename) of the selected file. + """ return _windows.FileDialog_GetPath(*args, **kwargs) def GetDirectory(*args, **kwargs): - """GetDirectory() -> String""" + """ + GetDirectory() -> String + + Returns the default directory. + """ return _windows.FileDialog_GetDirectory(*args, **kwargs) def GetFilename(*args, **kwargs): - """GetFilename() -> String""" + """ + GetFilename() -> String + + Returns the default filename. + """ return _windows.FileDialog_GetFilename(*args, **kwargs) def GetWildcard(*args, **kwargs): - """GetWildcard() -> String""" + """ + GetWildcard() -> String + + Returns the file dialog wildcard. + """ return _windows.FileDialog_GetWildcard(*args, **kwargs) def GetStyle(*args, **kwargs): - """GetStyle() -> long""" + """ + GetStyle() -> long + + Returns the dialog style. + """ return _windows.FileDialog_GetStyle(*args, **kwargs) def GetFilterIndex(*args, **kwargs): - """GetFilterIndex() -> int""" + """ + GetFilterIndex() -> int + + 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. + """ return _windows.FileDialog_GetFilterIndex(*args, **kwargs) def GetFilenames(*args, **kwargs): - """GetFilenames() -> PyObject""" + """ + GetFilenames() -> PyObject + + 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. + """ return _windows.FileDialog_GetFilenames(*args, **kwargs) def GetPaths(*args, **kwargs): - """GetPaths() -> PyObject""" + """ + GetPaths() -> PyObject + + 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. + """ return _windows.FileDialog_GetPaths(*args, **kwargs) @@ -1817,13 +1953,16 @@ _windows.FileDialog_swigregister(FileDialogPtr) CHOICEDLG_STYLE = _windows.CHOICEDLG_STYLE class MultiChoiceDialog(Dialog): + """A simple dialog with a multi selection listbox.""" def __repr__(self): return "<%s.%s; proxy of C++ wxMultiChoiceDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(Window parent, String message, String caption, int choices=0, - String choices_array, long style=CHOICEDLG_STYLE, + __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. """ newobj = _windows.new_MultiChoiceDialog(*args, **kwargs) self.this = newobj.this @@ -1832,11 +1971,19 @@ class MultiChoiceDialog(Dialog): self._setOORInfo(self) def SetSelections(*args, **kwargs): - """SetSelections(wxArrayInt selections)""" + """ + SetSelections(List selections) + + Specify the items in the list that shoudl be selected, using a list of integers. + """ return _windows.MultiChoiceDialog_SetSelections(*args, **kwargs) def GetSelections(*args, **kwargs): - """GetSelections() -> PyObject""" + """ + GetSelections() -> [selections] + + Returns a list of integers representing the items that are selected. + """ return _windows.MultiChoiceDialog_GetSelections(*args, **kwargs) @@ -1848,13 +1995,16 @@ class MultiChoiceDialogPtr(MultiChoiceDialog): _windows.MultiChoiceDialog_swigregister(MultiChoiceDialogPtr) class SingleChoiceDialog(Dialog): + """A simple dialog with a single selection listbox.""" def __repr__(self): return "<%s.%s; proxy of C++ wxSingleChoiceDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(Window parent, String message, String caption, int choices, - String choices_array, long style=CHOICEDLG_STYLE, + __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. """ newobj = _windows.new_SingleChoiceDialog(*args, **kwargs) self.this = newobj.this @@ -1863,20 +2013,28 @@ class SingleChoiceDialog(Dialog): self._setOORInfo(self) def GetSelection(*args, **kwargs): - """GetSelection() -> int""" + """ + GetSelection() -> int + + Get the index of teh currently selected item. + """ return _windows.SingleChoiceDialog_GetSelection(*args, **kwargs) def GetStringSelection(*args, **kwargs): - """GetStringSelection() -> String""" + """ + GetStringSelection() -> String + + Returns the string value of the currently selected item + """ return _windows.SingleChoiceDialog_GetStringSelection(*args, **kwargs) def SetSelection(*args, **kwargs): - """SetSelection(int sel)""" - return _windows.SingleChoiceDialog_SetSelection(*args, **kwargs) + """ + SetSelection(int sel) - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.SingleChoiceDialog_ShowModal(*args, **kwargs) + Set the current selected item to sel + """ + return _windows.SingleChoiceDialog_SetSelection(*args, **kwargs) class SingleChoiceDialogPtr(SingleChoiceDialog): @@ -1887,6 +2045,7 @@ class SingleChoiceDialogPtr(SingleChoiceDialog): _windows.SingleChoiceDialog_swigregister(SingleChoiceDialogPtr) class TextEntryDialog(Dialog): + """A dialog with text control, [ok] and [cancel] buttons""" def __repr__(self): return "<%s.%s; proxy of C++ wxTextEntryDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1894,6 +2053,8 @@ class TextEntryDialog(Dialog): __init__(Window parent, String message, String caption=GetTextFromUserPromptStr, String defaultValue=EmptyString, long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog + + Constructor. Use ShowModal method to show the dialog. """ newobj = _windows.new_TextEntryDialog(*args, **kwargs) self.this = newobj.this @@ -1902,16 +2063,21 @@ class TextEntryDialog(Dialog): self._setOORInfo(self) def GetValue(*args, **kwargs): - """GetValue() -> String""" + """ + GetValue() -> String + + Returns the text that the user has entered if the user has pressed OK, + or the original value if the user has pressed Cancel. + """ return _windows.TextEntryDialog_GetValue(*args, **kwargs) def SetValue(*args, **kwargs): - """SetValue(String value)""" - return _windows.TextEntryDialog_SetValue(*args, **kwargs) + """ + SetValue(String value) - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.TextEntryDialog_ShowModal(*args, **kwargs) + Sets the default text value. + """ + return _windows.TextEntryDialog_SetValue(*args, **kwargs) class TextEntryDialogPtr(TextEntryDialog): @@ -1922,10 +2088,15 @@ class TextEntryDialogPtr(TextEntryDialog): _windows.TextEntryDialog_swigregister(TextEntryDialogPtr) class FontData(core.Object): + """This class holds a variety of information related to font dialogs.""" def __repr__(self): return "<%s.%s; proxy of C++ wxFontData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__() -> FontData""" + """ + __init__() -> FontData + + This class holds a variety of information related to font dialogs. + """ newobj = _windows.new_FontData(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1937,55 +2108,116 @@ class FontData(core.Object): except: pass def EnableEffects(*args, **kwargs): - """EnableEffects(bool enable)""" + """ + 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. + """ return _windows.FontData_EnableEffects(*args, **kwargs) def GetAllowSymbols(*args, **kwargs): - """GetAllowSymbols() -> bool""" + """ + GetAllowSymbols() -> bool + + Under MS Windows, returns a flag determining whether symbol fonts can be + selected. Has no effect on other platforms. The default value is true. + """ return _windows.FontData_GetAllowSymbols(*args, **kwargs) def GetColour(*args, **kwargs): - """GetColour() -> Colour""" + """ + GetColour() -> Colour + + Gets the colour associated with the font dialog. The default value is black. + """ return _windows.FontData_GetColour(*args, **kwargs) def GetChosenFont(*args, **kwargs): - """GetChosenFont() -> Font""" + """ + GetChosenFont() -> Font + + Gets the font chosen by the user. + """ return _windows.FontData_GetChosenFont(*args, **kwargs) def GetEnableEffects(*args, **kwargs): - """GetEnableEffects() -> bool""" + """ + GetEnableEffects() -> bool + + Determines whether 'effects' are enabled under Windows. + """ return _windows.FontData_GetEnableEffects(*args, **kwargs) def GetInitialFont(*args, **kwargs): - """GetInitialFont() -> Font""" + """ + GetInitialFont() -> Font + + Gets the font that will be initially used by the font dialog. This should have + previously been set by the application. + """ return _windows.FontData_GetInitialFont(*args, **kwargs) def GetShowHelp(*args, **kwargs): - """GetShowHelp() -> bool""" + """ + GetShowHelp() -> bool + + Returns true if the Help button will be shown (Windows only). The default + value is false. + """ return _windows.FontData_GetShowHelp(*args, **kwargs) def SetAllowSymbols(*args, **kwargs): - """SetAllowSymbols(bool allowSymbols)""" + """ + SetAllowSymbols(bool allowSymbols) + + Under MS Windows, determines whether symbol fonts can be selected. Has no + effect on other platforms. The default value is true. + """ return _windows.FontData_SetAllowSymbols(*args, **kwargs) def SetChosenFont(*args, **kwargs): - """SetChosenFont(Font font)""" + """ + SetChosenFont(Font font) + + Sets the font that will be returned to the user (for internal use only). + """ return _windows.FontData_SetChosenFont(*args, **kwargs) def SetColour(*args, **kwargs): - """SetColour(Colour colour)""" + """ + SetColour(Colour colour) + + Sets the colour that will be used for the font foreground colour. The default + colour is black. + """ return _windows.FontData_SetColour(*args, **kwargs) def SetInitialFont(*args, **kwargs): - """SetInitialFont(Font font)""" + """ + SetInitialFont(Font font) + + Sets the font that will be initially used by the font dialog. + """ return _windows.FontData_SetInitialFont(*args, **kwargs) def SetRange(*args, **kwargs): - """SetRange(int min, int max)""" + """ + SetRange(int min, int max) + + Sets the valid range for the font point size (Windows only). The default is + 0, 0 (unrestricted range). + """ return _windows.FontData_SetRange(*args, **kwargs) def SetShowHelp(*args, **kwargs): - """SetShowHelp(bool showHelp)""" + """ + SetShowHelp(bool showHelp) + + Determines whether the Help button will be displayed in the font dialog + (Windows only). The default value is false. + """ return _windows.FontData_SetShowHelp(*args, **kwargs) @@ -1997,10 +2229,16 @@ class FontDataPtr(FontData): _windows.FontData_swigregister(FontDataPtr) class FontDialog(Dialog): + """This class represents the font chooser dialog.""" def __repr__(self): return "<%s.%s; proxy of C++ wxFontDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, FontData data) -> FontDialog""" + """ + __init__(Window parent, FontData data) -> FontDialog + + Constructor. Pass a parent window and the FontData object to be + used to initialize the dialog controls. + """ newobj = _windows.new_FontDialog(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2008,12 +2246,12 @@ class FontDialog(Dialog): self._setOORInfo(self) def GetFontData(*args, **kwargs): - """GetFontData() -> FontData""" - return _windows.FontDialog_GetFontData(*args, **kwargs) + """ + GetFontData() -> FontData - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.FontDialog_ShowModal(*args, **kwargs) + Returns a reference to the internal FontData used by the FontDialog. + """ + return _windows.FontDialog_GetFontData(*args, **kwargs) class FontDialogPtr(FontDialog): @@ -2024,6 +2262,10 @@ class FontDialogPtr(FontDialog): _windows.FontDialog_swigregister(FontDialogPtr) class MessageDialog(Dialog): + """ + This class provides a dialog that shows a single or multi-line message, with + a choice of OK, Yes, No and Cancel buttons. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxMessageDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2031,6 +2273,9 @@ class MessageDialog(Dialog): __init__(Window parent, String message, String caption=MessageBoxCaptionStr, long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> MessageDialog + + This class provides a dialog that shows a single or multi-line message, with + a choice of OK, Yes, No and Cancel buttons. """ newobj = _windows.new_MessageDialog(*args, **kwargs) self.this = newobj.this @@ -2038,10 +2283,6 @@ class MessageDialog(Dialog): del newobj.thisown self._setOORInfo(self) - def ShowModal(*args, **kwargs): - """ShowModal() -> int""" - return _windows.MessageDialog_ShowModal(*args, **kwargs) - class MessageDialogPtr(MessageDialog): def __init__(self, this): @@ -2051,12 +2292,19 @@ class MessageDialogPtr(MessageDialog): _windows.MessageDialog_swigregister(MessageDialogPtr) class ProgressDialog(Frame): + """ + A dialog that shows a short message and a progress bar. Optionally, it can + display an ABORT button. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxProgressDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ __init__(String title, String message, int maximum=100, Window parent=None, int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog + + Constructor. Creates the dialog, displays it and disables user input for other + windows, or, if wxPD_APP_MODAL flag is not given, for its parent window only. """ newobj = _windows.new_ProgressDialog(*args, **kwargs) self.this = newobj.this @@ -2065,11 +2313,25 @@ class ProgressDialog(Frame): self._setOORInfo(self) def Update(*args, **kwargs): - """Update(int value, String newmsg=EmptyString) -> bool""" + """ + Update(int value, String newmsg=EmptyString) -> bool + + Updates the dialog, setting the progress bar to the new value and, if given + changes the message above it. Returns true unless the Cancel 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. + """ return _windows.ProgressDialog_Update(*args, **kwargs) def Resume(*args, **kwargs): - """Resume()""" + """ + Resume() + + Can be used to continue with the dialog, after the user had chosen to abort. + """ return _windows.ProgressDialog_Resume(*args, **kwargs) @@ -2106,28 +2368,51 @@ EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE class FindDialogEvent(core.CommandEvent): + """Events for the FindReplaceDialog""" def __repr__(self): return "<%s.%s; proxy of C++ wxFindDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent""" + """ + __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent + + Events for the FindReplaceDialog + """ newobj = _windows.new_FindDialogEvent(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def GetFlags(*args, **kwargs): - """GetFlags() -> int""" + """ + GetFlags() -> int + + Get the currently selected flags: this is the combination of + wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags. + """ return _windows.FindDialogEvent_GetFlags(*args, **kwargs) def GetFindString(*args, **kwargs): - """GetFindString() -> String""" + """ + GetFindString() -> String + + Return the string to find (never empty). + """ return _windows.FindDialogEvent_GetFindString(*args, **kwargs) def GetReplaceString(*args, **kwargs): - """GetReplaceString() -> String""" + """ + GetReplaceString() -> String + + Return the string to replace the search string with (only + for replace and replace all events). + """ return _windows.FindDialogEvent_GetReplaceString(*args, **kwargs) def GetDialog(*args, **kwargs): - """GetDialog() -> FindReplaceDialog""" + """ + GetDialog() -> FindReplaceDialog + + Return the pointer to the dialog which generated this event. + """ return _windows.FindDialogEvent_GetDialog(*args, **kwargs) def SetFlags(*args, **kwargs): @@ -2151,10 +2436,33 @@ class FindDialogEventPtr(FindDialogEvent): _windows.FindDialogEvent_swigregister(FindDialogEventPtr) class FindReplaceData(core.Object): + """ + 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) + + """ def __repr__(self): return "<%s.%s; proxy of C++ wxFindReplaceData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(int flags=0) -> FindReplaceData""" + """ + __init__(int flags=0) -> FindReplaceData + + Constuctor initializes the flags to default value (0). + """ newobj = _windows.new_FindReplaceData(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2166,27 +2474,51 @@ class FindReplaceData(core.Object): except: pass def GetFindString(*args, **kwargs): - """GetFindString() -> String""" + """ + GetFindString() -> String + + Get the string to find. + """ return _windows.FindReplaceData_GetFindString(*args, **kwargs) def GetReplaceString(*args, **kwargs): - """GetReplaceString() -> String""" + """ + GetReplaceString() -> String + + Get the replacement string. + """ return _windows.FindReplaceData_GetReplaceString(*args, **kwargs) def GetFlags(*args, **kwargs): - """GetFlags() -> int""" + """ + GetFlags() -> int + + Get the combination of flag values. + """ return _windows.FindReplaceData_GetFlags(*args, **kwargs) def SetFlags(*args, **kwargs): - """SetFlags(int flags)""" + """ + SetFlags(int flags) + + Set the flags to use to initialize the controls of the dialog. + """ return _windows.FindReplaceData_SetFlags(*args, **kwargs) def SetFindString(*args, **kwargs): - """SetFindString(String str)""" + """ + SetFindString(String str) + + Set the string to find (used as initial value by the dialog). + """ return _windows.FindReplaceData_SetFindString(*args, **kwargs) def SetReplaceString(*args, **kwargs): - """SetReplaceString(String str)""" + """ + SetReplaceString(String str) + + Set the replacement string (used as initial value by the dialog). + """ return _windows.FindReplaceData_SetReplaceString(*args, **kwargs) @@ -2198,12 +2530,24 @@ class FindReplaceDataPtr(FindReplaceData): _windows.FindReplaceData_swigregister(FindReplaceDataPtr) class FindReplaceDialog(Dialog): + """ + 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. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxFindReplaceDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ __init__(Window parent, FindReplaceData data, String title, int style=0) -> FindReplaceDialog + + Create a FindReplaceDialog. The parent and data parameters must be + non-None. Use Show to display the dialog. """ newobj = _windows.new_FindReplaceDialog(*args, **kwargs) self.this = newobj.this @@ -2215,15 +2559,25 @@ class FindReplaceDialog(Dialog): """ Create(Window parent, FindReplaceData data, String title, int style=0) -> bool + + Create the dialog, for 2-phase create. """ return _windows.FindReplaceDialog_Create(*args, **kwargs) def GetData(*args, **kwargs): - """GetData() -> FindReplaceData""" + """ + GetData() -> FindReplaceData + + Get the FindReplaceData object used by this dialog. + """ return _windows.FindReplaceDialog_GetData(*args, **kwargs) def SetData(*args, **kwargs): - """SetData(FindReplaceData data)""" + """ + SetData(FindReplaceData data) + + Set the FindReplaceData object used by this dialog. + """ return _windows.FindReplaceDialog_SetData(*args, **kwargs) @@ -2235,7 +2589,11 @@ class FindReplaceDialogPtr(FindReplaceDialog): _windows.FindReplaceDialog_swigregister(FindReplaceDialogPtr) def PreFindReplaceDialog(*args, **kwargs): - """PreFindReplaceDialog() -> FindReplaceDialog""" + """ + PreFindReplaceDialog() -> FindReplaceDialog + + Precreate a FindReplaceDialog for 2-phase creation + """ val = _windows.new_PreFindReplaceDialog(*args, **kwargs) val.thisown = 1 return val @@ -2601,6 +2959,7 @@ PRINT_MODE_NONE = _windows.PRINT_MODE_NONE PRINT_MODE_PREVIEW = _windows.PRINT_MODE_PREVIEW PRINT_MODE_FILE = _windows.PRINT_MODE_FILE PRINT_MODE_PRINTER = _windows.PRINT_MODE_PRINTER +PRINT_MODE_STREAM = _windows.PRINT_MODE_STREAM class PrintData(core.Object): def __repr__(self): return "<%s.%s; proxy of C++ wxPrintData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -2780,6 +3139,14 @@ class PrintData(core.Object): """SetPrintMode(int printMode)""" return _windows.PrintData_SetPrintMode(*args, **kwargs) + def GetOutputStream(*args, **kwargs): + """GetOutputStream() -> OutputStream""" + return _windows.PrintData_GetOutputStream(*args, **kwargs) + + def SetOutputStream(*args, **kwargs): + """SetOutputStream(OutputStream outputstream)""" + return _windows.PrintData_SetOutputStream(*args, **kwargs) + def __nonzero__(self): return self.Ok() class PrintDataPtr(PrintData):