import _core
wx = _core
-__docfilter__ = wx.__docfilter__
#---------------------------------------------------------------------------
class Panel(_core.Window):
"""
InitDialog(self)
- Sends an EVT_INIT_DIALOG event, whose handler usually transfers
- data to the dialog via validators.
+ Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
+ to the dialog via validators.
"""
return _windows_.Panel_InitDialog(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Panel_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class PanelPtr(Panel):
def __init__(self, this):
val.thisown = 1
return val
+def Panel_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Panel_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Panel_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class ScrolledWindow(Panel):
return _windows_.ScrolledWindow_SetScrollRate(*args, **kwargs)
def GetScrollPixelsPerUnit(*args, **kwargs):
- """
- GetScrollPixelsPerUnit() -> (xUnit, yUnit)
-
- Get the size of one logical unit in physical units.
- """
+ """GetScrollPixelsPerUnit() -> (xUnit, yUnit)"""
return _windows_.ScrolledWindow_GetScrollPixelsPerUnit(*args, **kwargs)
def EnableScrolling(*args, **kwargs):
return _windows_.ScrolledWindow_EnableScrolling(*args, **kwargs)
def GetViewStart(*args, **kwargs):
- """
- GetViewStart() -> (x,y)
-
- Get the view start
- """
+ """GetViewStart() -> (x,y)"""
return _windows_.ScrolledWindow_GetViewStart(*args, **kwargs)
def SetScale(*args, **kwargs):
"""GetTargetRect(self) -> Rect"""
return _windows_.ScrolledWindow_GetTargetRect(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.ScrolledWindow_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ScrolledWindowPtr(ScrolledWindow):
def __init__(self, this):
val.thisown = 1
return val
+def ScrolledWindow_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ ScrolledWindow_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.ScrolledWindow_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
STAY_ON_TOP = _windows_.STAY_ON_TOP
"""DoMenuUpdates(self, Menu menu=None)"""
return _windows_.Frame_DoMenuUpdates(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Frame_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class FramePtr(Frame):
def __init__(self, this):
val.thisown = 1
return val
+def Frame_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Frame_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Frame_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class Dialog(TopLevelWindow):
"""EndModal(self, int retCode)"""
return _windows_.Dialog_EndModal(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Dialog_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class DialogPtr(Dialog):
def __init__(self, this):
val.thisown = 1
return val
+def Dialog_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Dialog_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.Dialog_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class MiniFrame(Frame):
"""GetBorderY(self) -> int"""
return _windows_.StatusBar_GetBorderY(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.StatusBar_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class StatusBarPtr(StatusBar):
def __init__(self, this):
val.thisown = 1
return val
+def StatusBar_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ StatusBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.StatusBar_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
SP_NOBORDER = _windows_.SP_NOBORDER
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.
-
+ 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,)
SetSplitMode(self, 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.
+ wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not
+ update the display.
"""
return _windows_.SplitterWindow_SetSplitMode(*args, **kwargs)
"""
Initialize(self, 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.
+ 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)
SplitVertically(self, 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)
SplitHorizontally(self, 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)
"""
Unsplit(self, 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).
+ 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
ReplaceWindow(self, 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.
+ 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)
"""
UpdateSize(self)
- Causes any pending sizing of the sash and child panes to
- take place immediately.
+ 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.
+ 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)
"""
SetSashPosition(self, 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.
+ 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)
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.
+ 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)
"""GetNeedUpdating(self) -> bool"""
return _windows_.SplitterWindow_GetNeedUpdating(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.SplitterWindow_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class SplitterWindowPtr(SplitterWindow):
def __init__(self, this):
val.thisown = 1
return val
+def SplitterWindow_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ SplitterWindow_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
+ return _windows_.SplitterWindow_GetClassDefaultAttributes(*args, **kwargs)
+
class SplitterEvent(_core.NotifyEvent):
"""This class represents the events generated by a splitter control."""
def __repr__(self):
"""
SetSashPosition(self, 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.
+ 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)
"""
GetSashPosition(self) -> int
- Returns the new sash position while in
- EVT_SPLITTER_SASH_POS_CHANGING and
- EVT_SPLITTER_SASH_POS_CHANGED events.
+ 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)
"""
GetWindowBeingRemoved(self) -> Window
- Returns a pointer to the window being removed when a
- splitter window is unsplit.
+ Returns a pointer to the window being removed when a splitter window
+ is unsplit.
"""
return _windows_.SplitterEvent_GetWindowBeingRemoved(*args, **kwargs)
"""
ScrollPages(self, int pages) -> bool
- If the platform and window class supports it, scrolls the window by
+ 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.
"""SetItemCount(self, size_t count)"""
return _windows_.HtmlListBox_SetItemCount(*args, **kwargs)
+ def GetFileSystem(*args, **kwargs):
+ """GetFileSystem(self) -> FileSystem"""
+ return _windows_.HtmlListBox_GetFileSystem(*args, **kwargs)
+
class HtmlListBoxPtr(HtmlListBox):
def __init__(self, this):
#---------------------------------------------------------------------------
class ColourData(_core.Object):
- """This class holds a variety of information related to colour dialogs."""
+ """
+ This class holds a variety of information related to the colour
+ chooser dialog, used to transfer settings and results to and from the
+ `wx.ColourDialog`.
+ """
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):
"""
GetChooseFull(self) -> 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.
+ 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)
"""
GetCustomColour(self, 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.
+ 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)
"""
SetChooseFull(self, 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.
+ 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)
"""
SetColour(self, Colour colour)
- Sets the default colour for the colour dialog. The default colour is black.
+ Sets the default colour for the colour dialog. The default colour is
+ black.
"""
return _windows_.ColourData_SetColour(*args, **kwargs)
"""
SetCustomColour(self, 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.
+ 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)
"""
__init__(self, 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.
+ Constructor. Pass a parent window, and optionally a `wx.ColourData`,
+ which will be copied to the colour dialog's internal ColourData
+ instance.
"""
newobj = _windows_.new_ColourDialog(*args, **kwargs)
self.this = newobj.this
"""
GetColourData(self) -> ColourData
- Returns a reference to the ColourData used by the dialog.
+ Returns a reference to the `wx.ColourData` used by the dialog.
"""
return _windows_.ColourDialog_GetColourData(*args, **kwargs)
_windows_.ColourDialog_swigregister(ColourDialogPtr)
class DirDialog(Dialog):
- """This class represents the directory chooser dialog."""
+ """
+ wx.DirDialog allows the user to select a directory by browising the
+ file system.
+ """
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):
_windows_.DirDialog_swigregister(DirDialogPtr)
class FileDialog(Dialog):
- """This class represents the file chooser dialog."""
+ """
+ wx.FileDialog allows the user to select one or more files from the
+ filesystem.
+ """
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):
"""
SetPath(self, String path)
- Sets the path (the combined directory and filename that will
- be returned when the dialog is dismissed).
+ Sets the path (the combined directory and filename that will be
+ returned when the dialog is dismissed).
"""
return _windows_.FileDialog_SetPath(*args, **kwargs)
"""
SetWildcard(self, String wildCard)
- Sets the wildcard, which can contain multiple file types, for example:
+ 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)
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.
+ 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)
"""
GetFilenames(self) -> 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
+ 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)
GetPaths(self) -> 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.
+ function should only be used with the dialogs which have wx.MULTIPLE
+ style, use GetPath for the others.
"""
return _windows_.FileDialog_GetPaths(*args, **kwargs)
self._setOORInfo(self)
def SetSelections(*args, **kwargs):
- """
- SetSelections(List selections)
-
- Specify the items in the list that shoudl be selected, using a list of integers.
- """
+ """SetSelections(List selections)"""
return _windows_.MultiChoiceDialog_SetSelections(*args, **kwargs)
def GetSelections(*args, **kwargs):
_windows_.TextEntryDialog_swigregister(TextEntryDialogPtr)
class FontData(_core.Object):
- """This class holds a variety of information related to font dialogs."""
+ """
+ This class holds a variety of information related to font dialogs and
+ is used to transfer settings to and results from a `wx.FontDialog`.
+ """
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__(self) -> FontData
- This class holds a variety of information related to font dialogs.
+ This class holds a variety of information related to font dialogs and
+ is used to transfer settings to and results from a `wx.FontDialog`.
"""
newobj = _windows_.new_FontData(*args, **kwargs)
self.this = newobj.this
"""
EnableEffects(self, bool enable)
- Enables or disables 'effects' under MS Windows only. This refers
- to the controls for manipulating colour, strikeout and underline
+ 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)
"""
GetAllowSymbols(self) -> 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.
+ 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)
"""
GetColour(self) -> Colour
- Gets the colour associated with the font dialog. The default value is black.
+ Gets the colour associated with the font dialog. The default value is
+ black.
"""
return _windows_.FontData_GetColour(*args, **kwargs)
"""
GetInitialFont(self) -> Font
- Gets the font that will be initially used by the font dialog. This should have
- previously been set by the application.
+ 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)
"""
GetShowHelp(self) -> bool
- Returns true if the Help button will be shown (Windows only). The default
- value is false.
+ Returns true if the Help button will be shown (Windows only). The
+ default value is false.
"""
return _windows_.FontData_GetShowHelp(*args, **kwargs)
"""
SetAllowSymbols(self, bool allowSymbols)
- Under MS Windows, determines whether symbol fonts can be selected. Has no
- effect on other platforms. The default value is true.
+ 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)
"""
SetChosenFont(self, Font font)
- Sets the font that will be returned to the user (for internal use only).
+ Sets the font that will be returned to the user (normally for internal
+ use only).
"""
return _windows_.FontData_SetChosenFont(*args, **kwargs)
"""
SetColour(self, Colour colour)
- Sets the colour that will be used for the font foreground colour. The default
- colour is black.
+ Sets the colour that will be used for the font foreground colour. The
+ default colour is black.
"""
return _windows_.FontData_SetColour(*args, **kwargs)
"""
SetRange(self, int min, int max)
- Sets the valid range for the font point size (Windows only). The default is
- 0, 0 (unrestricted range).
+ Sets the valid range for the font point size (Windows only). The
+ default is 0, 0 (unrestricted range).
"""
return _windows_.FontData_SetRange(*args, **kwargs)
"""
SetShowHelp(self, bool showHelp)
- Determines whether the Help button will be displayed in the font dialog
- (Windows only). The default value is false.
+ 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."""
+ """
+ wx.FontDialog allows the user to select a system font and its attributes.
+
+ :see: `wx.FontData`
+
+ """
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__(self, Window parent, FontData data) -> FontDialog
- Constructor. Pass a parent window and the FontData object to be
- used to initialize the dialog controls.
+ Constructor. Pass a parent window and the `wx.FontData` object to be
+ used to initialize the dialog controls. Call `ShowModal` to display
+ the dialog. If ShowModal returns ``wx.ID_OK`` then you can fetch the
+ results with via the `wx.FontData` returned by `GetFontData`.
"""
newobj = _windows_.new_FontDialog(*args, **kwargs)
self.this = newobj.this
"""
GetFontData(self) -> FontData
- Returns a reference to the internal FontData used by the FontDialog.
+ Returns a reference to the internal `wx.FontData` used by the
+ wx.FontDialog.
"""
return _windows_.FontDialog_GetFontData(*args, **kwargs)
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.
+ This class provides a simple dialog that shows a single or multi-line
+ message, with a choice of OK, Yes, No and/or Cancel buttons.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxMessageDialog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
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.
+ Constructor, use `ShowModal` to display the dialog.
"""
newobj = _windows_.new_MessageDialog(*args, **kwargs)
self.this = newobj.this
class ProgressDialog(Frame):
"""
- A dialog that shows a short message and a progress bar. Optionally, it can
- display an ABORT button.
+ 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,)
__init__(self, 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.
+ Constructor. Creates the dialog, displays it and disables user input
+ for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
+ parent window only.
"""
newobj = _windows_.new_ProgressDialog(*args, **kwargs)
self.this = newobj.this
"""
Update(self, 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.
+ 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.
+ 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)
"""
Resume(self)
- Can be used to continue with the dialog, after the user had chosen to abort.
+ Can be used to continue with the dialog, after the user had chosen to
+ abort.
"""
return _windows_.ProgressDialog_Resume(*args, **kwargs)
"""
GetReplaceString(self) -> String
- Return the string to replace the search string with (only
- for replace and replace all events).
+ Return the string to replace the search string with (only for replace
+ and replace all events).
"""
return _windows_.FindDialogEvent_GetReplaceString(*args, **kwargs)
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)
-
+ wx.FindReplaceData holds the data for wx.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 `wx.FindDialogEvent` is generated so instead of using the
+ `wx.FindDialogEvent` methods you can also directly query this object.
+
+ Note that all SetXXX() methods may only be called before showing the
+ dialog and calling them has no effect later.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxFindReplaceData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
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.
+ wx.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,)
"""_setCallbackInfo(self, PyObject self, PyObject _class)"""
return _windows_.PyWindow__setCallbackInfo(*args, **kwargs)
+ def SetBestSize(*args, **kwargs):
+ """SetBestSize(self, Size size)"""
+ return _windows_.PyWindow_SetBestSize(*args, **kwargs)
+
def base_DoMoveWindow(*args, **kwargs):
"""base_DoMoveWindow(self, int x, int y, int width, int height)"""
return _windows_.PyWindow_base_DoMoveWindow(*args, **kwargs)
"""base_ApplyParentThemeBackground(self, Colour c)"""
return _windows_.PyWindow_base_ApplyParentThemeBackground(*args, **kwargs)
+ def base_GetDefaultAttributes(*args, **kwargs):
+ """base_GetDefaultAttributes(self) -> VisualAttributes"""
+ return _windows_.PyWindow_base_GetDefaultAttributes(*args, **kwargs)
+
class PyWindowPtr(PyWindow):
def __init__(self, this):
"""_setCallbackInfo(self, PyObject self, PyObject _class)"""
return _windows_.PyPanel__setCallbackInfo(*args, **kwargs)
+ def SetBestSize(*args, **kwargs):
+ """SetBestSize(self, Size size)"""
+ return _windows_.PyPanel_SetBestSize(*args, **kwargs)
+
def base_DoMoveWindow(*args, **kwargs):
"""base_DoMoveWindow(self, int x, int y, int width, int height)"""
return _windows_.PyPanel_base_DoMoveWindow(*args, **kwargs)
"""base_ApplyParentThemeBackground(self, Colour c)"""
return _windows_.PyPanel_base_ApplyParentThemeBackground(*args, **kwargs)
+ def base_GetDefaultAttributes(*args, **kwargs):
+ """base_GetDefaultAttributes(self) -> VisualAttributes"""
+ return _windows_.PyPanel_base_GetDefaultAttributes(*args, **kwargs)
+
class PyPanelPtr(PyPanel):
def __init__(self, this):
"""_setCallbackInfo(self, PyObject self, PyObject _class)"""
return _windows_.PyScrolledWindow__setCallbackInfo(*args, **kwargs)
+ def SetBestSize(*args, **kwargs):
+ """SetBestSize(self, Size size)"""
+ return _windows_.PyScrolledWindow_SetBestSize(*args, **kwargs)
+
def base_DoMoveWindow(*args, **kwargs):
"""base_DoMoveWindow(self, int x, int y, int width, int height)"""
return _windows_.PyScrolledWindow_base_DoMoveWindow(*args, **kwargs)
"""base_ApplyParentThemeBackground(self, Colour c)"""
return _windows_.PyScrolledWindow_base_ApplyParentThemeBackground(*args, **kwargs)
+ def base_GetDefaultAttributes(*args, **kwargs):
+ """base_GetDefaultAttributes(self) -> VisualAttributes"""
+ return _windows_.PyScrolledWindow_base_GetDefaultAttributes(*args, **kwargs)
+
class PyScrolledWindowPtr(PyScrolledWindow):
def __init__(self, this):
return _windows_.Printer_GetAbort(*args, **kwargs)
def GetLastError(*args, **kwargs):
- """Printer.GetLastError() -> int"""
+ """GetLastError() -> int"""
return _windows_.Printer_GetLastError(*args, **kwargs)
GetLastError = staticmethod(GetLastError)
projects / wxWidgets.git / blobdiff