#---------------------------------------------------------------------------
</pythoncode>
<class name="Window" oldname="wxWindow" module="core">
+ <docstring>
+wx.Window is the base class for all windows and represents any visible
+object on the screen. All controls, top level windows and so on are
+wx.Windows. Sizers and device contexts are not however, as they don't
+appear on screen themselves.
+</docstring>
+ <refdoc>
+ Styles
+
+ wx.SIMPLE_BORDER: Displays a thin border around the window.
+
+ wx.DOUBLE_BORDER: Displays a double border. Windows and Mac only.
+
+ wx.SUNKEN_BORDER: Displays a sunken border.
+
+ wx.RAISED_BORDER: Displays a raised border.
+
+ wx.STATIC_BORDER: Displays a border suitable for a static
+ control. Windows only.
+
+ wx.NO_BORDER: Displays no border, overriding the default
+ border style for the window.
+
+ wx.TRANSPARENT_WINDOW: The window is transparent, that is, it
+ will not receive paint events. Windows only.
+
+ wx.TAB_TRAVERSAL: Use this to enable tab traversal for
+ non-dialog windows.
+
+ wx.WANTS_CHARS: Use this to indicate that the window
+ wants to get all char/key events for
+ all keys - even for keys like TAB or
+ ENTER which are usually used for
+ dialog navigation and which wouldn't
+ be generated without this style. If
+ you need to use this style in order to
+ get the arrows or etc., but would
+ still like to have normal keyboard
+ navigation take place, you should
+ create and send a wxNavigationKeyEvent
+ in response to the key events for Tab
+ and Shift-Tab.
+
+ wx.NO_FULL_REPAINT_ON_RESIZE: Disables repainting the window
+ completely when its size is changed
+ - you will have to repaint the new
+ window area manually if you use this
+ style. As of version 2.5.1 this
+ style is on by default. Use
+ wx.FULL_REPAINT_ON_RESIZE to
+ deactivate it.
+
+ wx.VSCROLL: Use this style to enable a vertical scrollbar.
+
+ wx.HSCROLL: Use this style to enable a horizontal scrollbar.
+
+ wx.ALWAYS_SHOW_SB: If a window has scrollbars, disable them
+ instead of hiding them when they are
+ not needed (i.e. when the size of the
+ window is big enough to not require
+ the scrollbars to navigate it). This
+ style is currently only implemented
+ for wxMSW and wxUniversal and does
+ nothing on the other platforms.
+
+ wx.CLIP_CHILDREN: Use this style to eliminate flicker caused by
+ the background being repainted, then
+ children being painted over
+ them. Windows only.
+
+ wx.FULL_REPAINT_ON_RESIZE: Use this style to force a complete
+ redraw of the window whenever it is
+ resized instead of redrawing just the
+ part of the window affected by
+ resizing. Note that this was the
+ behaviour by default before 2.5.1
+ release and that if you experience
+ redraw problems with the code which
+ previously used to work you may want
+ to try this.
+
+ Extra Styles
+
+ wx.WS_EX_VALIDATE_RECURSIVELY: By default,
+ Validate/TransferDataTo/FromWindow()
+ only work on direct children of
+ the window (compatible
+ behaviour). Set this flag to make
+ them recursively descend into all
+ subwindows.
+
+ wx.WS_EX_BLOCK_EVENTS: wx.CommandEvents and the objects of the
+ derived classes are forwarded to
+ the parent window and so on
+ recursively by default. Using this
+ flag for the given window allows
+ to block this propagation at this
+ window, i.e. prevent the events
+ from being propagated further
+ upwards. Dialogs have this flag on
+ by default.
+
+ wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
+ the other windows: this must be
+ used with transient windows as
+ otherwise there is the risk of
+ creating a dialog/frame with this
+ window as a parent which would
+ lead to a crash if the parent is
+ destroyed before the child.
+
+ wx.WS_EX_PROCESS_IDLE: This window should always process idle
+ events, even if the mode set by
+ wx.IdleEvent.SetMode is
+ wx.IDLE_PROCESS_SPECIFIED.
+
+ wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
+ update events, even if the mode
+ set by wxUpdateUIEvent::SetMode is
+ wxUPDATE_UI_PROCESS_SPECIFIED.
+
+</refdoc>
<baseclass name="EvtHandler"/>
<constructor name="Window" overloaded="no">
<autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, String name=PanelNameStr) -> Window</autodoc>
+ <docstring>Construct and show a generic Window.</docstring>
+ <refdoc>
+ Styles
+
+ wx.SIMPLE_BORDER: Displays a thin border around the window.
+
+ wx.DOUBLE_BORDER: Displays a double border. Windows and Mac only.
+
+ wx.SUNKEN_BORDER: Displays a sunken border.
+
+ wx.RAISED_BORDER: Displays a raised border.
+
+ wx.STATIC_BORDER: Displays a border suitable for a static
+ control. Windows only.
+
+ wx.NO_BORDER: Displays no border, overriding the default
+ border style for the window.
+
+ wx.TRANSPARENT_WINDOW: The window is transparent, that is, it
+ will not receive paint events. Windows only.
+
+ wx.TAB_TRAVERSAL: Use this to enable tab traversal for
+ non-dialog windows.
+
+ wx.WANTS_CHARS: Use this to indicate that the window
+ wants to get all char/key events for
+ all keys - even for keys like TAB or
+ ENTER which are usually used for
+ dialog navigation and which wouldn't
+ be generated without this style. If
+ you need to use this style in order to
+ get the arrows or etc., but would
+ still like to have normal keyboard
+ navigation take place, you should
+ create and send a wxNavigationKeyEvent
+ in response to the key events for Tab
+ and Shift-Tab.
+
+ wx.NO_FULL_REPAINT_ON_RESIZE: Disables repainting the window
+ completely when its size is changed
+ - you will have to repaint the new
+ window area manually if you use this
+ style. As of version 2.5.1 this
+ style is on by default. Use
+ wx.FULL_REPAINT_ON_RESIZE to
+ deactivate it.
+
+ wx.VSCROLL: Use this style to enable a vertical scrollbar.
+
+ wx.HSCROLL: Use this style to enable a horizontal scrollbar.
+
+ wx.ALWAYS_SHOW_SB: If a window has scrollbars, disable them
+ instead of hiding them when they are
+ not needed (i.e. when the size of the
+ window is big enough to not require
+ the scrollbars to navigate it). This
+ style is currently only implemented
+ for wxMSW and wxUniversal and does
+ nothing on the other platforms.
+
+ wx.CLIP_CHILDREN: Use this style to eliminate flicker caused by
+ the background being repainted, then
+ children being painted over
+ them. Windows only.
+
+ wx.FULL_REPAINT_ON_RESIZE: Use this style to force a complete
+ redraw of the window whenever it is
+ resized instead of redrawing just the
+ part of the window affected by
+ resizing. Note that this was the
+ behaviour by default before 2.5.1
+ release and that if you experience
+ redraw problems with the code which
+ previously used to work you may want
+ to try this.
+
+ Extra Styles
+
+ wx.WS_EX_VALIDATE_RECURSIVELY: By default,
+ Validate/TransferDataTo/FromWindow()
+ only work on direct children of
+ the window (compatible
+ behaviour). Set this flag to make
+ them recursively descend into all
+ subwindows.
+
+ wx.WS_EX_BLOCK_EVENTS: wx.CommandEvents and the objects of the
+ derived classes are forwarded to
+ the parent window and so on
+ recursively by default. Using this
+ flag for the given window allows
+ to block this propagation at this
+ window, i.e. prevent the events
+ from being propagated further
+ upwards. Dialogs have this flag on
+ by default.
+
+ wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
+ the other windows: this must be
+ used with transient windows as
+ otherwise there is the risk of
+ creating a dialog/frame with this
+ window as a parent which would
+ lead to a crash if the parent is
+ destroyed before the child.
+
+ wx.WS_EX_PROCESS_IDLE: This window should always process idle
+ events, even if the mode set by
+ wx.IdleEvent.SetMode is
+ wx.IDLE_PROCESS_SPECIFIED.
+
+ wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
+ update events, even if the mode
+ set by wxUpdateUIEvent::SetMode is
+ wxUPDATE_UI_PROCESS_SPECIFIED.
+
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreWindow" overloaded="no">
<autodoc>PreWindow() -> Window</autodoc>
+ <docstring>Precreate a Window for 2-phase creation.</docstring>
+ <refdoc>
+ Styles
+
+ wx.SIMPLE_BORDER: Displays a thin border around the window.
+
+ wx.DOUBLE_BORDER: Displays a double border. Windows and Mac only.
+
+ wx.SUNKEN_BORDER: Displays a sunken border.
+
+ wx.RAISED_BORDER: Displays a raised border.
+
+ wx.STATIC_BORDER: Displays a border suitable for a static
+ control. Windows only.
+
+ wx.NO_BORDER: Displays no border, overriding the default
+ border style for the window.
+
+ wx.TRANSPARENT_WINDOW: The window is transparent, that is, it
+ will not receive paint events. Windows only.
+
+ wx.TAB_TRAVERSAL: Use this to enable tab traversal for
+ non-dialog windows.
+
+ wx.WANTS_CHARS: Use this to indicate that the window
+ wants to get all char/key events for
+ all keys - even for keys like TAB or
+ ENTER which are usually used for
+ dialog navigation and which wouldn't
+ be generated without this style. If
+ you need to use this style in order to
+ get the arrows or etc., but would
+ still like to have normal keyboard
+ navigation take place, you should
+ create and send a wxNavigationKeyEvent
+ in response to the key events for Tab
+ and Shift-Tab.
+
+ wx.NO_FULL_REPAINT_ON_RESIZE: Disables repainting the window
+ completely when its size is changed
+ - you will have to repaint the new
+ window area manually if you use this
+ style. As of version 2.5.1 this
+ style is on by default. Use
+ wx.FULL_REPAINT_ON_RESIZE to
+ deactivate it.
+
+ wx.VSCROLL: Use this style to enable a vertical scrollbar.
+
+ wx.HSCROLL: Use this style to enable a horizontal scrollbar.
+
+ wx.ALWAYS_SHOW_SB: If a window has scrollbars, disable them
+ instead of hiding them when they are
+ not needed (i.e. when the size of the
+ window is big enough to not require
+ the scrollbars to navigate it). This
+ style is currently only implemented
+ for wxMSW and wxUniversal and does
+ nothing on the other platforms.
+
+ wx.CLIP_CHILDREN: Use this style to eliminate flicker caused by
+ the background being repainted, then
+ children being painted over
+ them. Windows only.
+
+ wx.FULL_REPAINT_ON_RESIZE: Use this style to force a complete
+ redraw of the window whenever it is
+ resized instead of redrawing just the
+ part of the window affected by
+ resizing. Note that this was the
+ behaviour by default before 2.5.1
+ release and that if you experience
+ redraw problems with the code which
+ previously used to work you may want
+ to try this.
+
+ Extra Styles
+
+ wx.WS_EX_VALIDATE_RECURSIVELY: By default,
+ Validate/TransferDataTo/FromWindow()
+ only work on direct children of
+ the window (compatible
+ behaviour). Set this flag to make
+ them recursively descend into all
+ subwindows.
+
+ wx.WS_EX_BLOCK_EVENTS: wx.CommandEvents and the objects of the
+ derived classes are forwarded to
+ the parent window and so on
+ recursively by default. Using this
+ flag for the given window allows
+ to block this propagation at this
+ window, i.e. prevent the events
+ from being propagated further
+ upwards. Dialogs have this flag on
+ by default.
+
+ wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
+ the other windows: this must be
+ used with transient windows as
+ otherwise there is the risk of
+ creating a dialog/frame with this
+ window as a parent which would
+ lead to a crash if the parent is
+ destroyed before the child.
+
+ wx.WS_EX_PROCESS_IDLE: This window should always process idle
+ events, even if the mode set by
+ wx.IdleEvent.SetMode is
+ wx.IDLE_PROCESS_SPECIFIED.
+
+ wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
+ update events, even if the mode
+ set by wxUpdateUIEvent::SetMode is
+ wxUPDATE_UI_PROCESS_SPECIFIED.
+
+</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
<autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, String name=PanelNameStr) -> bool</autodoc>
+ <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</method>
<method name="Close" type="bool" overloaded="no">
<autodoc>Close(bool force=False) -> bool</autodoc>
+ <docstring>This function simply generates a EVT_CLOSE event whose handler usually
+tries to close the window. It doesn't close the window itself,
+however. If force is False (the default) then the window's close
+handler will be allowed to veto the destruction of the window.
+
+Usually Close is only used with the top level windows (wx.Frame and
+wx.Dialog classes) as the others are not supposed to have any special
+EVT_CLOSE logic.
+
+The close handler should check whether the window is being deleted
+forcibly, using wx.CloseEvent.GetForce, in which case it should
+destroy the window using wx.Window.Destroy.
+
+Note that calling Close does not guarantee that the window will be
+destroyed; but it provides a way to simulate a manual close of a
+window, which may or may not be implemented by destroying the
+window. The default EVT_CLOSE handler for wx.Dialog does not
+necessarily delete the dialog, since it will simply simulate an
+wxID_CANCEL event which is handled by the appropriate button event
+handler and may do anything at all.
+
+To guarantee that the window will be destroyed, call wx.Window.Destroy
+instead.</docstring>
<paramlist>
<param name="force" type="bool" default="False"/>
</paramlist>
</method>
<method name="Destroy" type="bool" overloaded="no">
<autodoc>Destroy() -> bool</autodoc>
- <docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
+ <docstring>Destroys the window safely. Frames and dialogs are not destroyed
+immediately when this function is called -- they are added to a list
+of windows to be deleted on idle time, when all the window's events
+have been processed. This prevents problems with events being sent to
+non-existent windows.
+
+Returns True if the window has either been successfully deleted, or it
+has been added to the list of windows pending real deletion.</docstring>
</method>
<method name="DestroyChildren" type="bool" overloaded="no">
<autodoc>DestroyChildren() -> bool</autodoc>
+ <docstring>Destroys all children of a window. Called automatically by the destructor.</docstring>
</method>
<method name="IsBeingDeleted" type="bool" overloaded="no">
<autodoc>IsBeingDeleted() -> bool</autodoc>
+ <docstring>Is the window in the process of being deleted?</docstring>
</method>
<method name="SetTitle" type="" overloaded="no">
<autodoc>SetTitle(String title)</autodoc>
+ <docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
<autodoc>GetTitle() -> String</autodoc>
+ <docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring>
</method>
<method name="SetLabel" type="" overloaded="no">
<autodoc>SetLabel(String label)</autodoc>
+ <docstring>Set the text which the window shows in its label if applicable.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
<autodoc>GetLabel() -> String</autodoc>
+ <docstring>Generic way of getting a label from any window, for identification
+purposes. The interpretation of this function differs from class to
+class. For frames and dialogs, the value returned is the title. For
+buttons or static text controls, it is the button text. This function
+can be useful for meta-programs (such as testing tools or
+special-needs access programs) which need to identify windows by name.</docstring>
</method>
<method name="SetName" type="" overloaded="no">
<autodoc>SetName(String name)</autodoc>
+ <docstring>Sets the window's name. The window name is used for ressource setting
+in X, it is not the same as the window title/label</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetName" type="String" overloaded="no">
<autodoc>GetName() -> String</autodoc>
+ <docstring>Returns the window's name. This name is not guaranteed to be unique;
+it is up to the programmer to supply an appropriate name in the window
+constructor or via wx.Window.SetName.</docstring>
</method>
<method name="SetId" type="" overloaded="no">
<autodoc>SetId(int winid)</autodoc>
+ <docstring>Sets the identifier of the window. Each window has an integer
+identifier. If the application has not provided one, an identifier
+will be generated. Normally, the identifier should be provided on
+creation and should not be modified subsequently.</docstring>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
</method>
<method name="GetId" type="int" overloaded="no">
<autodoc>GetId() -> int</autodoc>
+ <docstring>Returns the identifier of the window. Each window has an integer
+identifier. If the application has not provided one (or the default Id
+-1 is used) then an unique identifier with a negative value will be
+generated.</docstring>
</method>
<staticmethod name="NewControlId" type="int" overloaded="no">
<autodoc>NewControlId() -> int</autodoc>
+ <docstring>Generate a control id for the controls which were not given one.</docstring>
</staticmethod>
<staticmethod name="NextControlId" type="int" overloaded="no">
<autodoc>NextControlId(int winid) -> int</autodoc>
+ <docstring>Get the id of the control following the one with the given
+(autogenerated) id</docstring>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="PrevControlId" type="int" overloaded="no">
<autodoc>PrevControlId(int winid) -> int</autodoc>
+ <docstring>Get the id of the control preceding the one with the given
+(autogenerated) id</docstring>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
</staticmethod>
<method name="SetSize" type="" overloaded="no">
<autodoc>SetSize(Size size)</autodoc>
+ <docstring>Sets the size of the window in pixels.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetDimensions" type="" overloaded="no">
<autodoc>SetDimensions(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <docstring>Sets the position and size of the window in pixels. The sizeFlags
+parameter indicates the interpretation of the other params if they are
+-1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
+shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
+used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
+dimensions of -1 and less to be interpreted as real dimensions, not
+default values.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="SetRect" type="" overloaded="no">
<autodoc>SetRect(Rect rect, int sizeFlags=SIZE_AUTO)</autodoc>
+ <docstring>Sets the position and size of the window in pixels using a wx.Rect.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="sizeFlags" type="int" default="wxSIZE_AUTO"/>
</method>
<method name="SetSizeWH" type="" overloaded="no">
<autodoc>SetSizeWH(int width, int height)</autodoc>
+ <docstring>Sets the size of the window in pixels.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</method>
<method name="Move" type="" overloaded="no">
<autodoc>Move(Point pt, int flags=SIZE_USE_EXISTING)</autodoc>
+ <docstring>Moves the window to the given position.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="flags" type="int" default="wxSIZE_USE_EXISTING"/>
</method>
<method name="MoveXY" type="" overloaded="no">
<autodoc>MoveXY(int x, int y, int flags=SIZE_USE_EXISTING)</autodoc>
+ <docstring>Moves the window to the given position.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="Raise" type="" overloaded="no">
<autodoc>Raise()</autodoc>
+ <docstring>Raises the window to the top of the window hierarchy if it is a
+managed window (dialog or frame).</docstring>
</method>
<method name="Lower" type="" overloaded="no">
<autodoc>Lower()</autodoc>
+ <docstring>Lowers the window to the bottom of the window hierarchy if it is a
+managed window (dialog or frame).</docstring>
</method>
<method name="SetClientSize" type="" overloaded="no">
<autodoc>SetClientSize(Size size)</autodoc>
+ <docstring>This sets the size of the window client area in pixels. Using this
+function to size a window tends to be more device-independent than
+wx.Window.SetSize, since the application need not worry about what
+dimensions the border or title bar have when trying to fit the window
+around panel items, for example.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetClientSizeWH" type="" overloaded="no">
<autodoc>SetClientSizeWH(int width, int height)</autodoc>
+ <docstring>This sets the size of the window client area in pixels. Using this
+function to size a window tends to be more device-independent than
+wx.Window.SetSize, since the application need not worry about what
+dimensions the border or title bar have when trying to fit the window
+around panel items, for example.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</method>
<method name="SetClientRect" type="" overloaded="no">
<autodoc>SetClientRect(Rect rect)</autodoc>
+ <docstring>This sets the size of the window client area in pixels. Using this
+function to size a window tends to be more device-independent than
+wx.Window.SetSize, since the application need not worry about what
+dimensions the border or title bar have when trying to fit the window
+around panel items, for example.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="GetRect" type="Rect" overloaded="no">
<autodoc>GetRect() -> Rect</autodoc>
+ <docstring>Returns the size and position of the window as a wx.Rect object.</docstring>
</method>
<method name="GetClientSize" type="Size" overloaded="no">
<autodoc>GetClientSize() -> Size</autodoc>
- <docstring>Get the window's client size.</docstring>
+ <docstring>This gets the size of the window's 'client area' in pixels. The client
+area is the area which may be drawn on by the programmer, excluding
+title bar, border, scrollbars, etc.</docstring>
</method>
<method name="GetClientSizeTuple" type="" overloaded="no">
<autodoc>GetClientSizeTuple() -> (width, height)</autodoc>
- <docstring>Get the window's client size.</docstring>
+ <docstring>This gets the size of the window's 'client area' in pixels. The client
+area is the area which may be drawn on by the programmer, excluding
+title bar, border, scrollbars, etc.</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</method>
<method name="GetClientAreaOrigin" type="Point" overloaded="no">
<autodoc>GetClientAreaOrigin() -> Point</autodoc>
+ <docstring>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...)</docstring>
</method>
<method name="GetClientRect" type="Rect" overloaded="no">
<autodoc>GetClientRect() -> Rect</autodoc>
+ <docstring>Get the client area position and size as a wx.Rect object.</docstring>
</method>
<method name="GetBestSize" type="Size" overloaded="no">
<autodoc>GetBestSize() -> Size</autodoc>
- <docstring>Get the size best suited for the window (in fact, minimal acceptable size
-using which it will still look "nice")</docstring>
+ <docstring>This functions returns the best acceptable minimal size for the
+window, if applicable. For example, for a static text control, it will be
+the minimal size such that the control label is not truncated. For
+windows containing subwindows (suzh aswx.Panel), the size returned
+by this function will be the same as the size the window would have
+had after calling Fit.</docstring>
</method>
<method name="GetBestSizeTuple" type="" overloaded="no">
<autodoc>GetBestSizeTuple() -> (width, height)</autodoc>
- <docstring>Get the size best suited for the window (in fact, minimal acceptable size
-using which it will still look "nice")</docstring>
+ <docstring>This functions returns the best acceptable minimal size for the
+window, if applicable. For example, for a static text control, it will be
+the minimal size such that the control label is not truncated. For
+windows containing subwindows (suzh aswx.Panel), the size returned
+by this function will be the same as the size the window would have
+had after calling Fit.</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</method>
<method name="GetAdjustedBestSize" type="Size" overloaded="no">
<autodoc>GetAdjustedBestSize() -> Size</autodoc>
+ <docstring>This method is similar to GetBestSize, except in one
+thing. GetBestSize should return the minimum untruncated size of the
+window, while this method will return the largest of BestSize and any
+user specified minimum size. ie. it is the minimum size the window
+should currently be drawn at, not the minimal size it can possibly
+tolerate.</docstring>
</method>
<method name="Center" type="" overloaded="no">
<autodoc>Center(int direction=BOTH)</autodoc>
+ <docstring>Centers the window. The parameter specifies the direction for
+cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
+also include wx.CENTER_ON_SCREEN flag if you want to center the window
+on the entire screen and not on its parent window. If it is a
+top-level window and has no parent then it will always be centered
+relative to the screen.</docstring>
<paramlist>
<param name="direction" type="int" default="wxBOTH"/>
</paramlist>
</method>
<method name="CenterOnScreen" type="" overloaded="no">
<autodoc>CenterOnScreen(int dir=BOTH)</autodoc>
+ <docstring>Center on screen (only works for top level windows)</docstring>
<paramlist>
<param name="dir" type="int" default="wxBOTH"/>
</paramlist>
</method>
<method name="CenterOnParent" type="" overloaded="no">
<autodoc>CenterOnParent(int dir=BOTH)</autodoc>
+ <docstring>Center with respect to the the parent window</docstring>
<paramlist>
<param name="dir" type="int" default="wxBOTH"/>
</paramlist>
</method>
<method name="Fit" type="" overloaded="no">
<autodoc>Fit()</autodoc>
+ <docstring>Sizes the window so that it fits around its subwindows. This function
+won't do anything if there are no subwindows and will only really work
+correctly if sizers are used for the subwindows layout. Also, if the
+window has exactly one subwindow it is better (faster and the result
+is more precise as Fit adds some margin to account for fuzziness of
+its calculations) to call window.SetClientSize(child.GetSize())
+instead of calling Fit.</docstring>
</method>
<method name="FitInside" type="" overloaded="no">
<autodoc>FitInside()</autodoc>
+ <docstring>Similar to Fit, but sizes the interior (virtual) size of a
+window. Mainly useful with scrolled windows to reset scrollbars after
+sizing changes that do not trigger a size event, and/or scrolled
+windows without an interior sizer. This function similarly won't do
+anything if there are no subwindows.</docstring>
</method>
<method name="SetSizeHints" type="" overloaded="no">
<autodoc>SetSizeHints(int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
int incH=-1)</autodoc>
+ <docstring>Allows specification of minimum and maximum window sizes, and window
+size increments. If a pair of values is not set (or set to -1), the
+default values will be used. If this function is called, the user
+will not be able to size the window outside the given bounds. The
+resizing increments are only significant under Motif or Xt.</docstring>
<paramlist>
<param name="minW" type="int" default=""/>
<param name="minH" type="int" default=""/>
</method>
<method name="SetVirtualSizeHints" type="" overloaded="no">
<autodoc>SetVirtualSizeHints(int minW, int minH, int maxW=-1, int maxH=-1)</autodoc>
+ <docstring>Allows specification of minimum and maximum virtual window sizes. If a
+pair of values is not set (or set to -1), the default values will be
+used. If this function is called, the user will not be able to size
+the virtual area of the window outside the given bounds.</docstring>
<paramlist>
<param name="minW" type="int" default=""/>
<param name="minH" type="int" default=""/>
</method>
<method name="SetVirtualSize" type="" overloaded="no">
<autodoc>SetVirtualSize(Size size)</autodoc>
- <docstring>Set the the virtual size of a window. For most windows this is just the
-client area of the window, but for some like scrolled windows it is more or
-less independent of the screen window size.</docstring>
+ <docstring>Set the the virtual size of a window in pixels. For most windows this
+is just the client area of the window, but for some like scrolled
+windows it is more or less independent of the screen window size.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetVirtualSizeWH" type="" overloaded="no">
<autodoc>SetVirtualSizeWH(int w, int h)</autodoc>
- <docstring>Set the the virtual size of a window. For most windows this is just the
-client area of the window, but for some like scrolled windows it is more or
-less independent of the screen window size.</docstring>
+ <docstring>Set the the virtual size of a window in pixels. For most windows this
+is just the client area of the window, but for some like scrolled
+windows it is more or less independent of the screen window size.</docstring>
<paramlist>
<param name="w" type="int" default=""/>
<param name="h" type="int" default=""/>
</method>
<method name="GetVirtualSize" type="Size" overloaded="no">
<autodoc>GetVirtualSize() -> Size</autodoc>
- <docstring>Get the the virtual size of the window. For most windows this is just
-the client area of the window, but for some like scrolled windows it is
-more or less independent of the screen window size.</docstring>
+ <docstring>Get the the virtual size of the window in pixels. For most windows
+this is just the client area of the window, but for some like scrolled
+windows it is more or less independent of the screen window size.</docstring>
</method>
<method name="GetVirtualSizeTuple" type="" overloaded="no">
<autodoc>GetVirtualSizeTuple() -> (width, height)</autodoc>
- <docstring>Get the the virtual size of the window. For most windows this is just
-the client area of the window, but for some like scrolled windows it is
-more or less independent of the screen window size.</docstring>
+ <docstring>Get the the virtual size of the window in pixels. For most windows
+this is just the client area of the window, but for some like scrolled
+windows it is more or less independent of the screen window size.</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</method>
<method name="GetBestVirtualSize" type="Size" overloaded="no">
<autodoc>GetBestVirtualSize() -> Size</autodoc>
+ <docstring>Return the largest of ClientSize and BestSize (as determined by a
+sizer, interior children, or other means)</docstring>
</method>
<method name="Show" type="bool" overloaded="no">
<autodoc>Show(bool show=True) -> bool</autodoc>
+ <docstring>Shows or hides the window. You may need to call Raise for a top level
+window if you want to bring it to top, although this is not needed if
+Show is called immediately after the frame creation. Returns True if
+the window has been shown or hidden or False if nothing was done
+because it already was in the requested state.</docstring>
<paramlist>
<param name="show" type="bool" default="True"/>
</paramlist>
</method>
<method name="Hide" type="bool" overloaded="no">
<autodoc>Hide() -> bool</autodoc>
+ <docstring>Equivalent to calling Show(False).</docstring>
</method>
<method name="Enable" type="bool" overloaded="no">
<autodoc>Enable(bool enable=True) -> bool</autodoc>
+ <docstring>Enable or disable the window for user input. Note that when a parent
+window is disabled, all of its children are disabled as well and they
+are reenabled again when the parent is. Returns true if the window
+has been enabled or disabled, false if nothing was done, i.e. if the
+window had already been in the specified state.</docstring>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="Disable" type="bool" overloaded="no">
<autodoc>Disable() -> bool</autodoc>
+ <docstring>Disables the window, same as Enable(false).</docstring>
</method>
<method name="IsShown" type="bool" overloaded="no">
<autodoc>IsShown() -> bool</autodoc>
+ <docstring>Returns true if the window is shown, false if it has been hidden.</docstring>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
<autodoc>IsEnabled() -> bool</autodoc>
+ <docstring>Returns true if the window is enabled for input, false otherwise.</docstring>
</method>
<method name="SetWindowStyleFlag" type="" overloaded="no">
<autodoc>SetWindowStyleFlag(long style)</autodoc>
+ <docstring>Sets the style of the window. Please note that some styles cannot be
+changed after the window creation and that Refresh() might be called
+after changing the others for the change to take place immediately.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="GetWindowStyleFlag" type="long" overloaded="no">
<autodoc>GetWindowStyleFlag() -> long</autodoc>
- </method>
- <method name="SetWindowStyle" type="" overloaded="no">
- <autodoc>SetWindowStyle(long style)</autodoc>
- <paramlist>
- <param name="style" type="long" default=""/>
- </paramlist>
- </method>
- <method name="GetWindowStyle" type="long" overloaded="no">
- <autodoc>GetWindowStyle() -> long</autodoc>
+ <docstring>Gets the window style that was passed to the constructor or Create
+method.</docstring>
</method>
<method name="HasFlag" type="bool" overloaded="no">
<autodoc>HasFlag(int flag) -> bool</autodoc>
+ <docstring>Test if the given style is set for this window.</docstring>
<paramlist>
<param name="flag" type="int" default=""/>
</paramlist>
</method>
<method name="IsRetained" type="bool" overloaded="no">
<autodoc>IsRetained() -> bool</autodoc>
+ <docstring>Returns true if the window is retained, false otherwise. Retained
+windows are only available on X platforms.</docstring>
</method>
<method name="SetExtraStyle" type="" overloaded="no">
<autodoc>SetExtraStyle(long exStyle)</autodoc>
+ <docstring>Sets the extra style bits for the window. Extra styles are the less
+often used style bits which can't be set with the constructor or with
+SetWindowStyleFlag()</docstring>
<paramlist>
<param name="exStyle" type="long" default=""/>
</paramlist>
</method>
<method name="GetExtraStyle" type="long" overloaded="no">
<autodoc>GetExtraStyle() -> long</autodoc>
+ <docstring>Returns the extra style bits for the window.</docstring>
</method>
<method name="MakeModal" type="" overloaded="no">
<autodoc>MakeModal(bool modal=True)</autodoc>
+ <docstring>Disables all other windows in the application so that the user can
+only interact with this window. Passing False will reverse this
+effect.</docstring>
<paramlist>
<param name="modal" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetThemeEnabled" type="" overloaded="no">
<autodoc>SetThemeEnabled(bool enableTheme)</autodoc>
+ <docstring>This function tells a window if it should use the system's "theme"
+ code to draw the windows' background instead if its own background
+ drawing code. This will only have an effect on platforms that support
+ the notion of themes in user defined windows. One such platform is
+ GTK+ where windows can have (very colourful) backgrounds defined by a
+ user's selected theme.
+
+Dialogs, notebook pages and the status bar have this flag set to true
+by default so that the default look and feel is simulated best.</docstring>
<paramlist>
<param name="enableTheme" type="bool" default=""/>
</paramlist>
</method>
<method name="GetThemeEnabled" type="bool" overloaded="no">
<autodoc>GetThemeEnabled() -> bool</autodoc>
- </method>
- <method name="ShouldInheritColours" type="bool" overloaded="no">
- <autodoc>ShouldInheritColours() -> bool</autodoc>
+ <docstring>Return the themeEnabled flag.</docstring>
</method>
<method name="SetFocus" type="" overloaded="no">
<autodoc>SetFocus()</autodoc>
+ <docstring>Set's the focus to this window, allowing it to receive keyboard input.</docstring>
</method>
<method name="SetFocusFromKbd" type="" overloaded="no">
<autodoc>SetFocusFromKbd()</autodoc>
+ <docstring>Set focus to this window as the result of a keyboard action. Normally
+only called internally.</docstring>
</method>
<staticmethod name="FindFocus" type="Window" overloaded="no">
<autodoc>FindFocus() -> Window</autodoc>
+ <docstring>Returns the window or control that currently has the keyboard focus,
+or None.</docstring>
</staticmethod>
<method name="AcceptsFocus" type="bool" overloaded="no">
<autodoc>AcceptsFocus() -> bool</autodoc>
+ <docstring>Can this window have focus?</docstring>
</method>
<method name="AcceptsFocusFromKeyboard" type="bool" overloaded="no">
<autodoc>AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <docstring>Can this window be given focus by keyboard navigation? if not, the
+only way to give it focus (provided it accepts it at all) is to click
+it.</docstring>
</method>
<method name="GetDefaultItem" type="Window" overloaded="no">
<autodoc>GetDefaultItem() -> Window</autodoc>
+ <docstring>Get the default child of this parent, i.e. the one which is activated
+by pressing <Enter> such as the OK button on a wx.Dialog.</docstring>
</method>
<method name="SetDefaultItem" type="Window" overloaded="no">
<autodoc>SetDefaultItem(Window child) -> Window</autodoc>
+ <docstring>Set this child as default, return the old default.</docstring>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="SetTmpDefaultItem" type="" overloaded="no">
<autodoc>SetTmpDefaultItem(Window win)</autodoc>
+ <docstring>Set this child as temporary default</docstring>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
</method>
<method name="GetChildren" type="PyObject" overloaded="no">
<autodoc>GetChildren() -> PyObject</autodoc>
+ <docstring>Returns a list of the window's children. NOTE: Currently this is a
+copy of the child window list maintained by the window, so the return
+value of this function is only valid as long as the window's children
+do not change.</docstring>
</method>
<method name="GetParent" type="Window" overloaded="no">
<autodoc>GetParent() -> Window</autodoc>
+ <docstring>Returns the parent window of this window, or None if there isn't one.</docstring>
</method>
<method name="GetGrandParent" type="Window" overloaded="no">
<autodoc>GetGrandParent() -> Window</autodoc>
+ <docstring>Returns the parent of the parent of this window, or None if there isn't one.</docstring>
</method>
<method name="IsTopLevel" type="bool" overloaded="no">
<autodoc>IsTopLevel() -> bool</autodoc>
+ <docstring>Returns true if the given window is a top-level one. Currently all
+frames and dialogs are always considered to be top-level windows (even
+if they have a parent window).</docstring>
</method>
<method name="Reparent" type="bool" overloaded="no">
<autodoc>Reparent(Window newParent) -> bool</autodoc>
+ <docstring>Reparents the window, i.e the window will be removed from its current
+parent window (e.g. a non-standard toolbar in a wxFrame) and then
+re-inserted into another. Available on Windows and GTK. Returns True
+if the parent was changed, False otherwise (error or newParent ==
+oldParent)</docstring>
<paramlist>
<param name="newParent" type="Window" default=""/>
</paramlist>
</method>
<method name="AddChild" type="" overloaded="no">
<autodoc>AddChild(Window child)</autodoc>
+ <docstring>Adds a child window. This is called automatically by window creation
+functions so should not be required by the application programmer.</docstring>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="RemoveChild" type="" overloaded="no">
<autodoc>RemoveChild(Window child)</autodoc>
+ <docstring>Removes a child window. This is called automatically by window
+deletion functions so should not be required by the application
+programmer.</docstring>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="FindWindowById" type="Window" overloaded="no">
<autodoc>FindWindowById(long winid) -> Window</autodoc>
+ <docstring>Find a chld of this window by window ID</docstring>
<paramlist>
<param name="winid" type="long" default=""/>
</paramlist>
</method>
<method name="FindWindowByName" type="Window" overloaded="no">
<autodoc>FindWindowByName(String name) -> Window</autodoc>
+ <docstring>Find a child of this window by name</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetEventHandler" type="EvtHandler" overloaded="no">
<autodoc>GetEventHandler() -> EvtHandler</autodoc>
+ <docstring>Returns the event handler for this window. By default, the window is
+its own event handler.</docstring>
</method>
<method name="SetEventHandler" type="" overloaded="no">
<autodoc>SetEventHandler(EvtHandler handler)</autodoc>
+ <docstring>Sets the event handler for this window. An event handler is an object
+that is capable of processing the events sent to a window. By default,
+the window is its own event handler, but an application may wish to
+substitute another, for example to allow central implementation of
+event-handling for a variety of different window classes.
+
+It is usually better to use wx.Window.PushEventHandler since this sets
+up a chain of event handlers, where an event not handled by one event
+handler is handed to the next one in the chain.</docstring>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="PushEventHandler" type="" overloaded="no">
<autodoc>PushEventHandler(EvtHandler handler)</autodoc>
+ <docstring>Pushes this event handler onto the event handler stack for the window.
+An event handler is an object that is capable of processing the events
+sent to a window. By default, the window is its own event handler, but
+an application may wish to substitute another, for example to allow
+central implementation of event-handling for a variety of different
+window classes.
+
+wx.Window.PushEventHandler allows an application to set up a chain of
+event handlers, where an event not handled by one event handler is
+handed to the next one in the chain. Use wx.Window.PopEventHandler to
+remove the event handler.</docstring>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="PopEventHandler" type="EvtHandler" overloaded="no">
<autodoc>PopEventHandler(bool deleteHandler=False) -> EvtHandler</autodoc>
+ <docstring>Removes and returns the top-most event handler on the event handler
+stack. If deleteHandler is True then the wx.EvtHandler object will be
+destroyed after it is popped.</docstring>
<paramlist>
<param name="deleteHandler" type="bool" default="False"/>
</paramlist>
</method>
<method name="RemoveEventHandler" type="bool" overloaded="no">
<autodoc>RemoveEventHandler(EvtHandler handler) -> bool</autodoc>
+ <docstring>Find the given handler in the event handler chain and remove (but
+not delete) it from the event handler chain, return True if it was
+found and False otherwise (this also results in an assert failure so
+this function should only be called when the handler is supposed to
+be there.)</docstring>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="SetValidator" type="" overloaded="no">
<autodoc>SetValidator(Validator validator)</autodoc>
+ <docstring>Deletes the current validator (if any) and sets the window validator,
+having called wx.Validator.Clone to create a new validator of this
+type.</docstring>
<paramlist>
<param name="validator" type="wxValidator" default=""/>
</paramlist>
</method>
<method name="GetValidator" type="wxValidator" overloaded="no">
<autodoc>GetValidator() -> Validator</autodoc>
+ <docstring>Returns a pointer to the current validator for the window, or None if
+there is none.</docstring>
</method>
<method name="SetAcceleratorTable" type="" overloaded="no">
<autodoc>SetAcceleratorTable(AcceleratorTable accel)</autodoc>
+ <docstring>Sets the accelerator table for this window.</docstring>
<paramlist>
<param name="accel" type="AcceleratorTable" default=""/>
</paramlist>
</method>
<method name="GetAcceleratorTable" type="AcceleratorTable" overloaded="no">
<autodoc>GetAcceleratorTable() -> AcceleratorTable</autodoc>
+ <docstring>Gets the accelerator table for this window.</docstring>
</method>
<method name="RegisterHotKey" type="bool" overloaded="no">
<autodoc>RegisterHotKey(int hotkeyId, int modifiers, int keycode) -> bool</autodoc>
+ <docstring>Registers a system wide hotkey. Every time the user presses the hotkey
+registered here, this window will receive a hotkey event. It will
+receive the event even if the application is in the background and
+does not have the input focus because the user is working with some
+other application. To bind an event handler function to this hotkey
+use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
+hotkey was registered successfully.</docstring>
<paramlist>
<param name="hotkeyId" type="int" default=""/>
<param name="modifiers" type="int" default=""/>
</method>
<method name="UnregisterHotKey" type="bool" overloaded="no">
<autodoc>UnregisterHotKey(int hotkeyId) -> bool</autodoc>
+ <docstring>Unregisters a system wide hotkey.</docstring>
<paramlist>
<param name="hotkeyId" type="int" default=""/>
</paramlist>
</method>
<method name="ConvertDialogPointToPixels" type="Point" overloaded="no">
<autodoc>ConvertDialogPointToPixels(Point pt) -> Point</autodoc>
+ <docstring>Converts a point or size from dialog units to pixels. Dialog units
+are used for maintaining a dialog's proportions even if the font
+changes. For the x dimension, the dialog units are multiplied by the
+average character width and then divided by 4. For the y dimension,
+the dialog units are multiplied by the average character height and
+then divided by 8.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="ConvertDialogSizeToPixels" type="Size" overloaded="no">
<autodoc>ConvertDialogSizeToPixels(Size sz) -> Size</autodoc>
+ <docstring>Converts a point or size from dialog units to pixels. Dialog units
+are used for maintaining a dialog's proportions even if the font
+changes. For the x dimension, the dialog units are multiplied by the
+average character width and then divided by 4. For the y dimension,
+the dialog units are multiplied by the average character height and
+then divided by 8.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="DLG_PNT" type="Point" overloaded="no">
<autodoc>DLG_PNT(Point pt) -> Point</autodoc>
+ <docstring>Converts a point or size from dialog units to pixels. Dialog units
+are used for maintaining a dialog's proportions even if the font
+changes. For the x dimension, the dialog units are multiplied by the
+average character width and then divided by 4. For the y dimension,
+the dialog units are multiplied by the average character height and
+then divided by 8.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="DLG_SZE" type="Size" overloaded="no">
<autodoc>DLG_SZE(Size sz) -> Size</autodoc>
+ <docstring>Converts a point or size from dialog units to pixels. Dialog units
+are used for maintaining a dialog's proportions even if the font
+changes. For the x dimension, the dialog units are multiplied by the
+average character width and then divided by 4. For the y dimension,
+the dialog units are multiplied by the average character height and
+then divided by 8.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="WarpPointer" type="" overloaded="no">
<autodoc>WarpPointer(int x, int y)</autodoc>
+ <docstring>Moves the pointer to the given position on the window.
+
+NOTE: This function is not supported under Mac because Apple Human
+Interface Guidelines forbid moving the mouse cursor programmatically.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="CaptureMouse" type="" overloaded="no">
<autodoc>CaptureMouse()</autodoc>
+ <docstring>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
+release the capture.
+
+Note that wxWindows maintains the stack of windows having captured the
+mouse and when the mouse is released the capture returns to the window
+which had had captured it previously and it is only really released if
+there were no previous window. In particular, this means that you must
+release the mouse as many times as you capture it.</docstring>
</method>
<method name="ReleaseMouse" type="" overloaded="no">
<autodoc>ReleaseMouse()</autodoc>
+ <docstring>Releases mouse input captured with wx.Window.CaptureMouse.</docstring>
</method>
<staticmethod name="GetCapture" type="Window" overloaded="no">
<autodoc>GetCapture() -> Window</autodoc>
+ <docstring>Returns the window which currently captures the mouse or None</docstring>
</staticmethod>
<method name="HasCapture" type="bool" overloaded="no">
<autodoc>HasCapture() -> bool</autodoc>
+ <docstring>Returns true if this window has the current mouse capture.</docstring>
</method>
<method name="Refresh" type="" overloaded="no">
<autodoc>Refresh(bool eraseBackground=True, Rect rect=None)</autodoc>
+ <docstring>Mark the specified rectangle (or the whole window) as "dirty" so it
+will be repainted. Causes an EVT_PAINT event to be generated and sent
+to the window.</docstring>
<paramlist>
<param name="eraseBackground" type="bool" default="True"/>
<param name="rect" type="Rect" default="NULL"/>
</method>
<method name="RefreshRect" type="" overloaded="no">
<autodoc>RefreshRect(Rect rect)</autodoc>
+ <docstring>Redraws the contents of the given rectangle: the area inside it will
+be repainted. This is the same as Refresh but has a nicer syntax.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="Update" type="" overloaded="no">
<autodoc>Update()</autodoc>
+ <docstring>Calling this method immediately repaints the invalidated area of the
+window instead of waiting for the EVT_PAINT event to happen, (normally
+this would usually only happen when the flow of control returns to the
+event loop.) Notice that this function doesn't refresh the window and
+does nothing if the window has been already repainted. Use Refresh
+first if you want to immediately redraw the window (or some portion of
+it) unconditionally.</docstring>
</method>
<method name="ClearBackground" type="" overloaded="no">
<autodoc>ClearBackground()</autodoc>
+ <docstring>Clears the window by filling it with the current background
+colour. Does not cause an erase background event to be generated.</docstring>
</method>
<method name="Freeze" type="" overloaded="no">
<autodoc>Freeze()</autodoc>
+ <docstring>Freezes the window or, in other words, prevents any updates from
+taking place on screen, the window is not redrawn at all. Thaw must be
+called to reenable window redrawing.
+
+This method is useful for visual appearance optimization (for example,
+it is a good idea to use it before inserting large amount of text into
+a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
+for all controls so it is mostly just a hint to wxWindows and not a
+mandatory directive.</docstring>
</method>
<method name="Thaw" type="" overloaded="no">
<autodoc>Thaw()</autodoc>
+ <docstring>Reenables window updating after a previous call to Freeze.</docstring>
</method>
<method name="PrepareDC" type="" overloaded="no">
<autodoc>PrepareDC(DC dc)</autodoc>
+ <docstring>Call this function to prepare the device context for drawing a
+scrolled image. It sets the device origin according to the current
+scroll position.</docstring>
<paramlist>
<param name="dc" type="wxDC" default=""/>
</paramlist>
</method>
<method name="GetUpdateRegion" type="wxRegion" overloaded="no">
<autodoc>GetUpdateRegion() -> Region</autodoc>
+ <docstring>Returns the region specifying which parts of the window have been
+damaged. Should only be called within an EVT_PAINT handler.</docstring>
</method>
<method name="GetUpdateClientRect" type="Rect" overloaded="no">
<autodoc>GetUpdateClientRect() -> Rect</autodoc>
+ <docstring>Get the update rectangle region bounding box in client coords.</docstring>
</method>
<method name="IsExposed" type="bool" overloaded="no">
<autodoc>IsExposed(int x, int y, int w=1, int h=1) -> bool</autodoc>
+ <docstring>Returns true if the given point or rectangle area has been exposed
+since the last repaint. Call this in an paint event handler to
+optimize redrawing by only redrawing those areas, which have been
+exposed.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="IsExposedPoint" type="bool" overloaded="no">
<autodoc>IsExposedPoint(Point pt) -> bool</autodoc>
+ <docstring>Returns true if the given point or rectangle area has been exposed
+since the last repaint. Call this in an paint event handler to
+optimize redrawing by only redrawing those areas, which have been
+exposed.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="isExposedRect" type="bool" overloaded="no">
<autodoc>isExposedRect(Rect rect) -> bool</autodoc>
+ <docstring>Returns true if the given point or rectangle area has been exposed
+since the last repaint. Call this in an paint event handler to
+optimize redrawing by only redrawing those areas, which have been
+exposed.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="bool" overloaded="no">
<autodoc>SetBackgroundColour(Colour colour) -> bool</autodoc>
+ <docstring>Sets the background colour of the window. Returns True if the colour
+was changed. The background colour is usually painted by the default
+EVT_ERASE_BACKGROUND event handler function under Windows and
+automatically under GTK.
+
+Note that setting the background colour does not cause an immediate
+refresh, so you may wish to call ClearBackground or Refresh after
+calling this function.
+
+Use this function with care under GTK+ as the new appearance of the
+window might not look equally well when used with themes, i.e GTK+'s
+ability to change its look as the user wishes with run-time loadable
+modules.</docstring>
<paramlist>
<param name="colour" type="wxColour" default=""/>
</paramlist>
</method>
<method name="SetForegroundColour" type="bool" overloaded="no">
<autodoc>SetForegroundColour(Colour colour) -> bool</autodoc>
+ <docstring>Sets the foreground colour of the window. Returns True is the colour
+was changed. The interpretation of foreground colour is dependent on
+the window class; it may be the text colour or other colour, or it may
+not be used at all.</docstring>
<paramlist>
<param name="colour" type="wxColour" default=""/>
</paramlist>
</method>
<method name="GetBackgroundColour" type="wxColour" overloaded="no">
<autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <docstring>Returns the background colour of the window.</docstring>
</method>
<method name="GetForegroundColour" type="wxColour" overloaded="no">
<autodoc>GetForegroundColour() -> Colour</autodoc>
+ <docstring>Returns the foreground colour of the window. The interpretation of
+foreground colour is dependent on the window class; it may be the text
+colour or other colour, or it may not be used at all.</docstring>
</method>
<method name="SetCursor" type="bool" overloaded="no">
<autodoc>SetCursor(Cursor cursor) -> bool</autodoc>
+ <docstring>Sets the window's cursor. Notice that the window cursor also sets it
+for the children of the window implicitly.
+
+The cursor may be wx.NullCursor in which case the window cursor will
+be reset back to default.</docstring>
<paramlist>
<param name="cursor" type="wxCursor" default=""/>
</paramlist>
</method>
<method name="GetCursor" type="wxCursor" overloaded="no">
<autodoc>GetCursor() -> Cursor</autodoc>
+ <docstring>Return the cursor associated with this window.</docstring>
</method>
<method name="SetFont" type="bool" overloaded="no">
<autodoc>SetFont(Font font) -> bool</autodoc>
+ <docstring>Sets the font for this window.</docstring>
<paramlist>
<param name="font" type="wxFont" default=""/>
</paramlist>
</method>
<method name="GetFont" type="wxFont" overloaded="no">
<autodoc>GetFont() -> Font</autodoc>
+ <docstring>Returns a reference to the font for this window.</docstring>
</method>
<method name="SetCaret" type="" overloaded="no">
<autodoc>SetCaret(Caret caret)</autodoc>
+ <docstring>Sets the caret associated with the window.</docstring>
<paramlist>
<param name="caret" type="wxCaret" default=""/>
</paramlist>
</method>
<method name="GetCaret" type="wxCaret" overloaded="no">
<autodoc>GetCaret() -> Caret</autodoc>
+ <docstring>Returns the caret associated with the window.</docstring>
</method>
<method name="GetCharHeight" type="int" overloaded="no">
<autodoc>GetCharHeight() -> int</autodoc>
+ <docstring>Get the (average) character size for the current font.</docstring>
</method>
<method name="GetCharWidth" type="int" overloaded="no">
<autodoc>GetCharWidth() -> int</autodoc>
+ <docstring>Get the (average) character size for the current font.</docstring>
</method>
<method name="GetTextExtent" type="" overloaded="no">
<autodoc>GetTextExtent(String string) -> (width, height)</autodoc>
<method name="GetFullTextExtent" type="" overloaded="no">
<autodoc>GetFullTextExtent(String string, Font font=None) ->
(width, height, descent, externalLeading)</autodoc>
- <docstring>Get the width, height, decent and leading of the text using the current or specified font.</docstring>
+ <docstring>Get the width, height, decent and leading of the text using the
+current or specified font.</docstring>
<paramlist>
<param name="string" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="ClientToScreenXY" type="" overloaded="no">
- <autodoc>ClientToScreenXY(int x, int y)</autodoc>
+ <autodoc>ClientToScreenXY(int x, int y) -> (x,y)</autodoc>
+ <docstring>Converts to screen coordinates from coordinates relative to this window.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="ScreenToClientXY" type="" overloaded="no">
- <autodoc>ScreenToClientXY(int x, int y)</autodoc>
+ <autodoc>ScreenToClientXY(int x, int y) -> (x,y)</autodoc>
+ <docstring>Converts from screen to client window coordinates.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="ClientToScreen" type="Point" overloaded="no">
<autodoc>ClientToScreen(Point pt) -> Point</autodoc>
+ <docstring>Converts to screen coordinates from coordinates relative to this window.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="ScreenToClient" type="Point" overloaded="no">
<autodoc>ScreenToClient(Point pt) -> Point</autodoc>
+ <docstring>Converts from screen to client window coordinates.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="HitTestXY" type="wxHitTest" overloaded="no">
<autodoc>HitTestXY(int x, int y) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="HitTest" type="wxHitTest" overloaded="no">
<autodoc>HitTest(Point pt) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="GetBorderFlags" type="wxBorder" overloaded="no">
- <autodoc>GetBorderFlags(long flags) -> int</autodoc>
+ <method name="GetBorder" type="wxBorder" overloaded="yes">
+ <docstring>Get the window border style from the given flags: this is different
+from simply doing flags & wxBORDER_MASK because it uses
+GetDefaultBorder() to translate wxBORDER_DEFAULT to something
+reasonable.
+</docstring>
<paramlist>
<param name="flags" type="long" default=""/>
</paramlist>
</method>
- <method name="GetBorder" type="wxBorder" overloaded="no">
- <autodoc>GetBorder() -> int</autodoc>
+ <method name="GetBorder" type="wxBorder" overloaded="yes">
+ <autodoc>GetBorder(long flags) -> int
+GetBorder() -> int</autodoc>
+ <docstring>Get border for the flags of this window</docstring>
</method>
<method name="UpdateWindowUI" type="" overloaded="no">
<autodoc>UpdateWindowUI(long flags=UPDATE_UI_NONE)</autodoc>
+ <docstring>This function sends EVT_UPDATE_UI events to the window. The particular
+implementation depends on the window; for example a wx.ToolBar will
+send an update UI event for each toolbar button, and a wx.Frame will
+send an update UI event for each menubar menu item. You can call this
+function from your application to ensure that your UI is up-to-date at
+a particular point in time (as far as your EVT_UPDATE_UI handlers are
+concerned). This may be necessary if you have called
+wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
+limit the overhead that wxWindows incurs by sending update UI events
+in idle time.
+
+The flags should be a bitlist of one or more of the following values:
+
+ wx.UPDATE_UI_NONE No particular value
+ wx.UPDATE_UI_RECURSE Call the function for descendants
+ wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
+
+If you are calling this function from an OnIdle function, make sure
+you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window to
+only update the UI elements that need to be updated in idle time. Some
+windows update their elements only when necessary, for example when a
+menu is about to be shown. The following is an example of how to call
+UpdateWindowUI from an idle function.
+
+ def OnIdle(self, evt):
+ if wx.UpdateUIEvent.CanUpdate(self):
+ self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
+</docstring>
<paramlist>
<param name="flags" type="long" default="wxUPDATE_UI_NONE"/>
</paramlist>
</method>
<method name="PopupMenuXY" type="bool" overloaded="no">
<autodoc>PopupMenuXY(Menu menu, int x, int y) -> bool</autodoc>
+ <docstring>Pops up the given menu at the specified coordinates, relative to this
+window, and returns control when the user has dismissed the menu. If a
+menu item is selected, the corresponding menu event is generated and
+will be processed as usual.</docstring>
<paramlist>
<param name="menu" type="wxMenu" default=""/>
<param name="x" type="int" default=""/>
</method>
<method name="PopupMenu" type="bool" overloaded="no">
<autodoc>PopupMenu(Menu menu, Point pos) -> bool</autodoc>
+ <docstring>Pops up the given menu at the specified coordinates, relative to this
+window, and returns control when the user has dismissed the menu. If a
+menu item is selected, the corresponding menu event is generated and
+will be processed as usual.</docstring>
<paramlist>
<param name="menu" type="wxMenu" default=""/>
<param name="pos" type="Point" default=""/>
</method>
<method name="GetHandle" type="long" overloaded="no">
<autodoc>GetHandle() -> long</autodoc>
+ <docstring>Returns the platform-specific handle (as a long integer) of the
+physical window. Currently on wxMac it returns the handle of the
+toplevel parent of the window.</docstring>
</method>
<method name="HasScrollbar" type="bool" overloaded="no">
<autodoc>HasScrollbar(int orient) -> bool</autodoc>
+ <docstring>Does the window have the scrollbar for this orientation?</docstring>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollbar" type="" overloaded="no">
- <autodoc>SetScrollbar(int orient, int pos, int thumbvisible, int range, bool refresh=True)</autodoc>
+ <autodoc>SetScrollbar(int orientation, int pos, int thumbvisible, int range,
+ bool refresh=True)</autodoc>
+ <docstring>Sets the scrollbar properties of a built-in scrollbar.
+
+ orientation: Determines the scrollbar whose page size is to be
+ set. May be wx.HORIZONTAL or wx.VERTICAL.
+
+ position: The position of the scrollbar in scroll units.
+
+ thumbSize: The size of the thumb, or visible portion of the
+ scrollbar, in scroll units.
+
+ range: The maximum position of the scrollbar.
+
+ refresh: True to redraw the scrollbar, false otherwise.</docstring>
<paramlist>
- <param name="orient" type="int" default=""/>
+ <param name="orientation" type="int" default=""/>
<param name="pos" type="int" default=""/>
<param name="thumbvisible" type="int" default=""/>
<param name="range" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollPos" type="" overloaded="no">
- <autodoc>SetScrollPos(int orient, int pos, bool refresh=True)</autodoc>
+ <autodoc>SetScrollPos(int orientation, int pos, bool refresh=True)</autodoc>
+ <docstring>Sets the position of one of the built-in scrollbars.</docstring>
<paramlist>
- <param name="orient" type="int" default=""/>
+ <param name="orientation" type="int" default=""/>
<param name="pos" type="int" default=""/>
<param name="refresh" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetScrollPos" type="int" overloaded="no">
- <autodoc>GetScrollPos(int orient) -> int</autodoc>
+ <autodoc>GetScrollPos(int orientation) -> int</autodoc>
+ <docstring>Returns the built-in scrollbar position.</docstring>
<paramlist>
- <param name="orient" type="int" default=""/>
+ <param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollThumb" type="int" overloaded="no">
- <autodoc>GetScrollThumb(int orient) -> int</autodoc>
+ <autodoc>GetScrollThumb(int orientation) -> int</autodoc>
+ <docstring>Returns the built-in scrollbar thumb size.</docstring>
<paramlist>
- <param name="orient" type="int" default=""/>
+ <param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollRange" type="int" overloaded="no">
- <autodoc>GetScrollRange(int orient) -> int</autodoc>
+ <autodoc>GetScrollRange(int orientation) -> int</autodoc>
+ <docstring>Returns the built-in scrollbar range.</docstring>
<paramlist>
- <param name="orient" type="int" default=""/>
+ <param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollWindow" type="" overloaded="no">
<autodoc>ScrollWindow(int dx, int dy, Rect rect=None)</autodoc>
+ <docstring>Physically scrolls the pixels in the window and move child windows
+accordingly. Use this function to optimise your scrolling
+implementations, to minimise the area that must be redrawn. Note that
+it is rarely required to call this function from a user program.
+
+ dx: Amount to scroll horizontally.
+
+ dy: Amount to scroll vertically.
+
+ rect: Rectangle to invalidate. If this is None, the whole window
+ is invalidated. If you pass a rectangle corresponding to the
+ area of the window exposed by the scroll, your painting
+ handler can optimize painting by checking for the
+ invalidated region.</docstring>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</method>
<method name="ScrollLines" type="bool" overloaded="no">
<autodoc>ScrollLines(int lines) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="lines" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollPages" type="bool" overloaded="no">
<autodoc>ScrollPages(int pages) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="pages" type="int" default=""/>
</paramlist>
</method>
<method name="LineUp" type="bool" overloaded="no">
<autodoc>LineUp() -> bool</autodoc>
+ <docstring>This is just a wrapper for ScrollLines(-1).</docstring>
</method>
<method name="LineDown" type="bool" overloaded="no">
<autodoc>LineDown() -> bool</autodoc>
+ <docstring>This is just a wrapper for ScrollLines(1).</docstring>
</method>
<method name="PageUp" type="bool" overloaded="no">
<autodoc>PageUp() -> bool</autodoc>
+ <docstring>This is just a wrapper for ScrollPages(-1).</docstring>
</method>
<method name="PageDown" type="bool" overloaded="no">
<autodoc>PageDown() -> bool</autodoc>
+ <docstring>This is just a wrapper for ScrollPages(1).</docstring>
</method>
<method name="SetHelpText" type="" overloaded="no">
<autodoc>SetHelpText(String text)</autodoc>
+ <docstring>Sets the help text to be used as context-sensitive help for this
+window. Note that the text is actually stored by the current
+wxHelpProvider implementation, and not in the window object itself.</docstring>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetHelpTextForId" type="" overloaded="no">
<autodoc>SetHelpTextForId(String text)</autodoc>
+ <docstring>Associate this help text with all windows with the same id as this
+one.</docstring>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetHelpText" type="String" overloaded="no">
<autodoc>GetHelpText() -> String</autodoc>
+ <docstring>Gets the help text to be used as context-sensitive help for this
+window. Note that the text is actually stored by the current
+wxHelpProvider implementation, and not in the window object itself.</docstring>
</method>
<method name="SetToolTipString" type="" overloaded="no">
<autodoc>SetToolTipString(String tip)</autodoc>
+ <docstring>Attach a tooltip to the window.</docstring>
<paramlist>
<param name="tip" type="String" default=""/>
</paramlist>
</method>
<method name="SetToolTip" type="" overloaded="no">
<autodoc>SetToolTip(ToolTip tip)</autodoc>
+ <docstring>Attach a tooltip to the window.</docstring>
<paramlist>
<param name="tip" type="wxToolTip" default=""/>
</paramlist>
</method>
<method name="GetToolTip" type="wxToolTip" overloaded="no">
<autodoc>GetToolTip() -> ToolTip</autodoc>
+ <docstring>get the associated tooltip or None if none</docstring>
</method>
<method name="SetDropTarget" type="" overloaded="no">
- <autodoc>SetDropTarget(PyDropTarget dropTarget)</autodoc>
+ <autodoc>SetDropTarget(DropTarget dropTarget)</autodoc>
+ <docstring>Associates a drop target with this window. If the window already has
+a drop target, it is deleted.</docstring>
<paramlist>
<param name="dropTarget" type="wxPyDropTarget" default=""/>
</paramlist>
</method>
<method name="GetDropTarget" type="wxPyDropTarget" overloaded="no">
- <autodoc>GetDropTarget() -> PyDropTarget</autodoc>
+ <autodoc>GetDropTarget() -> DropTarget</autodoc>
+ <docstring>Returns the associated drop target, which may be None.</docstring>
</method>
<method name="SetConstraints" type="" overloaded="no">
<autodoc>SetConstraints(LayoutConstraints constraints)</autodoc>
+ <docstring>Sets the window to have the given layout constraints. If an existing
+layout constraints object is already owned by the window, it will be
+deleted. Pass None to disassociate and delete the window's current
+constraints.
+
+You must call SetAutoLayout to tell a window to use the constraints
+automatically in its default EVT_SIZE handler; otherwise, you must
+handle EVT_SIZE yourself and call Layout() explicitly. When setting
+both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
+effect.</docstring>
<paramlist>
<param name="constraints" type="wxLayoutConstraints" default=""/>
</paramlist>
</method>
<method name="GetConstraints" type="wxLayoutConstraints" overloaded="no">
<autodoc>GetConstraints() -> LayoutConstraints</autodoc>
+ <docstring>Returns a pointer to the window's layout constraints, or None if there
+are none.</docstring>
</method>
<method name="SetAutoLayout" type="" overloaded="no">
<autodoc>SetAutoLayout(bool autoLayout)</autodoc>
+ <docstring>Determines whether the Layout function will be called automatically
+when the window is resized. It is called implicitly by SetSizer but
+if you use SetConstraints you should call it manually or otherwise the
+window layout won't be correctly updated when its size changes.</docstring>
<paramlist>
<param name="autoLayout" type="bool" default=""/>
</paramlist>
</method>
<method name="GetAutoLayout" type="bool" overloaded="no">
<autodoc>GetAutoLayout() -> bool</autodoc>
+ <docstring>Returns the current autoLayout setting</docstring>
</method>
<method name="Layout" type="bool" overloaded="no">
<autodoc>Layout() -> bool</autodoc>
+ <docstring>Invokes the constraint-based layout algorithm or the sizer-based
+algorithm for this window. See SetAutoLayout: when auto layout is on,
+this function gets called automatically by the default EVT_SIZE
+handler when the window is resized.</docstring>
</method>
<method name="SetSizer" type="" overloaded="no">
<autodoc>SetSizer(Sizer sizer, bool deleteOld=True)</autodoc>
+ <docstring>Sets the window to have the given layout sizer. The window will then
+own the object, and will take care of its deletion. If an existing
+layout sizer object is already owned by the window, it will be deleted
+if the deleteOld parameter is true. Note that this function will also
+call SetAutoLayout implicitly with a True parameter if the sizer is
+non-NoneL and False otherwise.</docstring>
<paramlist>
<param name="sizer" type="wxSizer" default=""/>
<param name="deleteOld" type="bool" default="True"/>
</method>
<method name="SetSizerAndFit" type="" overloaded="no">
<autodoc>SetSizerAndFit(Sizer sizer, bool deleteOld=True)</autodoc>
+ <docstring>The same as SetSizer, except it also sets the size hints for the
+window based on the sizer's minimum size.</docstring>
<paramlist>
<param name="sizer" type="wxSizer" default=""/>
<param name="deleteOld" type="bool" default="True"/>
</method>
<method name="GetSizer" type="wxSizer" overloaded="no">
<autodoc>GetSizer() -> Sizer</autodoc>
+ <docstring>Return the sizer associated with the window by a previous call to
+SetSizer or None if there isn't one.</docstring>
</method>
<method name="SetContainingSizer" type="" overloaded="no">
<autodoc>SetContainingSizer(Sizer sizer)</autodoc>
+ <docstring>This normally does not need to be called by application code. It is
+called internally when a window is added to a sizer, and is used so
+the window can remove itself from the sizer when it is destroyed.</docstring>
<paramlist>
<param name="sizer" type="wxSizer" default=""/>
</paramlist>
</method>
<method name="GetContainingSizer" type="wxSizer" overloaded="no">
<autodoc>GetContainingSizer() -> Sizer</autodoc>
+ <docstring>Return the sizer that this window is a member of, if any, otherwise None.</docstring>
</method>
</class>
<pythoncode>
def DLG_PNT(win, point_or_x, y=None):
+ """
+ Convenience function for converting a Point or (x,y) in
+ dialog units to pixel units.
+ """
if y is None:
return win.ConvertDialogPointToPixels(point_or_x)
else:
return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
def DLG_SZE(win, size_width, height=None):
+ """
+ Convenience function for converting a Size or (w,h) in
+ dialog units to pixel units.
+ """
if height is None:
return win.ConvertDialogSizeToPixels(size_width)
else:
</pythoncode>
<method name="FindWindowById" oldname="wxFindWindowById" type="Window" overloaded="no">
<autodoc>FindWindowById(long id, Window parent=None) -> Window</autodoc>
+ <docstring>Find the first window in the application with the given id. If parent
+is None, the search will start from all top-level frames and dialog
+boxes; if non-None, the search will be limited to the given window
+hierarchy. The search is recursive in both cases.</docstring>
<paramlist>
<param name="id" type="long" default=""/>
<param name="parent" type="Window" default="NULL"/>
</method>
<method name="FindWindowByName" oldname="wxFindWindowByName" type="Window" overloaded="no">
<autodoc>FindWindowByName(String name, Window parent=None) -> Window</autodoc>
+ <docstring>Find a window by its name (as given in a window constructor or Create
+function call). If parent is None, the search will start from all
+top-level frames and dialog boxes; if non-None, the search will be
+limited to the given window hierarchy. The search is recursive in both
+cases.
+
+If no window with such name is found, wx.FindWindowByLabel is called.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
<param name="parent" type="Window" default="NULL"/>
</method>
<method name="FindWindowByLabel" oldname="wxFindWindowByLabel" type="Window" overloaded="no">
<autodoc>FindWindowByLabel(String label, Window parent=None) -> Window</autodoc>
+ <docstring>Find a window by its label. Depending on the type of window, the label
+may be a window title or panel item label. If parent is None, the
+search will start from all top-level frames and dialog boxes; if
+non-None, the search will be limited to the given window
+hierarchy. The search is recursive in both cases.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
<param name="parent" type="Window" default="NULL"/>
#---------------------------------------------------------------------------
</pythoncode>
<class name="Control" oldname="wxControl" module="core">
+ <docstring>This is the base class for a control or 'widget'.
+
+A control is generally a small window which processes user input and/or
+displays one or more item of data.</docstring>
<baseclass name="Window"/>
<constructor name="Control" overloaded="no">
<autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> Control</autodoc>
+ <docstring>Create a Control. Normally you should only call this from a
+subclass' __init__ as a plain old wx.Control is not very useful.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreControl" overloaded="no">
<autodoc>PreControl() -> Control</autodoc>
+ <docstring>Precreate a Control control for 2-phase creation</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
<autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</method>
<method name="Command" type="" overloaded="no">
<autodoc>Command(CommandEvent event)</autodoc>
+ <docstring>Simulates the effect of the user issuing a command to the
+item. See wxCommandEvent.</docstring>
<paramlist>
<param name="event" type="CommandEvent" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
<autodoc>GetLabel() -> String</autodoc>
+ <docstring>Return a control's text.</docstring>
</method>
<method name="SetLabel" type="" overloaded="no">
<autodoc>SetLabel(String label)</autodoc>
+ <docstring>Sets the item's text.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ItemContainer" oldname="wxItemContainer" module="core">
+ <docstring>wx.ItemContainer defines an interface which is implemented by all
+controls which have string subitems, each of which may be
+selected, such as wx.ListBox, wx.CheckListBox, wx.Choice and
+wx.ComboBox (which implements an extended interface deriving from
+this one)
+
+It defines the methods for accessing the control's items and
+although each of the derived classes implements them differently,
+they still all conform to the same interface.
+
+The items in a wx.ItemContainer have (non empty) string labels
+and, optionally, client data associated with them.
+</docstring>
<method name="Append" type="int" overloaded="no">
<autodoc>Append(String item, PyObject clientData=None) -> int</autodoc>
+ <docstring>Adds the item to the control, associating the given data with the
+item if not None. The return value is the index of the newly
+added item which may be different from the last one if the
+control is sorted (e.g. has wx.LB_SORT or wx.CB_SORT style).</docstring>
<paramlist>
<param name="item" type="String" default=""/>
<param name="clientData" type="PyObject" default="NULL"/>
</method>
<method name="AppendItems" type="" overloaded="no">
<autodoc>AppendItems(wxArrayString strings)</autodoc>
+ <docstring>Apend several items at once to the control. Notice that calling
+this method may be much faster than appending the items one by
+one if you need to add a lot of items.</docstring>
<paramlist>
<param name="strings" type="wxArrayString" default=""/>
</paramlist>
</method>
<method name="Insert" type="int" overloaded="no">
<autodoc>Insert(String item, int pos, PyObject clientData=None) -> int</autodoc>
+ <docstring>Insert an item into the control before the item at the pos index,
+optionally associating some data object with the item.</docstring>
<paramlist>
<param name="item" type="String" default=""/>
<param name="pos" type="int" default=""/>
</method>
<method name="Clear" type="" overloaded="no">
<autodoc>Clear()</autodoc>
+ <docstring>Removes all items from the control.</docstring>
</method>
<method name="Delete" type="" overloaded="no">
<autodoc>Delete(int n)</autodoc>
+ <docstring>Deletes the item at the zero-based index 'n' from the control.
+Note that it is an error (signalled by a PyAssertionError
+exception if enabled) to remove an item with the index negative
+or greater or equal than the number of items in the control.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
<autodoc>GetCount() -> int</autodoc>
+ <docstring>Returns the number of items in the control.</docstring>
</method>
<method name="IsEmpty" type="bool" overloaded="no">
<autodoc>IsEmpty() -> bool</autodoc>
+ <docstring>Returns True if the control is empty or False if it has some items.</docstring>
</method>
<method name="GetString" type="String" overloaded="no">
<autodoc>GetString(int n) -> String</autodoc>
+ <docstring>Returns the label of the item with the given index.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetString" type="" overloaded="no">
<autodoc>SetString(int n, String s)</autodoc>
+ <docstring>Sets the label for the given item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
<param name="s" type="String" default=""/>
</method>
<method name="FindString" type="int" overloaded="no">
<autodoc>FindString(String s) -> int</autodoc>
+ <docstring>Finds an item whose label matches the given string. Returns the
+zero-based position of the item, or wx.NOT_FOUND if the string
+was not found.</docstring>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="Select" type="" overloaded="no">
<autodoc>Select(int n)</autodoc>
+ <docstring>Sets the item at index 'n' to be the selected item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="int" overloaded="no">
<autodoc>GetSelection() -> int</autodoc>
+ <docstring>Returns the index of the selected item or wx.NOT_FOUND if no item is selected.</docstring>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
<autodoc>GetStringSelection() -> String</autodoc>
+ <docstring>Returns the label of the selected item or an empty string if no item is selected.</docstring>
</method>
<method name="GetClientData" type="PyObject" overloaded="no">
<autodoc>GetClientData(int n) -> PyObject</autodoc>
+ <docstring>Returns the client data associated with the given item, (if any.)</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetClientData" type="" overloaded="no">
<autodoc>SetClientData(int n, PyObject clientData)</autodoc>
+ <docstring>Associate the given client data with the item at position n.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
<param name="clientData" type="PyObject" default=""/>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ControlWithItems" oldname="wxControlWithItems" module="core">
+ <docstring>wx.ControlWithItems combines the wx.ItemContainer class with the
+wx.Control class, and is used for the base class of various
+controls that have items.</docstring>
<baseclass name="Control"/>
<baseclass name="ItemContainer"/>
</class>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(GBPosition p) -> bool</autodoc>
+ <autodoc>__eq__(GBPosition other) -> bool</autodoc>
<paramlist>
- <param name="p" type="GBPosition" default=""/>
+ <param name="other" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(GBPosition p) -> bool</autodoc>
+ <autodoc>__ne__(GBPosition other) -> bool</autodoc>
<paramlist>
- <param name="p" type="GBPosition" default=""/>
+ <param name="other" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(GBSpan o) -> bool</autodoc>
+ <autodoc>__eq__(GBSpan other) -> bool</autodoc>
<paramlist>
- <param name="o" type="GBSpan" default=""/>
+ <param name="other" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(GBSpan o) -> bool</autodoc>
+ <autodoc>__ne__(GBSpan other) -> bool</autodoc>
<paramlist>
- <param name="o" type="GBSpan" default=""/>
+ <param name="other" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
#---------------------------------------------------------------------------
</pythoncode>
<class name="IndividualLayoutConstraint" oldname="wxIndividualLayoutConstraint" module="core">
+ <docstring>Objects of this class are stored in the wx.LayoutConstraint class as one of
+eight possible constraints that a window can be involved in. You will never
+need to create an instance of wx.IndividualLayoutConstraint, rather you should
+use create a wx.LayoutContstraints instance and use the individual contstraints
+that it contains.
+
+Constraints are initially set to have the relationship wx.Unconstrained, which
+means that their values should be calculated by looking at known constraints.
+
+The Edge specifies the type of edge or dimension of a window.
+
+ Edges
+
+ wx.Left The left edge.
+ wx.Top The top edge.
+ wx.Right The right edge.
+ wx.Bottom The bottom edge.
+ wx.CentreX The x-coordinate of the centre of the window.
+ wx.CentreY The y-coordinate of the centre of the window.
+
+
+The Relationship specifies the relationship that this edge or dimension has
+with another specified edge or dimension. Normally, the user doesn't use these
+directly because functions such as Below and RightOf are a convenience for
+using the more general Set function.
+
+ Relationships
+
+ wx.Unconstrained The edge or dimension is unconstrained
+ (the default for edges.)
+ wx.AsIs The edge or dimension is to be taken from the current
+ window position or size (the default for dimensions.)
+ wx.Above The edge should be above another edge.
+ wx.Below The edge should be below another edge.
+ wx.LeftOf The edge should be to the left of another edge.
+ wx.RightOf The edge should be to the right of another edge.
+ wx.SameAs The edge or dimension should be the same as another edge
+ or dimension.
+ wx.PercentOf The edge or dimension should be a percentage of another
+ edge or dimension.
+ wx.Absolute The edge or dimension should be a given absolute value.
+
+</docstring>
<baseclass name="Object"/>
<method name="Set" type="" overloaded="no">
<autodoc>Set(int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)</autodoc>
</method>
<method name="LeftOf" type="" overloaded="no">
<autodoc>LeftOf(Window sibling, int marg=0)</autodoc>
+ <docstring>Sibling relationship</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</method>
<method name="RightOf" type="" overloaded="no">
<autodoc>RightOf(Window sibling, int marg=0)</autodoc>
+ <docstring>Sibling relationship</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</method>
<method name="Above" type="" overloaded="no">
<autodoc>Above(Window sibling, int marg=0)</autodoc>
+ <docstring>Sibling relationship</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</method>
<method name="Below" type="" overloaded="no">
<autodoc>Below(Window sibling, int marg=0)</autodoc>
+ <docstring>Sibling relationship</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</method>
<method name="SameAs" type="" overloaded="no">
<autodoc>SameAs(Window otherW, int edge, int marg=0)</autodoc>
+ <docstring>'Same edge' alignment</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
<param name="edge" type="wxEdge" default=""/>
</method>
<method name="PercentOf" type="" overloaded="no">
<autodoc>PercentOf(Window otherW, int wh, int per)</autodoc>
+ <docstring>The edge is a percentage of the other window's edge</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
<param name="wh" type="wxEdge" default=""/>
</method>
<method name="Absolute" type="" overloaded="no">
<autodoc>Absolute(int val)</autodoc>
+ <docstring>Edge has absolute value</docstring>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="Unconstrained" type="" overloaded="no">
<autodoc>Unconstrained()</autodoc>
+ <docstring>Dimension is unconstrained</docstring>
</method>
<method name="AsIs" type="" overloaded="no">
<autodoc>AsIs()</autodoc>
+ <docstring>Dimension is 'as is' (use current size settings)</docstring>
</method>
<method name="GetOtherWindow" type="Window" overloaded="no">
<autodoc>GetOtherWindow() -> Window</autodoc>
</method>
<method name="ResetIfWin" type="bool" overloaded="no">
<autodoc>ResetIfWin(Window otherW) -> bool</autodoc>
+ <docstring>Reset constraint if it mentions otherWin</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
</paramlist>
</method>
<method name="SatisfyConstraint" type="bool" overloaded="no">
<autodoc>SatisfyConstraint(LayoutConstraints constraints, Window win) -> bool</autodoc>
+ <docstring>Try to satisfy constraint</docstring>
<paramlist>
<param name="constraints" type="wxLayoutConstraints" default=""/>
<param name="win" type="Window" default=""/>
</method>
<method name="GetEdge" type="int" overloaded="no">
<autodoc>GetEdge(int which, Window thisWin, Window other) -> int</autodoc>
+ <docstring>Get the value of this edge or dimension, or if this
+is not determinable, -1.</docstring>
<paramlist>
<param name="which" type="wxEdge" default=""/>
<param name="thisWin" type="Window" default=""/>
</method>
</class>
<class name="LayoutConstraints" oldname="wxLayoutConstraints" module="core">
+ <docstring>Note: constraints are now deprecated and you should use sizers instead.
+
+Objects of this class can be associated with a window to define its layout
+constraints, with respect to siblings or its parent.
+
+The class consists of the following eight constraints of class
+wx.IndividualLayoutConstraint, some or all of which should be accessed
+directly to set the appropriate constraints.
+
+ * left: represents the left hand edge of the window
+ * right: represents the right hand edge of the window
+ * top: represents the top edge of the window
+ * bottom: represents the bottom edge of the window
+ * width: represents the width of the window
+ * height: represents the height of the window
+ * centreX: represents the horizontal centre point of the window
+ * centreY: represents the vertical centre point of the window
+
+Most constraints are initially set to have the relationship wxUnconstrained,
+which means that their values should be calculated by looking at known
+constraints. The exceptions are width and height, which are set to wxAsIs to
+ensure that if the user does not specify a constraint, the existing width and
+height will be used, to be compatible with panel items which often have take a
+default size. If the constraint is wxAsIs, the dimension will not be changed.
+</docstring>
<baseclass name="Object"/>
<constructor name="LayoutConstraints" overloaded="no">
<autodoc>__init__() -> LayoutConstraints</autodoc>
#---------------------------------------------------------------------------
</pythoncode>
<class name="Colour" oldname="wxColour" module="gdi">
+ <docstring>A colour is an object representing a combination of Red, Green, and Blue (RGB)
+intensity values, and is used to determine drawing colours, window colours,
+etc. Valid RGB values are in the range 0 to 255.
+
+In wxPython there are typemaps that will automatically convert from a colour
+name, or from a "#RRGGBB" colour hex value string to a wx.Colour object when
+calling C++ methods that expect a wxColour. This means that the following are
+all equivallent:
+
+ win.SetBackgroundColour(wxColour(0,0,255))
+ win.SetBackgroundColour("BLUE")
+ win.SetBackgroundColour("#0000FF")
+
+You can retrieve the various current system colour settings with
+wx.SystemSettings.GetColour.</docstring>
<baseclass name="Object"/>
<constructor name="Colour" overloaded="no">
<autodoc>__init__(unsigned char red=0, unsigned char green=0, unsigned char blue=0) -> Colour</autodoc>
+ <docstring>Constructs a colour from red, green and blue values.</docstring>
<paramlist>
<param name="red" type="unsigned char" default="0"/>
<param name="green" type="unsigned char" default="0"/>
</constructor>
<constructor name="NamedColour" overloaded="no">
<autodoc>NamedColour(String colorName) -> Colour</autodoc>
+ <docstring>Constructs a colour object using a colour name listed in wx.TheColourDatabase.</docstring>
<paramlist>
<param name="colorName" type="String" default=""/>
</paramlist>
</constructor>
<constructor name="ColourRGB" overloaded="no">
<autodoc>ColourRGB(unsigned long colRGB) -> Colour</autodoc>
+ <docstring>Constructs a colour from a packed RGB value.</docstring>
<paramlist>
<param name="colRGB" type="unsigned long" default=""/>
</paramlist>
</destructor>
<method name="Red" type="unsigned char" overloaded="no">
<autodoc>Red() -> unsigned char</autodoc>
+ <docstring>Returns the red intensity.</docstring>
</method>
<method name="Green" type="unsigned char" overloaded="no">
<autodoc>Green() -> unsigned char</autodoc>
+ <docstring>Returns the green intensity.</docstring>
</method>
<method name="Blue" type="unsigned char" overloaded="no">
<autodoc>Blue() -> unsigned char</autodoc>
+ <docstring>Returns the blue intensity.</docstring>
</method>
<method name="Ok" type="bool" overloaded="no">
<autodoc>Ok() -> bool</autodoc>
+ <docstring>Returns True if the colour object is valid (the colour has been
+initialised with RGB values).</docstring>
</method>
<method name="Set" type="" overloaded="no">
<autodoc>Set(unsigned char red, unsigned char green, unsigned char blue)</autodoc>
+ <docstring>Sets the RGB intensity values.</docstring>
<paramlist>
<param name="red" type="unsigned char" default=""/>
<param name="green" type="unsigned char" default=""/>
</method>
<method name="SetRGB" type="" overloaded="no">
<autodoc>SetRGB(unsigned long colRGB)</autodoc>
+ <docstring>Sets the RGB intensity values from a packed RGB value.</docstring>
<paramlist>
<param name="colRGB" type="unsigned long" default=""/>
</paramlist>
</method>
+ <method name="SetFromName" type="" overloaded="no">
+ <autodoc>SetFromName(String colourName)</autodoc>
+ <docstring>Sets the RGB intensity values using a colour name listed in wx.TheColourDatabase.</docstring>
+ <paramlist>
+ <param name="colourName" type="String" default=""/>
+ </paramlist>
+ </method>
+ <method name="GetPixel" type="long" overloaded="no">
+ <autodoc>GetPixel() -> long</autodoc>
+ <docstring>Returns a pixel value which is platform-dependent. On Windows, a
+COLORREF is returned. On X, an allocated pixel value is returned.
+-1 is returned if the pixel is invalid (on X, unallocated).</docstring>
+ </method>
<method name="__eq__" type="bool" overloaded="no">
<autodoc>__eq__(Colour colour) -> bool</autodoc>
+ <docstring>Compare colours for equality</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
<autodoc>__ne__(Colour colour) -> bool</autodoc>
+ <docstring>Compare colours for inequality</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
- <method name="InitFromName" type="" overloaded="no">
- <autodoc>InitFromName(String colourName)</autodoc>
- <paramlist>
- <param name="colourName" type="String" default=""/>
- </paramlist>
- </method>
<method name="Get" type="PyObject" overloaded="no">
- <autodoc>Get() -> PyObject</autodoc>
+ <autodoc>Get() -> (r, g, b)</autodoc>
+ <docstring>Returns the RGB intensity values as a tuple.</docstring>
+ </method>
+ <method name="GetRGB" type="unsigned long" overloaded="no">
+ <autodoc>GetRGB() -> unsigned long</autodoc>
+ <docstring>Return the colour as a packed RGB value</docstring>
</method>
</class>
<pythoncode>
<autodoc>GetDashes() -> PyObject</autodoc>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Pen pen) -> bool</autodoc>
+ <autodoc>__eq__(Pen other) -> bool</autodoc>
<paramlist>
- <param name="pen" type="Pen" default=""/>
+ <param name="other" type="Pen" default=""/>
+ </paramlist>
+ </method>
+ <method name="__ne__" type="bool" overloaded="no">
+ <autodoc>__ne__(Pen other) -> bool</autodoc>
+ <paramlist>
+ <param name="other" type="Pen" default=""/>
</paramlist>
</method>
<method name="GetDashCount" type="int" overloaded="no">
</method>
</class>
<class name="Cursor" oldname="wxCursor" module="gdi">
+ <docstring>A cursor is a small bitmap usually used for denoting where the
+mouse pointer is, with a picture that might indicate the
+interpretation of a mouse click.
+
+A single cursor object may be used in many windows (any subwindow
+type). The wxWindows convention is to set the cursor for a
+window, as in X, rather than to set it globally as in MS Windows,
+although a global wx.SetCursor function is also available for use
+on MS Windows.</docstring>
<baseclass name="GDIObject"/>
<constructor name="Cursor" overloaded="no">
- <autodoc>__init__(String cursorName, long flags, int hotSpotX=0, int hotSpotY=0) -> Cursor</autodoc>
+ <autodoc>__init__(String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor</autodoc>
+ <docstring>Construct a Cursor from a file. Specify the type of file using
+wx.BITAMP_TYPE* constants, and specify the hotspot if not using a
+.cur file.
+
+This cursor is not available on wxGTK, use wx.StockCursor,
+wx.CursorFromImage, or wx.CursorFromBits instead.</docstring>
<paramlist>
<param name="cursorName" type="String" default=""/>
- <param name="flags" type="long" default=""/>
+ <param name="type" type="long" default=""/>
<param name="hotSpotX" type="int" default="0"/>
<param name="hotSpotY" type="int" default="0"/>
</paramlist>
</constructor>
<constructor name="StockCursor" overloaded="no">
<autodoc>StockCursor(int id) -> Cursor</autodoc>
+ <docstring>Create a cursor using one of the stock cursors. Note that not
+all cursors are available on all platforms.</docstring>
+ <refdoc>
+ Stock Cursor IDs
+
+ wx.CURSOR_ARROW A standard arrow cursor.
+ wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right.
+ wx.CURSOR_BLANK Transparent cursor.
+ wx.CURSOR_BULLSEYE Bullseye cursor.
+ wx.CURSOR_CHAR Rectangular character cursor.
+ wx.CURSOR_CROSS A cross cursor.
+ wx.CURSOR_HAND A hand cursor.
+ wx.CURSOR_IBEAM An I-beam cursor (vertical line).
+ wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed.
+ wx.CURSOR_MAGNIFIER A magnifier icon.
+ wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed.
+ wx.CURSOR_NO_ENTRY A no-entry sign cursor.
+ wx.CURSOR_PAINT_BRUSH A paintbrush cursor.
+ wx.CURSOR_PENCIL A pencil cursor.
+ wx.CURSOR_POINT_LEFT A cursor that points left.
+ wx.CURSOR_POINT_RIGHT A cursor that points right.
+ wx.CURSOR_QUESTION_ARROW An arrow and question mark.
+ wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed.
+ wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW.
+ wx.CURSOR_SIZENS A sizing cursor pointing N-S.
+ wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE.
+ wx.CURSOR_SIZEWE A sizing cursor pointing W-E.
+ wx.CURSOR_SIZING A general sizing cursor.
+ wx.CURSOR_SPRAYCAN A spraycan cursor.
+ wx.CURSOR_WAIT A wait cursor.
+ wx.CURSOR_WATCH A watch cursor.
+ wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.)
+
+</refdoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</constructor>
<constructor name="CursorFromImage" overloaded="no">
<autodoc>CursorFromImage(Image image) -> Cursor</autodoc>
+ <docstring>Constructs a cursor from a wxImage. The cursor is monochrome,
+colors with the RGB elements all greater than 127 will be
+foreground, colors less than this background. The mask (if any)
+will be used as transparent.
+
+In MSW the foreground will be white and the background black. The
+cursor is resized to 32x32 In GTK, the two most frequent colors
+will be used for foreground and background. The cursor will be
+displayed at the size of the image. On MacOS the cursor is
+resized to 16x16 and currently only shown as black/white (mask
+respected).</docstring>
<paramlist>
<param name="image" type="Image" default=""/>
</paramlist>
</constructor>
- <constructor name="CursorFromBits" overloaded="no">
- <autodoc>CursorFromBits(PyObject bits, int width, int height, int hotSpotX=-1,
- int hotSpotY=-1, PyObject maskBits=0) -> Cursor</autodoc>
- <paramlist>
- <param name="bits" type="PyObject" default=""/>
- <param name="width" type="int" default=""/>
- <param name="height" type="int" default=""/>
- <param name="hotSpotX" type="int" default="-1"/>
- <param name="hotSpotY" type="int" default="-1"/>
- <param name="maskBits" type="PyObject" default="0"/>
- </paramlist>
- </constructor>
<destructor name="~wxCursor" overloaded="no">
<autodoc>__del__()</autodoc>
</destructor>
<autodoc>Ok() -> bool</autodoc>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Font font) -> bool</autodoc>
+ <autodoc>__eq__(Font other) -> bool</autodoc>
<paramlist>
- <param name="font" type="Font" default=""/>
+ <param name="other" type="Font" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Font font) -> bool</autodoc>
+ <autodoc>__ne__(Font other) -> bool</autodoc>
<paramlist>
- <param name="font" type="Font" default=""/>
+ <param name="other" type="Font" default=""/>
</paramlist>
</method>
<method name="GetPointSize" type="int" overloaded="no">
</constructor>
<constructor name="BufferedDC" overloaded="yes">
<autodoc>__init__(DC dc, Bitmap buffer) -> BufferedDC
-__init__(DC dc, Size area, int flags=BUFFER_DC_DEFAULT) -> BufferedDC</autodoc>
+__init__(DC dc, Size area) -> BufferedDC</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="area" type="Size" default=""/>
- <param name="flags" type="int" default="wxBUFFER_DC_DEFAULT"/>
</paramlist>
</constructor>
<constructor name="BufferedDCInternalBuffer" overloaded="no">
- <autodoc>BufferedDCInternalBuffer(DC dc, Size area, int flags=BUFFER_DC_DEFAULT) -> BufferedDC</autodoc>
+ <autodoc>BufferedDCInternalBuffer(DC dc, Size area) -> BufferedDC</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="area" type="Size" default=""/>
- <param name="flags" type="int" default="wxBUFFER_DC_DEFAULT"/>
</paramlist>
</constructor>
+ <destructor name="~wxBufferedDC" overloaded="no">
+ <autodoc>__del__()</autodoc>
+ </destructor>
<method name="UnMask" type="" overloaded="no">
<autodoc>UnMask()</autodoc>
</method>
</class>
<class name="BufferedPaintDC" oldname="wxBufferedPaintDC" module="gdi">
<baseclass name="BufferedDC"/>
- <constructor name="BufferedPaintDC" overloaded="yes">
+ <constructor name="BufferedPaintDC" overloaded="no">
+ <autodoc>__init__(Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC</autodoc>
<paramlist>
<param name="window" type="Window" default=""/>
- <param name="buffer" type="Bitmap" default=""/>
- </paramlist>
- </constructor>
- <constructor name="BufferedPaintDC" overloaded="yes">
- <autodoc>__init__(Window window, Bitmap buffer) -> BufferedPaintDC
-__init__(Window window, int flags=BUFFER_DC_DEFAULT) -> BufferedPaintDC</autodoc>
- <paramlist>
- <param name="window" type="Window" default=""/>
- <param name="flags" type="int" default="wxBUFFER_DC_DEFAULT"/>
+ <param name="buffer" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</constructor>
</class>
<autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxTAB_TRAVERSAL|wxNO_BORDER,
String name=PanelNameStr) -> bool</autodoc>
+ <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
<autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL,
String name=PanelNameStr) -> bool</autodoc>
+ <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
</method>
<method name="SetTitle" type="" overloaded="no">
<autodoc>SetTitle(String title)</autodoc>
+ <docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
<autodoc>GetTitle() -> String</autodoc>
+ <docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring>
</method>
<method name="SetShape" type="bool" overloaded="no">
<autodoc>SetShape(Region region) -> bool</autodoc>
</method>
<method name="GetClientAreaOrigin" type="Point" overloaded="no">
<autodoc>GetClientAreaOrigin() -> Point</autodoc>
+ <docstring>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...)</docstring>
</method>
<method name="SendSizeEvent" type="" overloaded="no">
<autodoc>SendSizeEvent()</autodoc>
</method>
<method name="ScrollLines" type="bool" overloaded="no">
<autodoc>ScrollLines(int lines) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="lines" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollPages" type="bool" overloaded="no">
<autodoc>ScrollPages(int pages) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="pages" type="int" default=""/>
</paramlist>
</method>
<method name="HitTestXT" type="int" overloaded="no">
<autodoc>HitTestXT(int x, int y) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="HitTest" type="int" overloaded="no">
<autodoc>HitTest(Point pt) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ColourData" oldname="wxColourData" module="windows">
+ <docstring>This class holds a variety of information related to colour dialogs.</docstring>
<baseclass name="Object"/>
<constructor name="ColourData" overloaded="no">
<autodoc>__init__() -> ColourData</autodoc>
+ <docstring>Constructor, sets default values.</docstring>
</constructor>
<destructor name="~wxColourData" overloaded="no">
<autodoc>__del__()</autodoc>
</destructor>
<method name="GetChooseFull" type="bool" overloaded="no">
<autodoc>GetChooseFull() -> bool</autodoc>
+ <docstring>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.</docstring>
</method>
<method name="GetColour" type="Colour" overloaded="no">
<autodoc>GetColour() -> Colour</autodoc>
+ <docstring>Gets the colour (pre)selected by the dialog.</docstring>
</method>
<method name="GetCustomColour" type="Colour" overloaded="no">
<autodoc>GetCustomColour(int i) -> Colour</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="SetChooseFull" type="" overloaded="no">
<autodoc>SetChooseFull(int flag)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="flag" type="int" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
<autodoc>SetColour(Colour colour)</autodoc>
+ <docstring>Sets the default colour for the colour dialog. The default colour is black.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCustomColour" type="" overloaded="no">
<autodoc>SetCustomColour(int i, Colour colour)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="i" type="int" default=""/>
<param name="colour" type="Colour" default=""/>
</method>
</class>
<class name="ColourDialog" oldname="wxColourDialog" module="windows">
+ <docstring>This class represents the colour chooser dialog.</docstring>
<baseclass name="Dialog"/>
<constructor name="ColourDialog" overloaded="no">
<autodoc>__init__(Window parent, ColourData data=None) -> ColourDialog</autodoc>
+ <docstring>Constructor. Pass a parent window, and optionally a ColourData, which
+will be copied to the colour dialog's internal ColourData instance.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="ColourData" default="NULL"/>
</constructor>
<method name="GetColourData" type="ColourData" overloaded="no">
<autodoc>GetColourData() -> ColourData</autodoc>
- </method>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
+ <docstring>Returns a reference to the ColourData used by the dialog.</docstring>
</method>
</class>
<class name="DirDialog" oldname="wxDirDialog" module="windows">
+ <docstring>This class represents the directory chooser dialog.</docstring>
+ <refdoc>
+ Styles
+ wxDD_NEW_DIR_BUTTON Add "Create new directory" button and allow
+ directory names to be editable. On Windows the new
+ directory button is only available with recent
+ versions of the common dialogs.</refdoc>
<baseclass name="Dialog"/>
<constructor name="DirDialog" overloaded="no">
<autodoc>__init__(Window parent, String message=DirSelectorPromptStr,
String defaultPath=EmptyString, long style=0,
Point pos=DefaultPosition, Size size=DefaultSize,
String name=DirDialogNameStr) -> DirDialog</autodoc>
+ <docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
+ <refdoc>
+ Styles
+ wxDD_NEW_DIR_BUTTON Add "Create new directory" button and allow
+ directory names to be editable. On Windows the new
+ directory button is only available with recent
+ versions of the common dialogs.</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default="wxPyDirSelectorPromptStr"/>
</constructor>
<method name="GetPath" type="String" overloaded="no">
<autodoc>GetPath() -> String</autodoc>
+ <docstring>Returns the default or user-selected path.</docstring>
</method>
<method name="GetMessage" type="String" overloaded="no">
<autodoc>GetMessage() -> String</autodoc>
+ <docstring>Returns the message that will be displayed on the dialog.</docstring>
</method>
<method name="GetStyle" type="long" overloaded="no">
<autodoc>GetStyle() -> long</autodoc>
+ <docstring>Returns the dialog style.</docstring>
</method>
<method name="SetMessage" type="" overloaded="no">
<autodoc>SetMessage(String message)</autodoc>
+ <docstring>Sets the message that will be displayed on the dialog.</docstring>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="SetPath" type="" overloaded="no">
<autodoc>SetPath(String path)</autodoc>
+ <docstring>Sets the default path.</docstring>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
- </method>
</class>
<class name="FileDialog" oldname="wxFileDialog" module="windows">
+ <docstring>This class represents the file chooser dialog.</docstring>
+ <refdoc>
+In Windows, this is the common file selector dialog. In X, this is a file
+selector box with somewhat less functionality. The path and filename are
+distinct elements of a full file pathname. If path is "", the current
+directory will be used. If filename is "", no default filename will be
+supplied. The wildcard determines what files are displayed in the file
+selector, and file extension supplies a type extension for the required
+filename.
+
+Both the X and Windows versions implement a wildcard filter. Typing a filename
+containing wildcards (*, ?) in the filename text item, and clicking on Ok,
+will result in only those files matching the pattern being displayed. The
+wildcard may be a specification for multiple types of file with a description
+for each, such as:
+
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
+
+ Styles
+ wx.OPEN This is an open dialog.
+
+ wx.SAVE This is a save dialog.
+
+ wx.HIDE_READONLY For open dialog only: hide the checkbox allowing to
+ open the file in read-only mode.
+
+ wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation if a
+ file will be overwritten.
+
+ wx.MULTIPLE For open dialog only: allows selecting multiple files.
+
+ wx.CHANGE_DIR Change the current working directory to the directory
+ where the file(s) chosen by the user are.
+</refdoc>
<baseclass name="Dialog"/>
<constructor name="FileDialog" overloaded="no">
<autodoc>__init__(Window parent, String message=FileSelectorPromptStr,
String defaultDir=EmptyString, String defaultFile=EmptyString,
String wildcard=FileSelectorDefaultWildcardStr,
long style=0, Point pos=DefaultPosition) -> FileDialog</autodoc>
+ <docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
+ <refdoc>
+In Windows, this is the common file selector dialog. In X, this is a file
+selector box with somewhat less functionality. The path and filename are
+distinct elements of a full file pathname. If path is "", the current
+directory will be used. If filename is "", no default filename will be
+supplied. The wildcard determines what files are displayed in the file
+selector, and file extension supplies a type extension for the required
+filename.
+
+Both the X and Windows versions implement a wildcard filter. Typing a filename
+containing wildcards (*, ?) in the filename text item, and clicking on Ok,
+will result in only those files matching the pattern being displayed. The
+wildcard may be a specification for multiple types of file with a description
+for each, such as:
+
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
+
+ Styles
+ wx.OPEN This is an open dialog.
+
+ wx.SAVE This is a save dialog.
+
+ wx.HIDE_READONLY For open dialog only: hide the checkbox allowing to
+ open the file in read-only mode.
+
+ wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation if a
+ file will be overwritten.
+
+ wx.MULTIPLE For open dialog only: allows selecting multiple files.
+
+ wx.CHANGE_DIR Change the current working directory to the directory
+ where the file(s) chosen by the user are.
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default="wxPyFileSelectorPromptStr"/>
</constructor>
<method name="SetMessage" type="" overloaded="no">
<autodoc>SetMessage(String message)</autodoc>
+ <docstring>Sets the message that will be displayed on the dialog.</docstring>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="SetPath" type="" overloaded="no">
<autodoc>SetPath(String path)</autodoc>
+ <docstring>Sets the path (the combined directory and filename that will
+be returned when the dialog is dismissed).</docstring>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="SetDirectory" type="" overloaded="no">
<autodoc>SetDirectory(String dir)</autodoc>
+ <docstring>Sets the default directory.</docstring>
<paramlist>
<param name="dir" type="String" default=""/>
</paramlist>
</method>
<method name="SetFilename" type="" overloaded="no">
<autodoc>SetFilename(String name)</autodoc>
+ <docstring>Sets the default filename.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetWildcard" type="" overloaded="no">
<autodoc>SetWildcard(String wildCard)</autodoc>
+ <docstring>Sets the wildcard, which can contain multiple file types, for example:
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"</docstring>
<paramlist>
<param name="wildCard" type="String" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
<autodoc>SetStyle(long style)</autodoc>
+ <docstring>Sets the dialog style.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="SetFilterIndex" type="" overloaded="no">
<autodoc>SetFilterIndex(int filterIndex)</autodoc>
+ <docstring>Sets the default filter index, starting from zero.</docstring>
<paramlist>
<param name="filterIndex" type="int" default=""/>
</paramlist>
</method>
<method name="GetMessage" type="String" overloaded="no">
<autodoc>GetMessage() -> String</autodoc>
+ <docstring>Returns the message that will be displayed on the dialog.</docstring>
</method>
<method name="GetPath" type="String" overloaded="no">
<autodoc>GetPath() -> String</autodoc>
+ <docstring>Returns the full path (directory and filename) of the selected file.</docstring>
</method>
<method name="GetDirectory" type="String" overloaded="no">
<autodoc>GetDirectory() -> String</autodoc>
+ <docstring>Returns the default directory.</docstring>
</method>
<method name="GetFilename" type="String" overloaded="no">
<autodoc>GetFilename() -> String</autodoc>
+ <docstring>Returns the default filename.</docstring>
</method>
<method name="GetWildcard" type="String" overloaded="no">
<autodoc>GetWildcard() -> String</autodoc>
+ <docstring>Returns the file dialog wildcard.</docstring>
</method>
<method name="GetStyle" type="long" overloaded="no">
<autodoc>GetStyle() -> long</autodoc>
+ <docstring>Returns the dialog style.</docstring>
</method>
<method name="GetFilterIndex" type="int" overloaded="no">
<autodoc>GetFilterIndex() -> int</autodoc>
+ <docstring>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.</docstring>
</method>
<method name="GetFilenames" type="PyObject" overloaded="no">
<autodoc>GetFilenames() -> PyObject</autodoc>
+ <docstring>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.</docstring>
</method>
<method name="GetPaths" type="PyObject" overloaded="no">
<autodoc>GetPaths() -> PyObject</autodoc>
+ <docstring>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.</docstring>
</method>
</class>
<class name="MultiChoiceDialog" oldname="wxMultiChoiceDialog" module="windows">
+ <docstring>A simple dialog with a multi selection listbox.</docstring>
<baseclass name="Dialog"/>
<constructor name="MultiChoiceDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message, String caption, int choices=0,
- String choices_array, long style=CHOICEDLG_STYLE,
+ <autodoc>__init__(Window parent, String message, String caption,
+ List choices=[], long style=CHOICEDLG_STYLE,
Point pos=DefaultPosition) -> MultiChoiceDialog</autodoc>
+ <docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default=""/>
</paramlist>
</constructor>
<method name="SetSelections" type="" overloaded="no">
- <autodoc>SetSelections(wxArrayInt selections)</autodoc>
+ <autodoc>SetSelections(List selections)</autodoc>
+ <docstring>Specify the items in the list that shoudl be selected, using a list of integers.</docstring>
<paramlist>
<param name="selections" type="wxArrayInt" default=""/>
</paramlist>
</method>
<method name="GetSelections" type="PyObject" overloaded="no">
- <autodoc>GetSelections() -> PyObject</autodoc>
+ <autodoc>GetSelections() -> [selections]</autodoc>
+ <docstring>Returns a list of integers representing the items that are selected.</docstring>
</method>
</class>
<class name="SingleChoiceDialog" oldname="wxSingleChoiceDialog" module="windows">
+ <docstring>A simple dialog with a single selection listbox.</docstring>
<baseclass name="Dialog"/>
<constructor name="SingleChoiceDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message, String caption, int choices,
- String choices_array, long style=CHOICEDLG_STYLE,
+ <autodoc>__init__(Window parent, String message, String caption,
+ List choices=[], long style=CHOICEDLG_STYLE,
Point pos=DefaultPosition) -> SingleChoiceDialog</autodoc>
+ <docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default=""/>
</constructor>
<method name="GetSelection" type="int" overloaded="no">
<autodoc>GetSelection() -> int</autodoc>
+ <docstring>Get the index of teh currently selected item.</docstring>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
<autodoc>GetStringSelection() -> String</autodoc>
+ <docstring>Returns the string value of the currently selected item</docstring>
</method>
<method name="SetSelection" type="" overloaded="no">
<autodoc>SetSelection(int sel)</autodoc>
+ <docstring>Set the current selected item to sel</docstring>
<paramlist>
<param name="sel" type="int" default=""/>
</paramlist>
</method>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
- </method>
</class>
<class name="TextEntryDialog" oldname="wxTextEntryDialog" module="windows">
+ <docstring>A dialog with text control, [ok] and [cancel] buttons</docstring>
<baseclass name="Dialog"/>
<constructor name="TextEntryDialog" overloaded="no">
<autodoc>__init__(Window parent, String message, String caption=GetTextFromUserPromptStr,
String defaultValue=EmptyString,
long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog</autodoc>
+ <docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default=""/>
</constructor>
<method name="GetValue" type="String" overloaded="no">
<autodoc>GetValue() -> String</autodoc>
+ <docstring>Returns the text that the user has entered if the user has pressed OK,
+or the original value if the user has pressed Cancel.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
<autodoc>SetValue(String value)</autodoc>
+ <docstring>Sets the default text value.</docstring>
<paramlist>
<param name="value" type="String" default=""/>
</paramlist>
</method>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
- </method>
</class>
<class name="FontData" oldname="wxFontData" module="windows">
+ <docstring>This class holds a variety of information related to font dialogs.</docstring>
<baseclass name="Object"/>
<constructor name="FontData" overloaded="no">
<autodoc>__init__() -> FontData</autodoc>
+ <docstring>This class holds a variety of information related to font dialogs.</docstring>
</constructor>
<destructor name="~wxFontData" overloaded="no">
<autodoc>__del__()</autodoc>
</destructor>
<method name="EnableEffects" type="" overloaded="no">
<autodoc>EnableEffects(bool enable)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="GetAllowSymbols" type="bool" overloaded="no">
<autodoc>GetAllowSymbols() -> bool</autodoc>
+ <docstring>Under MS Windows, returns a flag determining whether symbol fonts can be
+selected. Has no effect on other platforms. The default value is true.</docstring>
</method>
<method name="GetColour" type="Colour" overloaded="no">
<autodoc>GetColour() -> Colour</autodoc>
+ <docstring>Gets the colour associated with the font dialog. The default value is black.</docstring>
</method>
<method name="GetChosenFont" type="Font" overloaded="no">
<autodoc>GetChosenFont() -> Font</autodoc>
+ <docstring>Gets the font chosen by the user.</docstring>
</method>
<method name="GetEnableEffects" type="bool" overloaded="no">
<autodoc>GetEnableEffects() -> bool</autodoc>
+ <docstring>Determines whether 'effects' are enabled under Windows.</docstring>
</method>
<method name="GetInitialFont" type="Font" overloaded="no">
<autodoc>GetInitialFont() -> Font</autodoc>
+ <docstring>Gets the font that will be initially used by the font dialog. This should have
+previously been set by the application.</docstring>
</method>
<method name="GetShowHelp" type="bool" overloaded="no">
<autodoc>GetShowHelp() -> bool</autodoc>
+ <docstring>Returns true if the Help button will be shown (Windows only). The default
+value is false.</docstring>
</method>
<method name="SetAllowSymbols" type="" overloaded="no">
<autodoc>SetAllowSymbols(bool allowSymbols)</autodoc>
+ <docstring>Under MS Windows, determines whether symbol fonts can be selected. Has no
+effect on other platforms. The default value is true.</docstring>
<paramlist>
<param name="allowSymbols" type="bool" default=""/>
</paramlist>
</method>
<method name="SetChosenFont" type="" overloaded="no">
<autodoc>SetChosenFont(Font font)</autodoc>
+ <docstring>Sets the font that will be returned to the user (for internal use only).</docstring>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
<autodoc>SetColour(Colour colour)</autodoc>
+ <docstring>Sets the colour that will be used for the font foreground colour. The default
+colour is black.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetInitialFont" type="" overloaded="no">
<autodoc>SetInitialFont(Font font)</autodoc>
+ <docstring>Sets the font that will be initially used by the font dialog.</docstring>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
<autodoc>SetRange(int min, int max)</autodoc>
+ <docstring>Sets the valid range for the font point size (Windows only). The default is
+0, 0 (unrestricted range).</docstring>
<paramlist>
<param name="min" type="int" default=""/>
<param name="max" type="int" default=""/>
</method>
<method name="SetShowHelp" type="" overloaded="no">
<autodoc>SetShowHelp(bool showHelp)</autodoc>
+ <docstring>Determines whether the Help button will be displayed in the font dialog
+(Windows only). The default value is false.</docstring>
<paramlist>
<param name="showHelp" type="bool" default=""/>
</paramlist>
</method>
</class>
<class name="FontDialog" oldname="wxFontDialog" module="windows">
+ <docstring>This class represents the font chooser dialog.</docstring>
<baseclass name="Dialog"/>
<constructor name="FontDialog" overloaded="no">
<autodoc>__init__(Window parent, FontData data) -> FontDialog</autodoc>
+ <docstring>Constructor. Pass a parent window and the FontData object to be
+used to initialize the dialog controls.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="FontData" default=""/>
</constructor>
<method name="GetFontData" type="FontData" overloaded="no">
<autodoc>GetFontData() -> FontData</autodoc>
- </method>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
+ <docstring>Returns a reference to the internal FontData used by the FontDialog.</docstring>
</method>
</class>
<class name="MessageDialog" oldname="wxMessageDialog" module="windows">
+ <docstring>This class provides a dialog that shows a single or multi-line message, with
+a choice of OK, Yes, No and Cancel buttons.</docstring>
+ <refdoc>
+ Styles
+ wx.OK: Show an OK button.
+
+ wx.CANCEL: Show a Cancel button.
+
+ wx.YES_NO: Show Yes and No buttons.
+
+ wx.YES_DEFAULT: Used with wxYES_NO, makes Yes button the default - which is the default behaviour.
+
+ wx.NO_DEFAULT: Used with wxYES_NO, makes No button the default.
+
+ wx.ICON_EXCLAMATION: Shows an exclamation mark icon.
+
+ wx.ICON_HAND: Shows an error icon.
+
+ wx.ICON_ERROR: Shows an error icon - the same as wxICON_HAND.
+
+ wx.ICON_QUESTION: Shows a question mark icon.
+
+ wx.ICON_INFORMATION: Shows an information (i) icon.
+
+ wx.STAY_ON_TOP: The message box stays on top of all other window, even those of the other applications (Windows only).
+</refdoc>
<baseclass name="Dialog"/>
<constructor name="MessageDialog" overloaded="no">
<autodoc>__init__(Window parent, String message, String caption=MessageBoxCaptionStr,
long style=wxOK|wxCANCEL|wxCENTRE,
Point pos=DefaultPosition) -> MessageDialog</autodoc>
+ <docstring>This class provides a dialog that shows a single or multi-line message, with
+a choice of OK, Yes, No and Cancel buttons.</docstring>
+ <refdoc>
+ Styles
+ wx.OK: Show an OK button.
+
+ wx.CANCEL: Show a Cancel button.
+
+ wx.YES_NO: Show Yes and No buttons.
+
+ wx.YES_DEFAULT: Used with wxYES_NO, makes Yes button the default - which is the default behaviour.
+
+ wx.NO_DEFAULT: Used with wxYES_NO, makes No button the default.
+
+ wx.ICON_EXCLAMATION: Shows an exclamation mark icon.
+
+ wx.ICON_HAND: Shows an error icon.
+
+ wx.ICON_ERROR: Shows an error icon - the same as wxICON_HAND.
+
+ wx.ICON_QUESTION: Shows a question mark icon.
+
+ wx.ICON_INFORMATION: Shows an information (i) icon.
+
+ wx.STAY_ON_TOP: The message box stays on top of all other window, even those of the other applications (Windows only).
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default=""/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
</paramlist>
</constructor>
- <method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
- </method>
</class>
<class name="ProgressDialog" oldname="wxProgressDialog" module="windows">
+ <docstring>A dialog that shows a short message and a progress bar. Optionally, it can
+display an ABORT button.</docstring>
+ <refdoc>
+ Styles
+
+ wx.PD_APP_MODAL: Make the progress dialog modal. If this flag is
+ not given, it is only "locally" modal - that is
+ the input to the parent window is disabled,
+ but not to the other ones.
+
+ wx.PD_AUTO_HIDE: Causes the progress dialog to disappear from screen
+ as soon as the maximum value of the progress
+ meter has been reached.
+
+ wx.PD_CAN_ABORT: This flag tells the dialog that it should have
+ a "Cancel" button which the user may press. If
+ this happens, the next call to Update() will
+ return false.
+
+ wx.PD_ELAPSED_TIME: This flag tells the dialog that it should show
+ elapsed time (since creating the dialog).
+
+ wx.PD_ESTIMATED_TIME: This flag tells the dialog that it should show
+ estimated time.
+
+ wx.PD_REMAINING_TIME: This flag tells the dialog that it should show
+ remaining time.
+</refdoc>
<baseclass name="Frame"/>
<constructor name="ProgressDialog" overloaded="no">
<autodoc>__init__(String title, String message, int maximum=100, Window parent=None,
int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog</autodoc>
+ <docstring>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.</docstring>
+ <refdoc>
+ Styles
+
+ wx.PD_APP_MODAL: Make the progress dialog modal. If this flag is
+ not given, it is only "locally" modal - that is
+ the input to the parent window is disabled,
+ but not to the other ones.
+
+ wx.PD_AUTO_HIDE: Causes the progress dialog to disappear from screen
+ as soon as the maximum value of the progress
+ meter has been reached.
+
+ wx.PD_CAN_ABORT: This flag tells the dialog that it should have
+ a "Cancel" button which the user may press. If
+ this happens, the next call to Update() will
+ return false.
+
+ wx.PD_ELAPSED_TIME: This flag tells the dialog that it should show
+ elapsed time (since creating the dialog).
+
+ wx.PD_ESTIMATED_TIME: This flag tells the dialog that it should show
+ estimated time.
+
+ wx.PD_REMAINING_TIME: This flag tells the dialog that it should show
+ remaining time.
+</refdoc>
<paramlist>
<param name="title" type="String" default=""/>
<param name="message" type="String" default=""/>
</constructor>
<method name="Update" type="bool" overloaded="no">
<autodoc>Update(int value, String newmsg=EmptyString) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="value" type="int" default=""/>
<param name="newmsg" type="String" default="wxPyEmptyString"/>
</method>
<method name="Resume" type="" overloaded="no">
<autodoc>Resume()</autodoc>
+ <docstring>Can be used to continue with the dialog, after the user had chosen to abort.</docstring>
</method>
</class>
<pythoncode>
EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE
</pythoncode>
<class name="FindDialogEvent" oldname="wxFindDialogEvent" module="windows">
+ <docstring>Events for the FindReplaceDialog</docstring>
<baseclass name="CommandEvent"/>
<constructor name="FindDialogEvent" overloaded="no">
<autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent</autodoc>
+ <docstring>Events for the FindReplaceDialog</docstring>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="id" type="int" default="0"/>
</constructor>
<method name="GetFlags" type="int" overloaded="no">
<autodoc>GetFlags() -> int</autodoc>
+ <docstring>Get the currently selected flags: this is the combination of
+wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.</docstring>
</method>
<method name="GetFindString" type="String" overloaded="no">
<autodoc>GetFindString() -> String</autodoc>
+ <docstring>Return the string to find (never empty).</docstring>
</method>
<method name="GetReplaceString" type="String" overloaded="no">
<autodoc>GetReplaceString() -> String</autodoc>
+ <docstring>Return the string to replace the search string with (only
+for replace and replace all events).</docstring>
</method>
<method name="GetDialog" type="wxFindReplaceDialog" overloaded="no">
<autodoc>GetDialog() -> FindReplaceDialog</autodoc>
+ <docstring>Return the pointer to the dialog which generated this event.</docstring>
</method>
<method name="SetFlags" type="" overloaded="no">
<autodoc>SetFlags(int flags)</autodoc>
</method>
</class>
<class name="FindReplaceData" oldname="wxFindReplaceData" module="windows">
+ <docstring>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)
+</docstring>
<baseclass name="Object"/>
<constructor name="FindReplaceData" overloaded="no">
<autodoc>__init__(int flags=0) -> FindReplaceData</autodoc>
+ <docstring>Constuctor initializes the flags to default value (0).</docstring>
<paramlist>
<param name="flags" type="int" default="0"/>
</paramlist>
</destructor>
<method name="GetFindString" type="String" overloaded="no">
<autodoc>GetFindString() -> String</autodoc>
+ <docstring>Get the string to find.</docstring>
</method>
<method name="GetReplaceString" type="String" overloaded="no">
<autodoc>GetReplaceString() -> String</autodoc>
+ <docstring>Get the replacement string.</docstring>
</method>
<method name="GetFlags" type="int" overloaded="no">
<autodoc>GetFlags() -> int</autodoc>
+ <docstring>Get the combination of flag values.</docstring>
</method>
<method name="SetFlags" type="" overloaded="no">
<autodoc>SetFlags(int flags)</autodoc>
+ <docstring>Set the flags to use to initialize the controls of the dialog.</docstring>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="SetFindString" type="" overloaded="no">
<autodoc>SetFindString(String str)</autodoc>
+ <docstring>Set the string to find (used as initial value by the dialog).</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="SetReplaceString" type="" overloaded="no">
<autodoc>SetReplaceString(String str)</autodoc>
+ <docstring>Set the replacement string (used as initial value by the dialog).</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
</class>
<class name="FindReplaceDialog" oldname="wxFindReplaceDialog" module="windows">
+ <docstring>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.</docstring>
+ <refdoc>
+ Styles
+ wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog)
+
+ wx.FR_NOUPDOWN: don't allow changing the search direction
+
+ wx.FR_NOMATCHCASE: don't allow case sensitive searching
+
+ wx.FR_NOWHOLEWORD: don't allow whole word searching
+</refdoc>
<baseclass name="Dialog"/>
<constructor name="FindReplaceDialog" overloaded="no">
<autodoc>__init__(Window parent, FindReplaceData data, String title,
int style=0) -> FindReplaceDialog</autodoc>
+ <docstring>Create a FindReplaceDialog. The parent and data parameters must be
+non-None. Use Show to display the dialog.</docstring>
+ <refdoc>
+ Styles
+ wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog)
+
+ wx.FR_NOUPDOWN: don't allow changing the search direction
+
+ wx.FR_NOMATCHCASE: don't allow case sensitive searching
+
+ wx.FR_NOWHOLEWORD: don't allow whole word searching
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="FindReplaceData" default=""/>
</constructor>
<constructor name="PreFindReplaceDialog" overloaded="no">
<autodoc>PreFindReplaceDialog() -> FindReplaceDialog</autodoc>
+ <docstring>Precreate a FindReplaceDialog for 2-phase creation</docstring>
+ <refdoc>
+ Styles
+ wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog)
+
+ wx.FR_NOUPDOWN: don't allow changing the search direction
+
+ wx.FR_NOMATCHCASE: don't allow case sensitive searching
+
+ wx.FR_NOWHOLEWORD: don't allow whole word searching
+</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
<autodoc>Create(Window parent, FindReplaceData data, String title,
int style=0) -> bool</autodoc>
+ <docstring>Create the dialog, for 2-phase create.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="FindReplaceData" default=""/>
</method>
<method name="GetData" type="FindReplaceData" overloaded="no">
<autodoc>GetData() -> FindReplaceData</autodoc>
+ <docstring>Get the FindReplaceData object used by this dialog.</docstring>
</method>
<method name="SetData" type="" overloaded="no">
<autodoc>SetData(FindReplaceData data)</autodoc>
+ <docstring>Set the FindReplaceData object used by this dialog.</docstring>
<paramlist>
<param name="data" type="FindReplaceData" default=""/>
</paramlist>
#---------------------------------------------------------------------------
</pythoncode>
<class name="CheckBox" oldname="wxCheckBox" module="controls">
+ <docstring>A checkbox is a labelled box which by default is either on (checkmark is
+visible) or off (no checkmark). Optionally (When the wxCHK_3STATE style flag
+is set) it can have a third state, called the mixed or undetermined
+state. Often this is used as a "Does Not Apply" state.</docstring>
+ <refdoc>
+ Styles
+ wx.CHK_2STATE: Create a 2-state checkbox. This is the default.
+ wx.CHK_3STATE: Create a 3-state checkbox.
+ wx.CHK_ALLOW_3RD_STATE_FOR_USER: By default a user can't set a 3-state
+ checkbox to the third state. It can only
+ be done from code. Using this flags
+ allows the user to set the checkbox to
+ the third state by clicking.
+ wx.ALIGN_RIGHT: Makes the text appear on the left of the checkbox.
+
+ Events
+ EVT_CHECKBOX: Sent when checkbox is clicked.
+</refdoc>
<baseclass name="Control"/>
<constructor name="CheckBox" overloaded="no">
<autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0,
Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox</autodoc>
+ <docstring>Creates and shows a CheckBox control</docstring>
+ <refdoc>
+ Styles
+ wx.CHK_2STATE: Create a 2-state checkbox. This is the default.
+ wx.CHK_3STATE: Create a 3-state checkbox.
+ wx.CHK_ALLOW_3RD_STATE_FOR_USER: By default a user can't set a 3-state
+ checkbox to the third state. It can only
+ be done from code. Using this flags
+ allows the user to set the checkbox to
+ the third state by clicking.
+ wx.ALIGN_RIGHT: Makes the text appear on the left of the checkbox.
+
+ Events
+ EVT_CHECKBOX: Sent when checkbox is clicked.
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreCheckBox" overloaded="no">
<autodoc>PreCheckBox() -> CheckBox</autodoc>
+ <docstring>Precreate a CheckBox for 2-phase creation.</docstring>
+ <refdoc>
+ Styles
+ wx.CHK_2STATE: Create a 2-state checkbox. This is the default.
+ wx.CHK_3STATE: Create a 3-state checkbox.
+ wx.CHK_ALLOW_3RD_STATE_FOR_USER: By default a user can't set a 3-state
+ checkbox to the third state. It can only
+ be done from code. Using this flags
+ allows the user to set the checkbox to
+ the third state by clicking.
+ wx.ALIGN_RIGHT: Makes the text appear on the left of the checkbox.
+
+ Events
+ EVT_CHECKBOX: Sent when checkbox is clicked.
+</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
<autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0,
Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> bool</autodoc>
+ <docstring>Actually create the GUI CheckBox for 2-phase creation.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</method>
<method name="GetValue" type="bool" overloaded="no">
<autodoc>GetValue() -> bool</autodoc>
+ <docstring>Gets the state of a 2-state CheckBox. Returns True if it is checked,
+False otherwise.</docstring>
</method>
<method name="IsChecked" type="bool" overloaded="no">
<autodoc>IsChecked() -> bool</autodoc>
+ <docstring>Similar to GetValue, but raises an exception if it is not a 2-state CheckBox.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
<autodoc>SetValue(bool state)</autodoc>
+ <docstring>Set the state of a 2-state CheckBox. Pass True for checked,
+False for unchecked.</docstring>
<paramlist>
<param name="state" type="bool" default=""/>
</paramlist>
</method>
<method name="Get3StateValue" type="wxCheckBoxState" overloaded="no">
<autodoc>Get3StateValue() -> int</autodoc>
+ <docstring>Returns wx.CHK_UNCHECKED when the CheckBox is unchecked, wx.CHK_CHECKED when
+it is checked and wx.CHK_UNDETERMINED when it's in the undetermined state.
+Raises an exceptiion when the function is used with a 2-state CheckBox.</docstring>
</method>
<method name="Set3StateValue" type="" overloaded="no">
<autodoc>Set3StateValue(int state)</autodoc>
+ <docstring>Sets the CheckBox to the given state. The state parameter can be
+one of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED
+(Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
+exception when the CheckBox is a 2-state checkbox and setting the state
+to wx.CHK_UNDETERMINED.</docstring>
<paramlist>
<param name="state" type="wxCheckBoxState" default=""/>
</paramlist>
</method>
<method name="Is3State" type="bool" overloaded="no">
<autodoc>Is3State() -> bool</autodoc>
+ <docstring>Returns whether or not the CheckBox is a 3-state CheckBox.</docstring>
</method>
<method name="Is3rdStateAllowedForUser" type="bool" overloaded="no">
<autodoc>Is3rdStateAllowedForUser() -> bool</autodoc>
+ <docstring>Returns whether or not the user can set the CheckBox to the third state.</docstring>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
<class name="Choice" oldname="wxChoice" module="controls">
+ <docstring>A Choice control is used to select one of a list of strings. Unlike a ListBox,
+only the selection is visible until the user pulls down the menu of choices.</docstring>
+ <refdoc>
+ Events
+ EVT_CHOICE: Sent when an item in the list is selected.
+</refdoc>
<baseclass name="ControlWithItems"/>
<constructor name="Choice" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
+ <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> Choice</autodoc>
+ <docstring>Create and show a Choice control</docstring>
+ <refdoc>
+ Events
+ EVT_CHOICE: Sent when an item in the list is selected.
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreChoice" overloaded="no">
<autodoc>PreChoice() -> Choice</autodoc>
+ <docstring>Precreate a Choice control for 2-phase creation.</docstring>
+ <refdoc>
+ Events
+ EVT_CHOICE: Sent when an item in the list is selected.
+</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
+ <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> bool</autodoc>
+ <docstring>Actually create the GUI Choice control for 2-phase creation</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
<param name="name" type="String" default="wxPyChoiceNameStr"/>
</paramlist>
</method>
- <method name="GetColumns" type="int" overloaded="no">
- <autodoc>GetColumns() -> int</autodoc>
- </method>
- <method name="SetColumns" type="" overloaded="no">
- <autodoc>SetColumns(int n=1)</autodoc>
- <paramlist>
- <param name="n" type="int" default="1"/>
- </paramlist>
- </method>
<method name="SetSelection" type="" overloaded="no">
<autodoc>SetSelection(int n)</autodoc>
+ <docstring>Select the n'th item (zero based) in the list.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetStringSelection" type="" overloaded="no">
<autodoc>SetStringSelection(String string)</autodoc>
+ <docstring>Select the item with the specifed string</docstring>
<paramlist>
<param name="string" type="String" default=""/>
</paramlist>
</method>
<method name="SetString" type="" overloaded="no">
- <autodoc>SetString(int n, String s)</autodoc>
+ <autodoc>SetString(int n, String string)</autodoc>
+ <docstring>Set the label for the n'th item (zero based) in the list.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
- <param name="s" type="String" default=""/>
+ <param name="string" type="String" default=""/>
</paramlist>
</method>
</class>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ComboBox" oldname="wxComboBox" module="controls">
+ <docstring>A combobox is like a combination of an edit control and a listbox. It can be
+displayed as static list with editable or read-only text field; or a drop-down
+list with text field.</docstring>
+ <refdoc>
+ Styles
+ wx.CB_SIMPLE: Creates a combobox with a permanently displayed list.
+ Windows only.
+
+ wx.CB_DROPDOWN: Creates a combobox with a drop-down list.
+
+ wx.CB_READONLY: Same as wxCB_DROPDOWN but only the strings specified as
+ the combobox choices can be selected, it is impossible
+ to select (even from a program) a string which is not in
+ the choices list.
+
+ wx.CB_SORT: Sorts the entries in the list alphabetically.
+
+ Events
+
+ EVT_COMBOBOX: Sent when an item on the list is selected.
+ EVT_TEXT: Sent when the combobox text changes.
+</refdoc>
<baseclass name="Control"/>
<baseclass name="ItemContainer"/>
<constructor name="ComboBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> ComboBox</autodoc>
+ <autodoc>__init__(Window parent, int id, String value=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ List choices=[], long style=0, Validator validator=DefaultValidator,
+ String name=ComboBoxNameStr) -> ComboBox</autodoc>
+ <docstring>Constructor, creates and shows a ComboBox control.</docstring>
+ <refdoc>
+ Styles
+ wx.CB_SIMPLE: Creates a combobox with a permanently displayed list.
+ Windows only.
+
+ wx.CB_DROPDOWN: Creates a combobox with a drop-down list.
+
+ wx.CB_READONLY: Same as wxCB_DROPDOWN but only the strings specified as
+ the combobox choices can be selected, it is impossible
+ to select (even from a program) a string which is not in
+ the choices list.
+
+ wx.CB_SORT: Sorts the entries in the list alphabetically.
+
+ Events
+
+ EVT_COMBOBOX: Sent when an item on the list is selected.
+ EVT_TEXT: Sent when the combobox text changes.
+</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreComboBox" overloaded="no">
<autodoc>PreComboBox() -> ComboBox</autodoc>
+ <docstring>Precreate a ComboBox control for 2-phase creation.</docstring>
+ <refdoc>
+ Styles
+ wx.CB_SIMPLE: Creates a combobox with a permanently displayed list.
+ Windows only.
+
+ wx.CB_DROPDOWN: Creates a combobox with a drop-down list.
+
+ wx.CB_READONLY: Same as wxCB_DROPDOWN but only the strings specified as
+ the combobox choices can be selected, it is impossible
+ to select (even from a program) a string which is not in
+ the choices list.
+
+ wx.CB_SORT: Sorts the entries in the list alphabetically.
+
+ Events
+
+ EVT_COMBOBOX: Sent when an item on the list is selected.
+ EVT_TEXT: Sent when the combobox text changes.
+</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> bool</autodoc>
+ <autodoc>Create(Window parent, int id, String value=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ List choices=[], long style=0, Validator validator=DefaultValidator,
+ String name=ChoiceNameStr) -> bool</autodoc>
+ <docstring>Actually create the GUI wxComboBox control for 2-phase creation</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
<param name="style" type="long" default="0"/>
<param name="validator" type="Validator" default="wxDefaultValidator"/>
- <param name="name" type="String" default="wxPyComboBoxNameStr"/>
+ <param name="name" type="String" default="wxPyChoiceNameStr"/>
</paramlist>
</method>
<method name="GetValue" type="String" overloaded="no">
<autodoc>GetValue() -> String</autodoc>
+ <docstring>Returns the current value in the combobox text field.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
<autodoc>SetValue(String value)</autodoc>
</method>
<method name="Copy" type="" overloaded="no">
<autodoc>Copy()</autodoc>
+ <docstring>Copies the selected text to the clipboard.</docstring>
</method>
<method name="Cut" type="" overloaded="no">
<autodoc>Cut()</autodoc>
+ <docstring>Copies the selected text to the clipboard and removes the selection.</docstring>
</method>
<method name="Paste" type="" overloaded="no">
<autodoc>Paste()</autodoc>
+ <docstring>Pastes text from the clipboard to the text field.</docstring>
</method>
<method name="SetInsertionPoint" type="" overloaded="no">
<autodoc>SetInsertionPoint(long pos)</autodoc>
+ <docstring>Sets the insertion point in the combobox text field.</docstring>
<paramlist>
<param name="pos" type="long" default=""/>
</paramlist>
</method>
<method name="GetInsertionPoint" type="long" overloaded="no">
<autodoc>GetInsertionPoint() -> long</autodoc>
+ <docstring>Returns the insertion point for the combobox's text field.</docstring>
</method>
<method name="GetLastPosition" type="long" overloaded="no">
<autodoc>GetLastPosition() -> long</autodoc>
+ <docstring>Returns the last position in the combobox text field.</docstring>
</method>
<method name="Replace" type="" overloaded="no">
<autodoc>Replace(long from, long to, String value)</autodoc>
+ <docstring>Replaces the text between two positions with the given text, in the
+combobox text field.</docstring>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</method>
<method name="SetSelection" type="" overloaded="no">
<autodoc>SetSelection(int n)</autodoc>
+ <docstring>Selects the text between the two positions, in the combobox text field.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetInsertionPointEnd" type="" overloaded="no">
<autodoc>SetInsertionPointEnd()</autodoc>
+ <docstring>Sets the insertion point at the end of the combobox text field.</docstring>
</method>
<method name="Remove" type="" overloaded="no">
<autodoc>Remove(long from, long to)</autodoc>
+ <docstring>Removes the text between the two positions in the combobox text field.</docstring>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</method>
<method name="Insert" type="" overloaded="no">
<autodoc>Insert(String item, int pos, PyObject clientData=None)</autodoc>
+ <docstring>Insert an item into the control before the item at the pos index,
+optionally associating some data object with the item.</docstring>
<paramlist>
<param name="item" type="String" default=""/>
<param name="pos" type="int" default=""/>
</method>
<method name="Select" type="" overloaded="no">
<autodoc>Select(int n)</autodoc>
+ <docstring>Sets the item at index 'n' to be the selected item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="HitTest" type="int" overloaded="no">
<autodoc>HitTest(Point pt) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="HitTestXY" type="int" overloaded="no">
<autodoc>HitTestXY(int x, int y) -> int</autodoc>
+ <docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SB_HORIZONTAL,
Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
<method name="SetScrollbar" type="" overloaded="no">
<autodoc>SetScrollbar(int position, int thumbSize, int range, int pageSize,
bool refresh=True)</autodoc>
+ <docstring>Sets the scrollbar properties of a built-in scrollbar.
+
+ orientation: Determines the scrollbar whose page size is to be
+ set. May be wx.HORIZONTAL or wx.VERTICAL.
+
+ position: The position of the scrollbar in scroll units.
+
+ thumbSize: The size of the thumb, or visible portion of the
+ scrollbar, in scroll units.
+
+ range: The maximum position of the scrollbar.
+
+ refresh: True to redraw the scrollbar, false otherwise.</docstring>
<paramlist>
<param name="position" type="int" default=""/>
<param name="thumbSize" type="int" default=""/>
</method>
<method name="SetLabel" type="" overloaded="no">
<autodoc>SetLabel(String label)</autodoc>
+ <docstring>Sets the item's text.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
<autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_ICON,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
</method>
<method name="SetForegroundColour" type="bool" overloaded="no">
<autodoc>SetForegroundColour(Colour col) -> bool</autodoc>
+ <docstring>Sets the foreground colour of the window. Returns True is the colour
+was changed. The interpretation of foreground colour is dependent on
+the window class; it may be the text colour or other colour, or it may
+not be used at all.</docstring>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="bool" overloaded="no">
<autodoc>SetBackgroundColour(Colour col) -> bool</autodoc>
+ <docstring>Sets the background colour of the window. Returns True if the colour
+was changed. The background colour is usually painted by the default
+EVT_ERASE_BACKGROUND event handler function under Windows and
+automatically under GTK.
+
+Note that setting the background colour does not cause an immediate
+refresh, so you may wish to call ClearBackground or Refresh after
+calling this function.
+
+Use this function with care under GTK+ as the new appearance of the
+window might not look equally well when used with themes, i.e GTK+'s
+ability to change its look as the user wishes with run-time loadable
+modules.</docstring>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetWindowStyleFlag" type="" overloaded="no">
<autodoc>SetWindowStyleFlag(long style)</autodoc>
+ <docstring>Sets the style of the window. Please note that some styles cannot be
+changed after the window creation and that Refresh() might be called
+after changing the others for the change to take place immediately.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
<autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_REPORT,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeCtrlNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2)
</pythoncode>
<class name="HelpEvent" oldname="wxHelpEvent" module="controls">
+ <docstring>A help event is sent when the user has requested
+context-sensitive help. This can either be caused by the
+application requesting context-sensitive help mode via
+wx.ContextHelp, or (on MS Windows) by the system generating a
+WM_HELP message when the user pressed F1 or clicked on the query
+button in a dialog caption.
+
+A help event is sent to the window that the user clicked on, and
+is propagated up the window hierarchy until the event is
+processed or there are no more event handlers. The application
+should call event.GetId to check the identity of the clicked-on
+window, and then either show some suitable help or call
+event.Skip if the identifier is unrecognised. Calling Skip is
+important because it allows wxWindows to generate further events
+for ancestors of the clicked-on window. Otherwise it would be
+impossible to show help for container windows, since processing
+would stop after the first window found.
+
+ Events
+ EVT_HELP Sent when the user has requested context-
+ sensitive help.
+ EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
+</docstring>
<baseclass name="CommandEvent"/>
<constructor name="HelpEvent" overloaded="no">
<autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent</autodoc>
</constructor>
<method name="GetPosition" type="Point" overloaded="no">
<autodoc>GetPosition() -> Point</autodoc>
+ <docstring>Returns the left-click position of the mouse, in screen
+coordinates. This allows the application to position the help
+appropriately.</docstring>
</method>
<method name="SetPosition" type="" overloaded="no">
<autodoc>SetPosition(Point pos)</autodoc>
+ <docstring>Sets the left-click position of the mouse, in screen coordinates.</docstring>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="GetLink" type="String" overloaded="no">
<autodoc>GetLink() -> String</autodoc>
+ <docstring>Get an optional link to further help</docstring>
</method>
<method name="SetLink" type="" overloaded="no">
<autodoc>SetLink(String link)</autodoc>
+ <docstring>Set an optional link to further help</docstring>
<paramlist>
<param name="link" type="String" default=""/>
</paramlist>
</method>
<method name="GetTarget" type="String" overloaded="no">
<autodoc>GetTarget() -> String</autodoc>
+ <docstring>Get an optional target to display help in. E.g. a window specification</docstring>
</method>
<method name="SetTarget" type="" overloaded="no">
<autodoc>SetTarget(String target)</autodoc>
+ <docstring>Set an optional target to display help in. E.g. a window specification</docstring>
<paramlist>
<param name="target" type="String" default=""/>
</paramlist>
</method>
</class>
<class name="ContextHelp" oldname="wxContextHelp" module="controls">
+ <docstring>This class changes the cursor to a query and puts the application
+into a 'context-sensitive help mode'. When the user left-clicks
+on a window within the specified window, a EVT_HELP event is sent
+to that control, and the application may respond to it by popping
+up some help.
+
+There are a couple of ways to invoke this behaviour implicitly:
+
+ * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a
+ dialog (Windows only). This will put a question mark in the
+ titlebar, and Windows will put the application into
+ context-sensitive help mode automatically, with further
+ programming.
+
+ * Create a wx.ContextHelpButton, whose predefined behaviour
+ is to create a context help object. Normally you will write
+ your application so that this button is only added to a
+ dialog for non-Windows platforms (use
+ wx.DIALOG_EX_CONTEXTHELP on Windows).
+</docstring>
<baseclass name="Object"/>
<constructor name="ContextHelp" overloaded="no">
<autodoc>__init__(Window window=None, bool doNow=True) -> ContextHelp</autodoc>
+ <docstring>Constructs a context help object, calling BeginContextHelp if
+doNow is true (the default).
+
+If window is None, the top window is used.</docstring>
<paramlist>
<param name="window" type="Window" default="NULL"/>
<param name="doNow" type="bool" default="True"/>
</destructor>
<method name="BeginContextHelp" type="bool" overloaded="no">
<autodoc>BeginContextHelp(Window window=None) -> bool</autodoc>
+ <docstring>Puts the application into context-sensitive help mode. window is
+the window which will be used to catch events; if NULL, the top
+window will be used.
+
+Returns true if the application was successfully put into
+context-sensitive help mode. This function only returns when the
+event loop has finished.</docstring>
<paramlist>
<param name="window" type="Window" default="NULL"/>
</paramlist>
</method>
<method name="EndContextHelp" type="bool" overloaded="no">
<autodoc>EndContextHelp() -> bool</autodoc>
+ <docstring>Ends context-sensitive help mode. Not normally called by the
+application.</docstring>
</method>
</class>
<class name="ContextHelpButton" oldname="wxContextHelpButton" module="controls">
+ <docstring>Instances of this class may be used to add a question mark button
+that when pressed, puts the application into context-help
+mode. It does this by creating a wx.ContextHelp object which
+itself generates a EVT_HELP event when the user clicks on a
+window.
+
+On Windows, you may add a question-mark icon to a dialog by use
+of the wx.DIALOG_EX_CONTEXTHELP extra style, but on other
+platforms you will have to add a button explicitly, usually next
+to OK, Cancel or similar buttons.
+</docstring>
<baseclass name="BitmapButton"/>
<constructor name="ContextHelpButton" overloaded="no">
<autodoc>__init__(Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton</autodoc>
+ <docstring>Constructor, creating and showing a context help button.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="wxID_CONTEXT_HELP"/>
</constructor>
</class>
<class name="HelpProvider" oldname="wxHelpProvider" module="controls">
+ <docstring>wx.HelpProvider is an abstract class used by a program
+implementing context-sensitive help to show the help text for the
+given window.
+
+The current help provider must be explicitly set by the
+application using wx.HelpProvider.Set().</docstring>
<staticmethod name="Set" type="HelpProvider" overloaded="no">
<autodoc>Set(HelpProvider helpProvider) -> HelpProvider</autodoc>
+ <docstring>Sset the current, application-wide help provider. Returns the
+previous one. Unlike some other classes, the help provider is
+not created on demand. This must be explicitly done by the
+application.</docstring>
<paramlist>
<param name="helpProvider" type="HelpProvider" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="Get" type="HelpProvider" overloaded="no">
<autodoc>Get() -> HelpProvider</autodoc>
+ <docstring>Return the current application-wide help provider.</docstring>
</staticmethod>
<method name="GetHelp" type="String" overloaded="no">
<autodoc>GetHelp(Window window) -> String</autodoc>
+ <docstring>Gets the help string for this window. Its interpretation is
+dependent on the help provider except that empty string always
+means that no help is associated with the window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="ShowHelp" type="bool" overloaded="no">
<autodoc>ShowHelp(Window window) -> bool</autodoc>
+ <docstring>Shows help for the given window. Uses GetHelp internally if
+applicable.
+
+Returns true if it was done, or false if no help was available
+for this window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="AddHelp" type="" overloaded="no">
<autodoc>AddHelp(Window window, String text)</autodoc>
+ <docstring>Associates the text with the given window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="text" type="String" default=""/>
</method>
<method name="AddHelpById" type="" overloaded="no">
<autodoc>AddHelpById(int id, String text)</autodoc>
+ <docstring>This version associates the given text with all windows with this
+id. May be used to set the same help string for all Cancel
+buttons in the application, for example.</docstring>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
+ <method name="RemoveHelp" type="" overloaded="no">
+ <autodoc>RemoveHelp(Window window)</autodoc>
+ <docstring>Removes the association between the window pointer and the help
+text. This is called by the wx.Window destructor. Without this,
+the table of help strings will fill up and when window pointers
+are reused, the wrong help string will be found.</docstring>
+ <paramlist>
+ <param name="window" type="Window" default=""/>
+ </paramlist>
+ </method>
<method name="Destroy" type="" overloaded="no">
<autodoc>Destroy()</autodoc>
</method>
</class>
<class name="SimpleHelpProvider" oldname="wxSimpleHelpProvider" module="controls">
+ <docstring>wx.SimpleHelpProvider is an implementation of wx.HelpProvider
+which supports only plain text help strings, and shows the string
+associated with the control (if any) in a tooltip.</docstring>
<baseclass name="HelpProvider"/>
<constructor name="SimpleHelpProvider" overloaded="no">
<autodoc>__init__() -> SimpleHelpProvider</autodoc>
+ <docstring>wx.SimpleHelpProvider is an implementation of wx.HelpProvider
+which supports only plain text help strings, and shows the string
+associated with the control (if any) in a tooltip.</docstring>
</constructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ConfigBase" oldname="wxConfigBase" module="misc">
+ <docstring>wx.ConfigBase class defines the basic interface of all config
+classes. It can not be used by itself (it is an abstract base
+class) and you will always use one of its derivations: wx.Config
+or wx.FileConfig.
+
+wx.ConfigBase organizes the items in a tree-like structure
+(modeled after the Unix/Dos filesystem). There are groups
+(directories) and keys (files). There is always one current
+group given by the current path. As in the file system case, to
+specify a key in the config class you must use a path to it.
+Config classes also support the notion of the current group,
+which makes it possible to use relative paths.
+
+Keys are pairs "key_name = value" where value may be of string, integer
+floating point or boolean, you can not store binary data without first
+encoding it as a string. For performance reasons items should be kept small,
+no more than a couple kilobytes.
+</docstring>
<destructor name="~wxConfigBase" overloaded="no">
<autodoc>__del__()</autodoc>
</destructor>
<staticmethod name="Set" type="ConfigBase" overloaded="no">
- <autodoc>Set(ConfigBase pConfig) -> ConfigBase</autodoc>
+ <autodoc>Set(ConfigBase config) -> ConfigBase</autodoc>
+ <docstring>Sets the global config object (the one returned by Get) and
+returns a reference to the previous global config object.</docstring>
<paramlist>
- <param name="pConfig" type="ConfigBase" default=""/>
+ <param name="config" type="ConfigBase" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="Get" type="ConfigBase" overloaded="no">
<autodoc>Get(bool createOnDemand=True) -> ConfigBase</autodoc>
+ <docstring>Returns the current global config object, creating one if neccessary.</docstring>
<paramlist>
<param name="createOnDemand" type="bool" default="True"/>
</paramlist>
</staticmethod>
<staticmethod name="Create" type="ConfigBase" overloaded="no">
<autodoc>Create() -> ConfigBase</autodoc>
+ <docstring>Create and return a new global config object. This function will
+create the "best" implementation of wx.Config available for the
+current platform.</docstring>
</staticmethod>
<staticmethod name="DontCreateOnDemand" type="" overloaded="no">
<autodoc>DontCreateOnDemand()</autodoc>
+ <docstring>Should Get() try to create a new log object if there isn't a current one?</docstring>
</staticmethod>
<method name="SetPath" type="" overloaded="no">
- <autodoc>SetPath(String strPath)</autodoc>
+ <autodoc>SetPath(String path)</autodoc>
+ <docstring>Set current path: if the first character is '/', it's the absolute path,
+otherwise it's a relative path. '..' is supported. If the strPath
+doesn't exist it is created.</docstring>
<paramlist>
- <param name="strPath" type="String" default=""/>
+ <param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="GetPath" type="String" overloaded="no">
<autodoc>GetPath() -> String</autodoc>
+ <docstring>Retrieve the current path (always as absolute path)</docstring>
</method>
<method name="GetFirstGroup" type="PyObject" overloaded="no">
- <autodoc>GetFirstGroup() -> PyObject</autodoc>
+ <autodoc>GetFirstGroup() -> (more, value, index)</autodoc>
+ <docstring>Allows enumerating the subgroups in a config object. Returns
+a tuple containing a flag indicating there are more items, the
+name of the current item, and an index to pass to GetNextGroup to
+fetch the next item.</docstring>
</method>
<method name="GetNextGroup" type="PyObject" overloaded="no">
- <autodoc>GetNextGroup(long index) -> PyObject</autodoc>
+ <autodoc>GetNextGroup(long index) -> (more, value, index)</autodoc>
+ <docstring>Allows enumerating the subgroups in a config object. Returns
+a tuple containing a flag indicating there are more items, the
+name of the current item, and an index to pass to GetNextGroup to
+fetch the next item.</docstring>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
</method>
<method name="GetFirstEntry" type="PyObject" overloaded="no">
- <autodoc>GetFirstEntry() -> PyObject</autodoc>
+ <autodoc>GetFirstEntry() -> (more, value, index)</autodoc>
+ <docstring>Allows enumerating the entries in the current group in a config
+object. Returns a tuple containing a flag indicating there are
+more items, the name of the current item, and an index to pass to
+GetNextGroup to fetch the next item.</docstring>
</method>
<method name="GetNextEntry" type="PyObject" overloaded="no">
- <autodoc>GetNextEntry(long index) -> PyObject</autodoc>
+ <autodoc>GetNextEntry(long index) -> (more, value, index)</autodoc>
+ <docstring>Allows enumerating the entries in the current group in a config
+object. Returns a tuple containing a flag indicating there are
+more items, the name of the current item, and an index to pass to
+GetNextGroup to fetch the next item.</docstring>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
</method>
<method name="GetNumberOfEntries" type="size_t" overloaded="no">
- <autodoc>GetNumberOfEntries(bool bRecursive=False) -> size_t</autodoc>
+ <autodoc>GetNumberOfEntries(bool recursive=False) -> size_t</autodoc>
+ <docstring>Get the number of entries in the current group, with or
+without its subgroups.</docstring>
<paramlist>
- <param name="bRecursive" type="bool" default="False"/>
+ <param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetNumberOfGroups" type="size_t" overloaded="no">
- <autodoc>GetNumberOfGroups(bool bRecursive=False) -> size_t</autodoc>
+ <autodoc>GetNumberOfGroups(bool recursive=False) -> size_t</autodoc>
+ <docstring>Get the number of subgroups in the current group, with or
+without its subgroups.</docstring>
<paramlist>
- <param name="bRecursive" type="bool" default="False"/>
+ <param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="HasGroup" type="bool" overloaded="no">
- <autodoc>HasGroup(String strName) -> bool</autodoc>
+ <autodoc>HasGroup(String name) -> bool</autodoc>
+ <docstring>Returns True if the group by this name exists</docstring>
<paramlist>
- <param name="strName" type="String" default=""/>
+ <param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="HasEntry" type="bool" overloaded="no">
- <autodoc>HasEntry(String strName) -> bool</autodoc>
+ <autodoc>HasEntry(String name) -> bool</autodoc>
+ <docstring>Returns True if the entry by this name exists</docstring>
<paramlist>
- <param name="strName" type="String" default=""/>
+ <param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="Exists" type="bool" overloaded="no">
- <autodoc>Exists(String strName) -> bool</autodoc>
+ <autodoc>Exists(String name) -> bool</autodoc>
+ <docstring>Returns True if either a group or an entry with a given name exists</docstring>
<paramlist>
- <param name="strName" type="String" default=""/>
+ <param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetEntryType" type="wxConfigBase::EntryType" overloaded="no">
<autodoc>GetEntryType(String name) -> int</autodoc>
+ <docstring>Get the type of the entry. Returns one of the wx.Config.Type_XXX values.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="Read" type="String" overloaded="no">
<autodoc>Read(String key, String defaultVal=EmptyString) -> String</autodoc>
+ <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="defaultVal" type="String" default="wxPyEmptyString"/>
</method>
<method name="ReadInt" type="long" overloaded="no">
<autodoc>ReadInt(String key, long defaultVal=0) -> long</autodoc>
+ <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="defaultVal" type="long" default="0"/>
</method>
<method name="ReadFloat" type="double" overloaded="no">
<autodoc>ReadFloat(String key, double defaultVal=0.0) -> double</autodoc>
+ <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="defaultVal" type="double" default="0.0"/>
</method>
<method name="ReadBool" type="bool" overloaded="no">
<autodoc>ReadBool(String key, bool defaultVal=False) -> bool</autodoc>
+ <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="defaultVal" type="bool" default="False"/>
</method>
<method name="Write" type="bool" overloaded="no">
<autodoc>Write(String key, String value) -> bool</autodoc>
+ <docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="value" type="String" default=""/>
</method>
<method name="WriteInt" type="bool" overloaded="no">
<autodoc>WriteInt(String key, long value) -> bool</autodoc>
+ <docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="value" type="long" default=""/>
</method>
<method name="WriteFloat" type="bool" overloaded="no">
<autodoc>WriteFloat(String key, double value) -> bool</autodoc>
+ <docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="value" type="double" default=""/>
</method>
<method name="WriteBool" type="bool" overloaded="no">
<autodoc>WriteBool(String key, bool value) -> bool</autodoc>
+ <docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="value" type="bool" default=""/>
</paramlist>
</method>
<method name="Flush" type="bool" overloaded="no">
- <autodoc>Flush(bool bCurrentOnly=False) -> bool</autodoc>
+ <autodoc>Flush(bool currentOnly=False) -> bool</autodoc>
+ <docstring>permanently writes all changes</docstring>
<paramlist>
- <param name="bCurrentOnly" type="bool" default="False"/>
+ <param name="currentOnly" type="bool" default="False"/>
</paramlist>
</method>
<method name="RenameEntry" type="bool" overloaded="no">
<autodoc>RenameEntry(String oldName, String newName) -> bool</autodoc>
+ <docstring>Rename an entry. Returns False on failure (probably because the new
+name is already taken by an existing entry)</docstring>
<paramlist>
<param name="oldName" type="String" default=""/>
<param name="newName" type="String" default=""/>
</method>
<method name="RenameGroup" type="bool" overloaded="no">
<autodoc>RenameGroup(String oldName, String newName) -> bool</autodoc>
+ <docstring>Rename aa group. Returns False on failure (probably because the new
+name is already taken by an existing entry)</docstring>
<paramlist>
<param name="oldName" type="String" default=""/>
<param name="newName" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteEntry" type="bool" overloaded="no">
- <autodoc>DeleteEntry(String key, bool bDeleteGroupIfEmpty=True) -> bool</autodoc>
+ <autodoc>DeleteEntry(String key, bool deleteGroupIfEmpty=True) -> bool</autodoc>
+ <docstring>Deletes the specified entry and the group it belongs to if
+it was the last key in it and the second parameter is True</docstring>
<paramlist>
<param name="key" type="String" default=""/>
- <param name="bDeleteGroupIfEmpty" type="bool" default="True"/>
+ <param name="deleteGroupIfEmpty" type="bool" default="True"/>
</paramlist>
</method>
<method name="DeleteGroup" type="bool" overloaded="no">
<autodoc>DeleteGroup(String key) -> bool</autodoc>
+ <docstring>Delete the group (with all subgroups)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteAll" type="bool" overloaded="no">
<autodoc>DeleteAll() -> bool</autodoc>
- </method>
- <method name="IsExpandingEnvVars" type="bool" overloaded="no">
- <autodoc>IsExpandingEnvVars() -> bool</autodoc>
+ <docstring>Delete the whole underlying object (disk file, registry key, ...)
+primarly intended for use by desinstallation routine.</docstring>
</method>
<method name="SetExpandEnvVars" type="" overloaded="no">
- <autodoc>SetExpandEnvVars(bool bDoIt=True)</autodoc>
+ <autodoc>SetExpandEnvVars(bool doIt=True)</autodoc>
+ <docstring>We can automatically expand environment variables in the config entries
+(this option is on by default, you can turn it on/off at any time)</docstring>
<paramlist>
- <param name="bDoIt" type="bool" default="True"/>
+ <param name="doIt" type="bool" default="True"/>
</paramlist>
</method>
+ <method name="IsExpandingEnvVars" type="bool" overloaded="no">
+ <autodoc>IsExpandingEnvVars() -> bool</autodoc>
+ <docstring>Are we currently expanding environment variables?</docstring>
+ </method>
<method name="SetRecordDefaults" type="" overloaded="no">
- <autodoc>SetRecordDefaults(bool bDoIt=True)</autodoc>
+ <autodoc>SetRecordDefaults(bool doIt=True)</autodoc>
+ <docstring>Set whether the config objec should record default values.</docstring>
<paramlist>
- <param name="bDoIt" type="bool" default="True"/>
+ <param name="doIt" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsRecordingDefaults" type="bool" overloaded="no">
<autodoc>IsRecordingDefaults() -> bool</autodoc>
+ <docstring>Are we currently recording default values?</docstring>
</method>
<method name="ExpandEnvVars" type="String" overloaded="no">
<autodoc>ExpandEnvVars(String str) -> String</autodoc>
+ <docstring>Expand any environment variables in str and return the result</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
<autodoc>GetStyle() -> long</autodoc>
</method>
</class>
- <class name="ConfigPathChanger" oldname="wxConfigPathChanger" module="misc">
- <constructor name="ConfigPathChanger" overloaded="no">
- <autodoc>__init__(ConfigBase pContainer, String strEntry) -> ConfigPathChanger</autodoc>
- <paramlist>
- <param name="pContainer" type="ConfigBase" default=""/>
- <param name="strEntry" type="String" default=""/>
- </paramlist>
- </constructor>
- <destructor name="~wxConfigPathChanger" overloaded="no">
- <autodoc>__del__()</autodoc>
- </destructor>
- <method name="Name" type="String" overloaded="no">
- <autodoc>Name() -> String</autodoc>
- </method>
- </class>
<class name="Config" oldname="wxConfig" module="misc">
+ <docstring>This ConfigBase-derived class will use the registry on Windows,
+and will be a wx.FileConfig on other platforms.</docstring>
<baseclass name="ConfigBase"/>
<constructor name="Config" overloaded="no">
<autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
</destructor>
</class>
<class name="FileConfig" oldname="wxFileConfig" module="misc">
+ <docstring>This config class will use a file for storage on all platforms.</docstring>
<baseclass name="ConfigBase"/>
<constructor name="FileConfig" overloaded="no">
<autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
<autodoc>__del__()</autodoc>
</destructor>
</class>
+ <class name="ConfigPathChanger" oldname="wxConfigPathChanger" module="misc">
+ <docstring>A handy little class which changes current path to the path of
+given entry and restores it in the destructoir: so if you declare
+a local variable of this type, you work in the entry directory
+and the path is automatically restored when the function returns.</docstring>
+ <constructor name="ConfigPathChanger" overloaded="no">
+ <autodoc>__init__(ConfigBase config, String entry) -> ConfigPathChanger</autodoc>
+ <paramlist>
+ <param name="config" type="ConfigBase" default=""/>
+ <param name="entry" type="String" default=""/>
+ </paramlist>
+ </constructor>
+ <destructor name="~wxConfigPathChanger" overloaded="no">
+ <autodoc>__del__()</autodoc>
+ </destructor>
+ <method name="Name" type="String" overloaded="no">
+ <autodoc>Name() -> String</autodoc>
+ <docstring>Get the key name</docstring>
+ </method>
+ </class>
<method name="ExpandEnvVars" oldname="wxExpandEnvVars" type="String" overloaded="no">
<autodoc>ExpandEnvVars(String sz) -> String</autodoc>
+ <docstring>Replace environment variables ($SOMETHING) with their values. The
+format is $VARNAME or ${VARNAME} where VARNAME contains
+alphanumeric characters and '_' only. '$' must be escaped ('\\$')
+in order to be taken literally.</docstring>
<paramlist>
<param name="sz" type="String" default=""/>
</paramlist>
#---------------------------------------------------------------------------
</pythoncode>
<class name="DataFormat" oldname="wxDataFormat" module="misc">
+ <docstring>A wx.DataFormat is an encapsulation of a platform-specific format
+handle which is used by the system for the clipboard and drag and
+drop operations. The applications are usually only interested in,
+for example, pasting data from the clipboard only if the data is
+in a format the program understands. A data format is is used to
+uniquely identify this format.
+
+On the system level, a data format is usually just a number
+(CLIPFORMAT under Windows or Atom under X11, for example).</docstring>
<constructor name="DataFormat" overloaded="no">
<autodoc>__init__(int type) -> DataFormat</autodoc>
+ <docstring>Constructs a data format object for one of the standard data
+formats or an empty data object (use SetType or SetId later in
+this case)</docstring>
<paramlist>
<param name="type" type="wxDataFormatId" default=""/>
</paramlist>
</constructor>
<constructor name="CustomDataFormat" overloaded="no">
<autodoc>CustomDataFormat(String format) -> DataFormat</autodoc>
+ <docstring>Constructs a data format object for a custom format identified by its name.</docstring>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
</method>
<method name="SetType" type="" overloaded="no">
<autodoc>SetType(int format)</autodoc>
+ <docstring>Sets the format to the given value, which should be one of wx.DF_XXX constants.</docstring>
<paramlist>
<param name="format" type="wxDataFormatId" default=""/>
</paramlist>
</method>
<method name="GetType" type="wxDataFormatId" overloaded="no">
<autodoc>GetType() -> int</autodoc>
+ <docstring>Returns the platform-specific number identifying the format.</docstring>
</method>
<method name="GetId" type="String" overloaded="no">
<autodoc>GetId() -> String</autodoc>
+ <docstring>Returns the name of a custom format (this function will fail for a standard format).</docstring>
</method>
<method name="SetId" type="" overloaded="no">
<autodoc>SetId(String format)</autodoc>
+ <docstring>Sets the format to be the custom format identified by the given name.</docstring>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
<method name="GetFilenames" type="wxArrayString" overloaded="no">
<autodoc>GetFilenames() -> wxArrayString</autodoc>
</method>
+ <method name="AddFile" type="" overloaded="no">
+ <autodoc>AddFile(String filename)</autodoc>
+ <paramlist>
+ <param name="filename" type="String" default=""/>
+ </paramlist>
+ </method>
</class>
<class name="CustomDataObject" oldname="wxCustomDataObject" module="misc">
<baseclass name="DataObjectSimple"/>
</method>
</class>
<class name="DropTarget" oldname="wxPyDropTarget" module="misc">
- <constructor name="PyDropTarget" overloaded="no">
- <autodoc>PyDropTarget(DataObject dataObject=None) -> DropTarget</autodoc>
+ <constructor name="DropTarget" overloaded="no">
+ <autodoc>__init__(DataObject dataObject=None) -> DropTarget</autodoc>
<paramlist>
<param name="dataObject" type="DataObject" default="NULL"/>
</paramlist>
#---------------------------------------------------------------------------
</pythoncode>
<class name="Clipboard" oldname="wxClipboard" module="misc">
+ <docstring>wx.Clipboard represents the system clipboard and provides methods to copy data
+to or paste data from it. Normally, you should only use wx.TheClipboard which
+is a reference to a global wx.Clipboard instance.
+
+Call wx.TheClipboard.Open to get ownership of the clipboard. If this operation
+returns True, you now own the clipboard. Call wx.TheClipboard.SetData to put
+data on the clipboard, or wx.TheClipboard.GetData to retrieve data from the
+clipboard. Call wx.TheClipboard.Close to close the clipboard and relinquish
+ownership. You should keep the clipboard open only momentarily.
+</docstring>
<baseclass name="Object"/>
<constructor name="Clipboard" overloaded="no">
<autodoc>__init__() -> Clipboard</autodoc>
</destructor>
<method name="Open" type="bool" overloaded="no">
<autodoc>Open() -> bool</autodoc>
+ <docstring>Call this function to open the clipboard before calling SetData
+and GetData. Call Close when you have finished with the clipboard.
+You should keep the clipboard open for only a very short time.
+Returns true on success. </docstring>
</method>
<method name="Close" type="" overloaded="no">
<autodoc>Close()</autodoc>
+ <docstring>Closes the clipboard.</docstring>
</method>
<method name="IsOpened" type="bool" overloaded="no">
<autodoc>IsOpened() -> bool</autodoc>
+ <docstring>Query whether the clipboard is opened</docstring>
</method>
<method name="AddData" type="bool" overloaded="no">
<autodoc>AddData(DataObject data) -> bool</autodoc>
+ <docstring>Call this function to add the data object to the clipboard. You
+may call this function repeatedly after having cleared the clipboard.
+After this function has been called, the clipboard owns the data, so
+do not delete the data explicitly.</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="SetData" type="bool" overloaded="no">
<autodoc>SetData(DataObject data) -> bool</autodoc>
+ <docstring>Set the clipboard data, this is the same as Clear followed by AddData.</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="IsSupported" type="bool" overloaded="no">
<autodoc>IsSupported(DataFormat format) -> bool</autodoc>
+ <docstring>Returns True if the given format is available in the data object(s) on
+the clipboard.</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
</paramlist>
</method>
<method name="GetData" type="bool" overloaded="no">
<autodoc>GetData(DataObject data) -> bool</autodoc>
+ <docstring>Call this function to fill data with data on the clipboard, if available
+in the required format. Returns true on success.</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
<autodoc>Clear()</autodoc>
+ <docstring>Clears data from the clipboard object and also the system's clipboard
+if possible.</docstring>
</method>
<method name="Flush" type="bool" overloaded="no">
<autodoc>Flush() -> bool</autodoc>
+ <docstring>Flushes the clipboard: this means that the data which is currently on
+clipboard will stay available even after the application exits (possibly
+eating memory), otherwise the clipboard will be emptied on exit.
+Returns False if the operation is unsuccesful for any reason.</docstring>
</method>
<method name="UsePrimarySelection" type="" overloaded="no">
- <autodoc>UsePrimarySelection(bool primary=False)</autodoc>
+ <autodoc>UsePrimarySelection(bool primary=True)</autodoc>
+ <docstring>On platforms supporting it (the X11 based platforms), selects the so
+called PRIMARY SELECTION as the clipboard as opposed to the normal
+clipboard, if primary is True.</docstring>
<paramlist>
- <param name="primary" type="bool" default="False"/>
+ <param name="primary" type="bool" default="True"/>
</paramlist>
</method>
</class>
<class name="ClipboardLocker" oldname="wxClipboardLocker" module="misc">
+ <docstring>A helpful class for opening the clipboard and automatically closing it when
+the locker is destroyed.</docstring>
<constructor name="ClipboardLocker" overloaded="no">
<autodoc>__init__(Clipboard clipboard=None) -> ClipboardLocker</autodoc>
+ <docstring>A helpful class for opening the clipboard and automatically closing it when
+the locker is destroyed.</docstring>
<paramlist>
<param name="clipboard" type="Clipboard" default="NULL"/>
</paramlist>
</destructor>
<method name="__nonzero__" type="bool" overloaded="no">
<autodoc>__nonzero__() -> bool</autodoc>
+ <docstring>A ClipboardLocker instance evaluates to True if the clipboard was
+successfully opened.</docstring>
</method>
</class>
</module>
</method>
<method name="Refresh" type="" overloaded="no">
<autodoc>Refresh(bool eraseb=True, Rect rect=None)</autodoc>
+ <docstring>Mark the specified rectangle (or the whole window) as "dirty" so it
+will be repainted. Causes an EVT_PAINT event to be generated and sent
+to the window.</docstring>
<paramlist>
<param name="eraseb" type="bool" default="True"/>
<param name="rect" type="Rect" default="NULL"/>
</method>
<method name="SetTitle" type="" overloaded="no">
<autodoc>SetTitle(String title)</autodoc>
+ <docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeListCtrlNameStr) -> bool</autodoc>
+ <docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
projects / wxWidgets.git / blobdiff