X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1f05e33b7dd37d68f9c3b24f8f75161e4e2fd48d..962162620ff8b78f4d25c7f4ccec88ce071dfb2b:/wxPython/src/msw/windows.py diff --git a/wxPython/src/msw/windows.py b/wxPython/src/msw/windows.py index 03f585570f..f8ac5d7c47 100644 --- a/wxPython/src/msw/windows.py +++ b/wxPython/src/msw/windows.py @@ -27,6 +27,8 @@ class Panel(core.Window): Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> bool + + Create the GUI part of the Window for 2-phase creation mode. """ return _windows.Panel_Create(*args, **kwargs) @@ -70,6 +72,8 @@ class ScrolledWindow(Panel): Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, String name=PanelNameStr) -> bool + + Create the GUI part of the Window for 2-phase creation mode. """ return _windows.ScrolledWindow_Create(*args, **kwargs) @@ -238,11 +242,19 @@ class TopLevelWindow(core.Window): return _windows.TopLevelWindow_IsFullScreen(*args, **kwargs) def SetTitle(*args, **kwargs): - """SetTitle(String title)""" + """ + SetTitle(String title) + + Sets the window's title. Applicable only to frames and dialogs. + """ return _windows.TopLevelWindow_SetTitle(*args, **kwargs) def GetTitle(*args, **kwargs): - """GetTitle() -> String""" + """ + GetTitle() -> String + + Gets the window's title. Applicable only to frames and dialogs. + """ return _windows.TopLevelWindow_GetTitle(*args, **kwargs) def SetShape(*args, **kwargs): @@ -288,7 +300,13 @@ class Frame(TopLevelWindow): return _windows.Frame_Create(*args, **kwargs) def GetClientAreaOrigin(*args, **kwargs): - """GetClientAreaOrigin() -> Point""" + """ + GetClientAreaOrigin() -> Point + + Get the origin of the client area of the window relative to the + window's top left corner (the client area may be shifted because of + the borders, scrollbars, other decorations...) + """ return _windows.Frame_GetClientAreaOrigin(*args, **kwargs) def SendSizeEvent(*args, **kwargs): @@ -646,6 +664,7 @@ SP_PERMIT_UNSPLIT = _windows.SP_PERMIT_UNSPLIT SP_LIVE_UPDATE = _windows.SP_LIVE_UPDATE SP_3DSASH = _windows.SP_3DSASH SP_3DBORDER = _windows.SP_3DBORDER +SP_NO_XP_THEME = _windows.SP_NO_XP_THEME SP_BORDER = _windows.SP_BORDER SP_3D = _windows.SP_3D SPLIT_HORIZONTAL = _windows.SPLIT_HORIZONTAL @@ -654,12 +673,20 @@ SPLIT_DRAG_NONE = _windows.SPLIT_DRAG_NONE SPLIT_DRAG_DRAGGING = _windows.SPLIT_DRAG_DRAGGING SPLIT_DRAG_LEFT_DOWN = _windows.SPLIT_DRAG_LEFT_DOWN class SplitterWindow(core.Window): + """ + wx.SplitterWindow manages up to two subwindows or panes, + with an optional vertical or horizontal split which can be + used with the mouse or programmatically. + + """ def __repr__(self): 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 pos=DefaultPosition, Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow + + Constructor. Creates and shows a SplitterWindow. """ if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'] newobj = _windows.new_SplitterWindow(*args, **kwargs) @@ -672,87 +699,254 @@ class SplitterWindow(core.Window): """ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> bool + + Create the GUI part of the SplitterWindow for the 2-phase create. """ return _windows.SplitterWindow_Create(*args, **kwargs) def GetWindow1(*args, **kwargs): - """GetWindow1() -> Window""" + """ + GetWindow1() -> Window + + Gets the only or left/top pane. + """ return _windows.SplitterWindow_GetWindow1(*args, **kwargs) def GetWindow2(*args, **kwargs): - """GetWindow2() -> Window""" + """ + GetWindow2() -> Window + + Gets the right/bottom pane. + """ return _windows.SplitterWindow_GetWindow2(*args, **kwargs) def SetSplitMode(*args, **kwargs): - """SetSplitMode(int mode)""" + """ + SetSplitMode(int mode) + + Sets the split mode. The mode can be wx.SPLIT_VERTICAL or + wx.SPLIT_HORIZONTAL. This only sets the internal variable; + does not update the display. + """ return _windows.SplitterWindow_SetSplitMode(*args, **kwargs) def GetSplitMode(*args, **kwargs): - """GetSplitMode() -> int""" + """ + GetSplitMode() -> int + + Gets the split mode + """ return _windows.SplitterWindow_GetSplitMode(*args, **kwargs) def Initialize(*args, **kwargs): - """Initialize(Window window)""" + """ + Initialize(Window window) + + Initializes the splitter window to have one pane. This + should be called if you wish to initially view only a single + pane in the splitter window. + """ return _windows.SplitterWindow_Initialize(*args, **kwargs) def SplitVertically(*args, **kwargs): - """SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool""" + """ + SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool + + Initializes the left and right panes of the splitter window. + + window1 The left pane. + window2 The right pane. + sashPosition The initial position of the sash. If this + value is positive, it specifies the size + of the left pane. If it is negative, it is + absolute value gives the size of the right + pane. Finally, specify 0 (default) to + choose the default position (half of the + total window width). + + Returns True if successful, False otherwise (the window was + already split). + + SplitVertically should be called if you wish to initially + view two panes. It can also be called at any subsequent + time, but the application should check that the window is + not currently split using IsSplit. + """ return _windows.SplitterWindow_SplitVertically(*args, **kwargs) def SplitHorizontally(*args, **kwargs): - """SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool""" + """ + SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool + + Initializes the top and bottom panes of the splitter window. + + window1 The top pane. + window2 The bottom pane. + sashPosition The initial position of the sash. If this + value is positive, it specifies the size + of the upper pane. If it is negative, it + is absolute value gives the size of the + lower pane. Finally, specify 0 (default) + to choose the default position (half of + the total window height). + + Returns True if successful, False otherwise (the window was + already split). + + SplitHorizontally should be called if you wish to initially + view two panes. It can also be called at any subsequent + time, but the application should check that the window is + not currently split using IsSplit. + """ return _windows.SplitterWindow_SplitHorizontally(*args, **kwargs) def Unsplit(*args, **kwargs): - """Unsplit(Window toRemove=None) -> bool""" + """ + Unsplit(Window toRemove=None) -> bool + + Unsplits the window. Pass the pane to remove, or None to + remove the right or bottom pane. Returns True if + successful, False otherwise (the window was not split). + + This function will not actually delete the pane being + removed; it sends EVT_SPLITTER_UNSPLIT which can be handled + for the desired behaviour. By default, the pane being + removed is only hidden. + """ return _windows.SplitterWindow_Unsplit(*args, **kwargs) def ReplaceWindow(*args, **kwargs): - """ReplaceWindow(Window winOld, Window winNew) -> bool""" + """ + ReplaceWindow(Window winOld, Window winNew) -> bool + + This function replaces one of the windows managed by the + SplitterWindow with another one. It is in general better to + use it instead of calling Unsplit() and then resplitting the + window back because it will provoke much less flicker. It is + valid to call this function whether the splitter has two + windows or only one. + + Both parameters should be non-None and winOld must specify + one of the windows managed by the splitter. If the + parameters are incorrect or the window couldn't be replaced, + False is returned. Otherwise the function will return True, + but please notice that it will not Destroy the replaced + window and you may wish to do it yourself. + """ return _windows.SplitterWindow_ReplaceWindow(*args, **kwargs) + def UpdateSize(*args, **kwargs): + """ + UpdateSize() + + Causes any pending sizing of the sash and child panes to + take place immediately. + + Such resizing normally takes place in idle time, in order to + wait for layout to be completed. However, this can cause + unacceptable flicker as the panes are resized after the + window has been shown. To work around this, you can perform + window layout (for example by sending a size event to the + parent window), and then call this function, before showing + the top-level window. + """ + return _windows.SplitterWindow_UpdateSize(*args, **kwargs) + def IsSplit(*args, **kwargs): - """IsSplit() -> bool""" + """ + IsSplit() -> bool + + Is the window split? + """ return _windows.SplitterWindow_IsSplit(*args, **kwargs) def SetSashSize(*args, **kwargs): - """SetSashSize(int width)""" + """ + SetSashSize(int width) + + Sets the sash size + """ return _windows.SplitterWindow_SetSashSize(*args, **kwargs) def SetBorderSize(*args, **kwargs): - """SetBorderSize(int width)""" + """ + SetBorderSize(int width) + + Sets the border size + """ return _windows.SplitterWindow_SetBorderSize(*args, **kwargs) def GetSashSize(*args, **kwargs): - """GetSashSize() -> int""" + """ + GetSashSize() -> int + + Gets the sash size + """ return _windows.SplitterWindow_GetSashSize(*args, **kwargs) def GetBorderSize(*args, **kwargs): - """GetBorderSize() -> int""" + """ + GetBorderSize() -> int + + Gets the border size + """ return _windows.SplitterWindow_GetBorderSize(*args, **kwargs) def SetSashPosition(*args, **kwargs): - """SetSashPosition(int position, bool redraw=True)""" + """ + SetSashPosition(int position, bool redraw=True) + + Sets the sash position, in pixels. If redraw is Ttrue then + the panes are resized and the sash and border are redrawn. + """ return _windows.SplitterWindow_SetSashPosition(*args, **kwargs) def GetSashPosition(*args, **kwargs): - """GetSashPosition() -> int""" + """ + GetSashPosition() -> int + + Returns the surrent sash position. + """ return _windows.SplitterWindow_GetSashPosition(*args, **kwargs) def SetMinimumPaneSize(*args, **kwargs): - """SetMinimumPaneSize(int min)""" + """ + SetMinimumPaneSize(int min) + + Sets the minimum pane size in pixels. + + The default minimum pane size is zero, which means that + either pane can be reduced to zero by dragging the sash, + thus removing one of the panes. To prevent this behaviour (and + veto out-of-range sash dragging), set a minimum size, + for example 20 pixels. If the wx.SP_PERMIT_UNSPLIT style is + used when a splitter window is created, the window may be + unsplit even if minimum size is non-zero. + """ return _windows.SplitterWindow_SetMinimumPaneSize(*args, **kwargs) def GetMinimumPaneSize(*args, **kwargs): - """GetMinimumPaneSize() -> int""" + """ + GetMinimumPaneSize() -> int + + Gets the minimum pane size in pixels. + """ return _windows.SplitterWindow_GetMinimumPaneSize(*args, **kwargs) def SashHitTest(*args, **kwargs): - """SashHitTest(int x, int y, int tolerance=5) -> bool""" + """ + SashHitTest(int x, int y, int tolerance=5) -> bool + + Tests for x, y over the sash + """ return _windows.SplitterWindow_SashHitTest(*args, **kwargs) def SizeWindows(*args, **kwargs): - """SizeWindows()""" + """ + SizeWindows() + + Resizes subwindows + """ return _windows.SplitterWindow_SizeWindows(*args, **kwargs) def SetNeedUpdating(*args, **kwargs): @@ -773,38 +967,79 @@ _windows.SplitterWindow_swigregister(SplitterWindowPtr) SplitterNameStr = cvar.SplitterNameStr def PreSplitterWindow(*args, **kwargs): - """PreSplitterWindow() -> SplitterWindow""" + """ + PreSplitterWindow() -> SplitterWindow + + Precreate a SplitterWindow for 2-phase creation. + """ val = _windows.new_PreSplitterWindow(*args, **kwargs) val.thisown = 1 return val class SplitterEvent(core.NotifyEvent): + """This class represents the events generated by a splitter control.""" def __repr__(self): return "<%s.%s; proxy of C++ wxSplitterEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent""" + """ + __init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent + + This class represents the events generated by a splitter control. + """ newobj = _windows.new_SplitterEvent(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def SetSashPosition(*args, **kwargs): - """SetSashPosition(int pos)""" + """ + SetSashPosition(int pos) + + This funciton is only meaningful during + EVT_SPLITTER_SASH_POS_CHANGING and + EVT_SPLITTER_SASH_POS_CHANGED events. In the case of + _CHANGED events, sets the the new sash position. In the case + of _CHANGING events, sets the new tracking bar position so + visual feedback during dragging will represent that change + that will actually take place. Set to -1 from the event + handler code to prevent repositioning. + """ return _windows.SplitterEvent_SetSashPosition(*args, **kwargs) def GetSashPosition(*args, **kwargs): - """GetSashPosition() -> int""" + """ + GetSashPosition() -> int + + Returns the new sash position while in + EVT_SPLITTER_SASH_POS_CHANGING and + EVT_SPLITTER_SASH_POS_CHANGED events. + """ return _windows.SplitterEvent_GetSashPosition(*args, **kwargs) def GetWindowBeingRemoved(*args, **kwargs): - """GetWindowBeingRemoved() -> Window""" + """ + GetWindowBeingRemoved() -> Window + + Returns a pointer to the window being removed when a + splitter window is unsplit. + """ return _windows.SplitterEvent_GetWindowBeingRemoved(*args, **kwargs) def GetX(*args, **kwargs): - """GetX() -> int""" + """ + GetX() -> int + + Returns the x coordinate of the double-click point in a + EVT_SPLITTER_DCLICK event. + """ return _windows.SplitterEvent_GetX(*args, **kwargs) def GetY(*args, **kwargs): - """GetY() -> int""" + """ + GetY() -> int + + Returns the y coordinate of the double-click point in a + EVT_SPLITTER_DCLICK event. + """ return _windows.SplitterEvent_GetY(*args, **kwargs) @@ -823,6 +1058,7 @@ EVT_SPLITTER_SASH_POS_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_PO EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, 1 ) EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, 1 ) EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_UNSPLIT, 1 ) +EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED #--------------------------------------------------------------------------- @@ -1340,11 +1576,25 @@ class VScrolledWindow(Panel): return _windows.VScrolledWindow_ScrollToLine(*args, **kwargs) def ScrollLines(*args, **kwargs): - """ScrollLines(int lines) -> bool""" + """ + ScrollLines(int lines) -> bool + + If the platform and window class supports it, scrolls the window by + the given number of lines down, if lines is positive, or up if lines + is negative. Returns True if the window was scrolled, False if it was + already on top/bottom and nothing was done. + """ return _windows.VScrolledWindow_ScrollLines(*args, **kwargs) def ScrollPages(*args, **kwargs): - """ScrollPages(int pages) -> bool""" + """ + ScrollPages(int pages) -> bool + + If the platform and window class supports it, scrolls the window by + the given number of pages down, if pages is positive, or up if pages + is negative. Returns True if the window was scrolled, False if it was + already on top/bottom and nothing was done. + """ return _windows.VScrolledWindow_ScrollPages(*args, **kwargs) def RefreshLine(*args, **kwargs): @@ -1356,11 +1606,19 @@ class VScrolledWindow(Panel): return _windows.VScrolledWindow_RefreshLines(*args, **kwargs) def HitTestXT(*args, **kwargs): - """HitTestXT(int x, int y) -> int""" + """ + HitTestXT(int x, int y) -> int + + Test where the given (in client coords) point lies + """ return _windows.VScrolledWindow_HitTestXT(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt) -> int""" + """ + HitTest(Point pt) -> int + + Test where the given (in client coords) point lies + """ return _windows.VScrolledWindow_HitTest(*args, **kwargs) def RefreshAll(*args, **kwargs): @@ -1589,6 +1847,7 @@ class TaskBarIcon(core.EvtHandler): """IsOk() -> bool""" return _windows.TaskBarIcon_IsOk(*args, **kwargs) + def __nonzero__(self): return self.IsOk() def IsIconInstalled(*args, **kwargs): """IsIconInstalled() -> bool""" return _windows.TaskBarIcon_IsIconInstalled(*args, **kwargs) @@ -2001,13 +2260,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 @@ -2016,11 +2278,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) @@ -2032,13 +2302,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 @@ -2047,20 +2320,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): @@ -2071,6 +2352,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): @@ -2078,6 +2360,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 @@ -2086,16 +2370,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): @@ -2106,10 +2395,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 @@ -2121,55 +2415,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) @@ -2181,10 +2536,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 @@ -2192,12 +2553,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): @@ -2208,6 +2569,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): @@ -2215,6 +2580,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 @@ -2222,10 +2590,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): @@ -2235,12 +2599,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 @@ -2249,11 +2620,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) @@ -2290,28 +2675,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): @@ -2335,10 +2743,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 @@ -2350,27 +2781,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) @@ -2382,12 +2837,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 @@ -2399,15 +2866,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) @@ -2419,7 +2896,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 @@ -3166,9 +3647,12 @@ _windows.PageSetupDialog_swigregister(PageSetupDialogPtr) class PrintDialogData(core.Object): def __repr__(self): return "<%s.%s; proxy of C++ wxPrintDialogData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__() -> PrintDialogData""" - newobj = _windows.new_PrintDialogData(*args, **kwargs) + def __init__(self, *args): + """ + __init__() -> PrintDialogData + __init__(PrintData printData) -> PrintDialogData + """ + newobj = _windows.new_PrintDialogData(*args) self.this = newobj.this self.thisown = 1 del newobj.thisown @@ -3644,9 +4128,12 @@ _windows.PreviewControlBar_swigregister(PreviewControlBarPtr) class PrintPreview(core.Object): def __repr__(self): return "<%s.%s; proxy of C++ wxPrintPreview instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PrintPreview""" - newobj = _windows.new_PrintPreview(*args, **kwargs) + def __init__(self, *args): + """ + __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview + __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview + """ + newobj = _windows.new_PrintPreview(*args) self.this = newobj.this self.thisown = 1 del newobj.thisown @@ -3750,9 +4237,12 @@ _windows.PrintPreview_swigregister(PrintPreviewPtr) class PyPrintPreview(PrintPreview): def __repr__(self): return "<%s.%s; proxy of C++ wxPyPrintPreview instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PyPrintPreview""" - newobj = _windows.new_PyPrintPreview(*args, **kwargs) + def __init__(self, *args): + """ + __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview + __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview + """ + newobj = _windows.new_PyPrintPreview(*args) self.this = newobj.this self.thisown = 1 del newobj.thisown