return _windows.TopLevelWindow_IsIconized(*args, **kwargs)
def GetIcon(*args, **kwargs):
- """GetIcon() -> wxIcon"""
+ """GetIcon() -> Icon"""
return _windows.TopLevelWindow_GetIcon(*args, **kwargs)
def SetIcon(*args, **kwargs):
- """SetIcon(wxIcon icon)"""
+ """SetIcon(Icon icon)"""
return _windows.TopLevelWindow_SetIcon(*args, **kwargs)
def SetIcons(*args, **kwargs):
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = TopLevelWindow
_windows.TopLevelWindow_swigregister(TopLevelWindowPtr)
+cvar = _windows.cvar
+FrameNameStr = cvar.FrameNameStr
+DialogNameStr = cvar.DialogNameStr
+StatusLineNameStr = cvar.StatusLineNameStr
+ToolBarNameStr = cvar.ToolBarNameStr
#---------------------------------------------------------------------------
"""
__init__(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> Frame
+ String name=FrameNameStr) -> Frame
"""
newobj = _windows.new_Frame(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> bool
+ String name=FrameNameStr) -> bool
"""
return _windows.Frame_Create(*args, **kwargs)
def CreateStatusBar(*args, **kwargs):
"""
CreateStatusBar(int number=1, long style=ST_SIZEGRIP, int winid=0,
- String name=wxPyStatusLineNameStr) -> StatusBar
+ String name=StatusLineNameStr) -> StatusBar
"""
return _windows.Frame_CreateStatusBar(*args, **kwargs)
return _windows.Frame_GetStatusBarPane(*args, **kwargs)
def CreateToolBar(*args, **kwargs):
- """CreateToolBar(long style=-1, int winid=-1, String name=wxPyToolBarNameStr) -> wxToolBar"""
+ """CreateToolBar(long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar"""
return _windows.Frame_CreateToolBar(*args, **kwargs)
def GetToolBar(*args, **kwargs):
"""
__init__(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE,
- String name=wxPyDialogNameStr) -> Dialog
+ String name=DialogNameStr) -> Dialog
"""
newobj = _windows.new_Dialog(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE,
- String name=wxPyDialogNameStr) -> bool
+ String name=DialogNameStr) -> bool
"""
return _windows.Dialog_Create(*args, **kwargs)
"""CreateButtonSizer(long flags) -> Sizer"""
return _windows.Dialog_CreateButtonSizer(*args, **kwargs)
- def SetModal(*args, **kwargs):
- """SetModal(bool flag)"""
- return _windows.Dialog_SetModal(*args, **kwargs)
-
def IsModal(*args, **kwargs):
"""IsModal() -> bool"""
return _windows.Dialog_IsModal(*args, **kwargs)
"""
__init__(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> MiniFrame
+ String name=FrameNameStr) -> MiniFrame
"""
newobj = _windows.new_MiniFrame(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> bool
+ String name=FrameNameStr) -> bool
"""
return _windows.MiniFrame_Create(*args, **kwargs)
def __repr__(self):
return "<%s.%s; proxy of C++ wxStatusBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(Window parent, int id=-1, long style=ST_SIZEGRIP, String name=wxPyStatusLineNameStr) -> StatusBar"""
+ """__init__(Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> StatusBar"""
newobj = _windows.new_StatusBar(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
self._setOORInfo(self)
def Create(*args, **kwargs):
- """Create(Window parent, int id, long style=ST_SIZEGRIP, String name=wxPyStatusLineNameStr) -> bool"""
+ """Create(Window parent, int id, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool"""
return _windows.StatusBar_Create(*args, **kwargs)
def SetFieldsCount(*args, **kwargs):
return "<%s.%s; proxy of C++ wxSplitterWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(Window parent, int id, Point point=DefaultPosition,
- Size size=DefaultSize, long style=SP_3D, String name=wxPySplitterNameStr) -> SplitterWindow
+ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow
"""
+ if kwargs.has_key('point'): kwargs['pos'] = kwargs['point']
newobj = _windows.new_SplitterWindow(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
def Create(*args, **kwargs):
"""
- Create(Window parent, int id, Point point=DefaultPosition,
- Size size=DefaultSize, long style=SP_3D, String name=wxPySplitterNameStr) -> bool
+ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=SP_3D, String name=SplitterNameStr) -> bool
"""
return _windows.SplitterWindow_Create(*args, **kwargs)
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = SplitterWindow
_windows.SplitterWindow_swigregister(SplitterWindowPtr)
+SplitterNameStr = cvar.SplitterNameStr
def PreSplitterWindow(*args, **kwargs):
"""PreSplitterWindow() -> SplitterWindow"""
"""
__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCLIP_CHILDREN|wxSW_3D,
- String name=wxPySashNameStr) -> SashWindow
+ String name=SashNameStr) -> SashWindow
"""
newobj = _windows.new_SashWindow(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCLIP_CHILDREN|wxSW_3D,
- String name=wxPySashNameStr) -> bool
+ String name=SashNameStr) -> bool
"""
return _windows.SashWindow_Create(*args, **kwargs)
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = SashWindow
_windows.SashWindow_swigregister(SashWindowPtr)
+SashNameStr = cvar.SashNameStr
+SashLayoutNameStr = cvar.SashLayoutNameStr
def PreSashWindow(*args, **kwargs):
"""PreSashWindow() -> SashWindow"""
"""
__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCLIP_CHILDREN|wxSW_3D,
- String name=wxPySashLayoutNameStr) -> SashLayoutWindow
+ String name=SashLayoutNameStr) -> SashLayoutWindow
"""
newobj = _windows.new_SashLayoutWindow(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCLIP_CHILDREN|wxSW_3D,
- String name=wxPySashLayoutNameStr) -> bool
+ String name=SashLayoutNameStr) -> bool
"""
return _windows.SashLayoutWindow_Create(*args, **kwargs)
def __init__(self, *args, **kwargs):
"""
__init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0, String name=wxPyVListBoxNameStr) -> VListBox
+ Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox
"""
newobj = _windows.new_VListBox(*args, **kwargs)
self.this = newobj.this
def Create(*args, **kwargs):
"""
Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0, String name=wxPyVListBoxNameStr) -> bool
+ Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool
"""
return _windows.VListBox_Create(*args, **kwargs)
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = VListBox
_windows.VListBox_swigregister(VListBoxPtr)
+VListBoxNameStr = cvar.VListBoxNameStr
def PreVListBox(*args, **kwargs):
"""PreVListBox() -> VListBox"""
def __init__(self, *args, **kwargs):
"""
__init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0, String name=wxPyVListBoxNameStr) -> HtmlListBox
+ Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox
"""
newobj = _windows.new_HtmlListBox(*args, **kwargs)
self.this = newobj.this
def Create(*args, **kwargs):
"""
Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0, String name=wxPyVListBoxNameStr) -> bool
+ Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool
"""
return _windows.HtmlListBox_Create(*args, **kwargs)
return _windows.TaskBarIcon_IsIconInstalled(*args, **kwargs)
def SetIcon(*args, **kwargs):
- """SetIcon(wxIcon icon, String tooltip=EmptyString) -> bool"""
+ """SetIcon(Icon icon, String tooltip=EmptyString) -> bool"""
return _windows.TaskBarIcon_SetIcon(*args, **kwargs)
def RemoveIcon(*args, **kwargs):
#---------------------------------------------------------------------------
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
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)
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = ColourData
_windows.ColourData_swigregister(ColourDataPtr)
+FileSelectorPromptStr = cvar.FileSelectorPromptStr
+DirSelectorPromptStr = cvar.DirSelectorPromptStr
+DirDialogNameStr = cvar.DirDialogNameStr
+FileSelectorDefaultWildcardStr = cvar.FileSelectorDefaultWildcardStr
+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
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):
_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):
"""
- __init__(Window parent, String message=wxPyDirSelectorPromptStr,
+ __init__(Window parent, String message=DirSelectorPromptStr,
String defaultPath=EmptyString, long style=0,
Point pos=DefaultPosition, Size size=DefaultSize,
- String name=wxPyDirDialogNameStr) -> DirDialog
+ String name=DirDialogNameStr) -> DirDialog
+
+ Constructor. Use ShowModal method to show the dialog.
"""
newobj = _windows.new_DirDialog(*args, **kwargs)
self.this = newobj.this
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):
_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):
"""
- __init__(Window parent, String message=wxPyFileSelectorPromptStr,
+ __init__(Window parent, String message=FileSelectorPromptStr,
String defaultDir=EmptyString, String defaultFile=EmptyString,
- String wildcard=wxPyFileSelectorDefaultWildcardStr,
- long style=0,
- Point pos=DefaultPosition) -> FileDialog
+ 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
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)
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 LCOUNT,
- String choices, 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
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)
_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
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):
_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):
"""
- __init__(Window parent, String message, String caption=wxPyGetTextFromUserPromptStr,
+ __init__(Window parent, String message, String caption=GetTextFromUserPromptStr,
String defaultValue=EmptyString,
- long style=wxOK|wxCANCEL|wxCENTRE,
- Point pos=DefaultPosition) -> TextEntryDialog
+ 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
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):
_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
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)
_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"""
- newobj = _windows.new_FontDialog(*args, **kwargs)
+ def __init__(self, *args):
+ """
+ __init__(Window parent) -> FontDialog
+ __init__(Window parent, FontData data) -> FontDialog
+
+ Constructor. Pass a parent window, and optionally the font data object to be
+ used to initialize the dialog controls.
+ """
+ newobj = _windows.new_FontDialog(*args)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
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):
_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):
"""
- __init__(Window parent, String message, String caption=wxPyMessageBoxCaptionStr,
+ __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
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):
_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
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)
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):
_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
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)
_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
"""
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)
_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
"""
__init__(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
- String name=wxPyFrameNameStr) -> MDIParentFrame
+ String name=FrameNameStr) -> MDIParentFrame
"""
newobj = _windows.new_MDIParentFrame(*args, **kwargs)
self.this = newobj.this
"""
Create(Window parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
- String name=wxPyFrameNameStr) -> bool
+ String name=FrameNameStr) -> bool
"""
return _windows.MDIParentFrame_Create(*args, **kwargs)
"""
__init__(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> MDIChildFrame
+ String name=FrameNameStr) -> MDIChildFrame
"""
newobj = _windows.new_MDIChildFrame(*args, **kwargs)
self.this = newobj.this
"""
Create(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition,
Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=wxPyFrameNameStr) -> bool
+ String name=FrameNameStr) -> bool
"""
return _windows.MDIChildFrame_Create(*args, **kwargs)
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,)
return _windows.PrintData_GetPaperSize(*args, **kwargs)
def GetQuality(*args, **kwargs):
- """GetQuality() -> wxPrintQuality"""
+ """GetQuality() -> int"""
return _windows.PrintData_GetQuality(*args, **kwargs)
def SetNoCopies(*args, **kwargs):
return _windows.PrintData_SetPaperSize(*args, **kwargs)
def SetQuality(*args, **kwargs):
- """SetQuality(wxPrintQuality quality)"""
+ """SetQuality(int quality)"""
return _windows.PrintData_SetQuality(*args, **kwargs)
def GetPrinterCommand(*args, **kwargs):
"""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):
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = PrintData
_windows.PrintData_swigregister(PrintDataPtr)
+PrintoutTitleStr = cvar.PrintoutTitleStr
+PreviewCanvasNameStr = cvar.PreviewCanvasNameStr
class PageSetupDialogData(core.Object):
def __repr__(self):
return _windows.Printer_GetAbort(*args, **kwargs)
def GetLastError(*args, **kwargs):
- """Printer.GetLastError() -> int"""
+ """GetLastError() -> int"""
return _windows.Printer_GetLastError(*args, **kwargs)
GetLastError = staticmethod(GetLastError)
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyPrintout instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(String title=wxPyPrintoutTitleStr) -> Printout"""
+ """__init__(String title=PrintoutTitleStr) -> Printout"""
newobj = _windows.new_Printout(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
"""
__init__(PrintPreview preview, Window parent, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0,
- String name=wxPyPreviewCanvasNameStr) -> PreviewCanvas
+ String name=PreviewCanvasNameStr) -> PreviewCanvas
"""
newobj = _windows.new_PreviewCanvas(*args, **kwargs)
self.this = newobj.this
"""
__init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
Size size=DefaultSize,
- long style=DEFAULT_FRAME_STYLE, String name=wxPyFrameNameStr) -> PreviewFrame
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame
"""
newobj = _windows.new_PreviewFrame(*args, **kwargs)
self.this = newobj.this
"""
__init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
Size size=DefaultSize,
- long style=DEFAULT_FRAME_STYLE, String name=wxPyFrameNameStr) -> PyPreviewFrame
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame
"""
newobj = _windows.new_PyPreviewFrame(*args, **kwargs)
self.this = newobj.this
projects / wxWidgets.git / blobdiff