EVT_CLOSE(self.frame, self.OnCloseWindow)
+ def OnCloseWindow(self, event):
+ if self.frame is not None:
+ self.frame.Destroy()
+ self.frame = None
+ self.text = None
+
+
# These methods provide the file-like output behaviour.
def write(self, text):
"""
wx.CallAfter(self.frame.Close)
- def OnCloseWindow(self, event):
- if self.frame is not None:
- self.frame.Destroy()
- self.frame = None
- self.text = None
#----------------------------------------------------------------------
self.RestoreStdio()
- def RedirectStdio(self, filename):
+ def RedirectStdio(self, filename=None):
"""Redirect sys.stdout and sys.stderr to a file or a popup window."""
if filename:
_sys.stdout = _sys.stderr = open(filename, 'a')
<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 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,
</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>
+ <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>
+ <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>
+ <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="SetWindowVariant" type="" overloaded="no">
+ <autodoc>SetWindowVariant(int variant)</autodoc>
+ <docstring>Sets the variant of the window/font size to use for this window,
+if the platform supports variants, (for example, wxMac.)</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default=""/>
+ </paramlist>
+ </method>
+ <method name="GetWindowVariant" type="wxWindowVariant" overloaded="no">
+ <autodoc>GetWindowVariant() -> int</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
<autodoc>SetId(int winid)</autodoc>
</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.
+ <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. Calls to Freeze/Thaw may be nested, with the actual Thaw
+being delayed until all the nesting has been undone.
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
</method>
<method name="Thaw" type="" overloaded="no">
<autodoc>Thaw()</autodoc>
- <docstring>Reenables window updating after a previous call to Freeze.</docstring>
+ <docstring>Reenables window updating after a previous call to Freeze. Calls to
+Freeze/Thaw may be nested, so Thaw must be called the same number of times
+that Freeze was before the window will be updated.</docstring>
</method>
<method name="PrepareDC" type="" overloaded="no">
<autodoc>PrepareDC(DC dc)</autodoc>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="isExposedRect" type="bool" overloaded="no">
- <autodoc>isExposedRect(Rect rect) -> bool</autodoc>
+ <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
</method>
<method name="GetFont" type="wxFont" overloaded="no">
<autodoc>GetFont() -> Font</autodoc>
- <docstring>Returns a reference to the font for this window.</docstring>
+ <docstring>Returns the default font used for this window.</docstring>
</method>
<method name="SetCaret" type="" overloaded="no">
<autodoc>SetCaret(Caret caret)</autodoc>
</paramlist>
</method>
<method name="Window_FromHWND" oldname="wxWindow_FromHWND" type="Window" overloaded="no">
- <autodoc>Window_FromHWND(unsigned long hWnd) -> Window</autodoc>
+ <autodoc>Window_FromHWND(Window parent, unsigned long _hWnd) -> Window</autodoc>
<paramlist>
- <param name="hWnd" type="unsigned long" default=""/>
+ <param name="parent" type="Window" default=""/>
+ <param name="_hWnd" type="unsigned long" default=""/>
</paramlist>
</method>
<pythoncode>
except NameError:
__builtins__.True = 1==1
__builtins__.False = 1==0
+ def bool(value): return not not value
+ __builtins__.bool = bool
class FutureCall:
"""
- A convenience class for wxTimer, that calls the given callable
+ A convenience class for wx.Timer, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
availbale after it has been run with the GetResult method.
self.callable = callable
self.SetArgs(*args, **kwargs)
self.runCount = 0
+ self.running = False
self.hasRun = False
self.result = None
self.timer = None
self.Stop()
self.timer = wx.PyTimer(self.Notify)
self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
+ self.running = True
Restart = Start
"""
if self.callable and getattr(self.callable, 'im_self', True):
self.runCount += 1
+ self.running = False
self.result = self.callable(*self.args, **self.kwargs)
self.hasRun = True
- wx.CallAfter(self.Stop)
+ if not self.running:
+ # if it wasn't restarted, then cleanup
+ wx.CallAfter(self.Stop)
#----------------------------------------------------------------------------
<param name="depth" type="int" default=""/>
</paramlist>
</method>
+ <method name="__eq__" type="bool" overloaded="no">
+ <autodoc>__eq__(Bitmap other) -> bool</autodoc>
+ <paramlist>
+ <param name="other" type="Bitmap" default=""/>
+ </paramlist>
+ </method>
+ <method name="__ne__" type="bool" overloaded="no">
+ <autodoc>__ne__(Bitmap other) -> bool</autodoc>
+ <paramlist>
+ <param name="other" type="Bitmap" default=""/>
+ </paramlist>
+ </method>
</class>
<class name="Mask" oldname="wxMask" module="gdi">
<docstring>This class encapsulates a monochrome mask bitmap, where the masked area is
</paramlist>
</method>
<method name="CreateStatusBar" type="wxStatusBar" overloaded="no">
- <autodoc>CreateStatusBar(int number=1, long style=ST_SIZEGRIP, int winid=0,
- String name=StatusLineNameStr) -> StatusBar</autodoc>
+ <autodoc>CreateStatusBar(int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ int winid=0, String name=StatusLineNameStr) -> StatusBar</autodoc>
<paramlist>
<param name="number" type="int" default="1"/>
- <param name="style" type="long" default="wxST_SIZEGRIP"/>
+ <param name="style" type="long" default="wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/>
<param name="winid" type="int" default="0"/>
<param name="name" type="String" default="wxPyStatusLineNameStr"/>
</paramlist>
<class name="StatusBar" oldname="wxStatusBar" module="windows">
<baseclass name="Window"/>
<constructor name="StatusBar" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> StatusBar</autodoc>
+ <autodoc>__init__(Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ String name=StatusLineNameStr) -> StatusBar</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
- <param name="style" type="long" default="wxST_SIZEGRIP"/>
+ <param name="style" type="long" default="wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/>
<param name="name" type="String" default="wxPyStatusLineNameStr"/>
</paramlist>
</constructor>
#---------------------------------------------------------------------------
</pythoncode>
<class name="SplitterWindow" oldname="wxSplitterWindow" module="windows">
+ <docstring>wx.SplitterWindow manages up to two subwindows or panes,
+with an optional vertical or horizontal split which can be
+used with the mouse or programmatically.
+</docstring>
+ <refdoc>
+ Styles
+ wx.SP_3D Draws a 3D effect border and sash.
+ wx.SP_3DSASH Draws a 3D effect sash.
+ wx.SP_3DBORDER Synonym for wxSP_BORDER.
+ wx.SP_BORDER Draws a standard border.
+ wx.SP_NOBORDER No border (default).
+ wx.SP_NO_XP_THEME Under Windows XP, switches off the
+ attempt to draw the splitter
+ using Windows XP theming, so the
+ borders and sash will take on the
+ pre-XP look.
+ wx.SP_PERMIT_UNSPLIT Always allow to unsplit, even with
+ the minimum pane size other than zero.
+ wx.SP_LIVE_UPDATE Don't draw XOR line but resize the
+ child windows immediately.
+
+ Events
+
+ EVT_SPLITTER_SASH_POS_CHANGING
+ The sash position is in the
+ process of being changed. May be
+ used to modify the position of
+ the tracking bar to properly
+ reflect the position that would
+ be set if the drag were to be
+ completed at this point.
+
+ EVT_SPLITTER_SASH_POS_CHANGED
+ The sash position was
+ changed. May be used to modify
+ the sash position before it is
+ set, or to prevent the change
+ from taking place.
+
+ EVT_SPLITTER_UNSPLIT The splitter has been just unsplit.
+
+ EVT_SPLITTER_DCLICK The sash was double clicked. The
+ default behaviour is to unsplit
+ the window when this happens
+ (unless the minimum pane size has
+ been set to a value greater than
+ zero.)
+
+</refdoc>
<baseclass name="Window"/>
<constructor name="SplitterWindow" overloaded="no">
<autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow</autodoc>
+ <docstring>Constructor. Creates and shows a SplitterWindow.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</constructor>
<constructor name="PreSplitterWindow" overloaded="no">
<autodoc>PreSplitterWindow() -> SplitterWindow</autodoc>
+ <docstring>Precreate a SplitterWindow 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=SP_3D, String name=SplitterNameStr) -> bool</autodoc>
+ <docstring>Create the GUI part of the SplitterWindow for the 2-phase create.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</method>
<method name="GetWindow1" type="Window" overloaded="no">
<autodoc>GetWindow1() -> Window</autodoc>
+ <docstring>Gets the only or left/top pane.</docstring>
</method>
<method name="GetWindow2" type="Window" overloaded="no">
<autodoc>GetWindow2() -> Window</autodoc>
+ <docstring>Gets the right/bottom pane.</docstring>
</method>
<method name="SetSplitMode" type="" overloaded="no">
<autodoc>SetSplitMode(int mode)</autodoc>
+ <docstring>Sets the split mode. The mode can be wx.SPLIT_VERTICAL or
+wx.SPLIT_HORIZONTAL. This only sets the internal variable;
+does not update the display.</docstring>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetSplitMode" type="wxSplitMode" overloaded="no">
<autodoc>GetSplitMode() -> int</autodoc>
+ <docstring>Gets the split mode</docstring>
</method>
<method name="Initialize" type="" overloaded="no">
<autodoc>Initialize(Window window)</autodoc>
+ <docstring>Initializes the splitter window to have one pane. This
+should be called if you wish to initially view only a single
+pane in the splitter window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="SplitVertically" type="bool" overloaded="no">
<autodoc>SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
+ <docstring>Initializes the left and right panes of the splitter window.
+
+ window1 The left pane.
+ window2 The right pane.
+ sashPosition The initial position of the sash. If this
+ value is positive, it specifies the size
+ of the left pane. If it is negative, it is
+ absolute value gives the size of the right
+ pane. Finally, specify 0 (default) to
+ choose the default position (half of the
+ total window width).
+
+Returns True if successful, False otherwise (the window was
+already split).
+
+SplitVertically should be called if you wish to initially
+view two panes. It can also be called at any subsequent
+time, but the application should check that the window is
+not currently split using IsSplit.</docstring>
<paramlist>
<param name="window1" type="Window" default=""/>
<param name="window2" type="Window" default=""/>
</method>
<method name="SplitHorizontally" type="bool" overloaded="no">
<autodoc>SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
+ <docstring>Initializes the top and bottom panes of the splitter window.
+
+ window1 The top pane.
+ window2 The bottom pane.
+ sashPosition The initial position of the sash. If this
+ value is positive, it specifies the size
+ of the upper pane. If it is negative, it
+ is absolute value gives the size of the
+ lower pane. Finally, specify 0 (default)
+ to choose the default position (half of
+ the total window height).
+
+Returns True if successful, False otherwise (the window was
+already split).
+
+SplitHorizontally should be called if you wish to initially
+view two panes. It can also be called at any subsequent
+time, but the application should check that the window is
+not currently split using IsSplit.</docstring>
<paramlist>
<param name="window1" type="Window" default=""/>
<param name="window2" type="Window" default=""/>
</method>
<method name="Unsplit" type="bool" overloaded="no">
<autodoc>Unsplit(Window toRemove=None) -> bool</autodoc>
+ <docstring>Unsplits the window. Pass the pane to remove, or None to
+remove the right or bottom pane. Returns True if
+successful, False otherwise (the window was not split).
+
+This function will not actually delete the pane being
+removed; it sends EVT_SPLITTER_UNSPLIT which can be handled
+for the desired behaviour. By default, the pane being
+removed is only hidden.</docstring>
<paramlist>
<param name="toRemove" type="Window" default="NULL"/>
</paramlist>
</method>
<method name="ReplaceWindow" type="bool" overloaded="no">
<autodoc>ReplaceWindow(Window winOld, Window winNew) -> bool</autodoc>
+ <docstring>This function replaces one of the windows managed by the
+SplitterWindow with another one. It is in general better to
+use it instead of calling Unsplit() and then resplitting the
+window back because it will provoke much less flicker. It is
+valid to call this function whether the splitter has two
+windows or only one.
+
+Both parameters should be non-None and winOld must specify
+one of the windows managed by the splitter. If the
+parameters are incorrect or the window couldn't be replaced,
+False is returned. Otherwise the function will return True,
+but please notice that it will not Destroy the replaced
+window and you may wish to do it yourself.</docstring>
<paramlist>
<param name="winOld" type="Window" default=""/>
<param name="winNew" type="Window" default=""/>
</paramlist>
</method>
+ <method name="UpdateSize" type="" overloaded="no">
+ <autodoc>UpdateSize()</autodoc>
+ <docstring>Causes any pending sizing of the sash and child panes to
+take place immediately.
+
+Such resizing normally takes place in idle time, in order to
+wait for layout to be completed. However, this can cause
+unacceptable flicker as the panes are resized after the
+window has been shown. To work around this, you can perform
+window layout (for example by sending a size event to the
+parent window), and then call this function, before showing
+the top-level window.</docstring>
+ </method>
<method name="IsSplit" type="bool" overloaded="no">
<autodoc>IsSplit() -> bool</autodoc>
+ <docstring>Is the window split?</docstring>
</method>
<method name="SetSashSize" type="" overloaded="no">
<autodoc>SetSashSize(int width)</autodoc>
+ <docstring>Sets the sash size</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetBorderSize" type="" overloaded="no">
<autodoc>SetBorderSize(int width)</autodoc>
+ <docstring>Sets the border size</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetSashSize" type="int" overloaded="no">
<autodoc>GetSashSize() -> int</autodoc>
+ <docstring>Gets the sash size</docstring>
</method>
<method name="GetBorderSize" type="int" overloaded="no">
<autodoc>GetBorderSize() -> int</autodoc>
+ <docstring>Gets the border size</docstring>
</method>
<method name="SetSashPosition" type="" overloaded="no">
<autodoc>SetSashPosition(int position, bool redraw=True)</autodoc>
+ <docstring>Sets the sash position, in pixels. If redraw is Ttrue then
+the panes are resized and the sash and border are redrawn.</docstring>
<paramlist>
<param name="position" type="int" default=""/>
<param name="redraw" type="bool" default="True"/>
</method>
<method name="GetSashPosition" type="int" overloaded="no">
<autodoc>GetSashPosition() -> int</autodoc>
+ <docstring>Returns the surrent sash position.</docstring>
</method>
<method name="SetMinimumPaneSize" type="" overloaded="no">
<autodoc>SetMinimumPaneSize(int min)</autodoc>
+ <docstring>Sets the minimum pane size in pixels.
+
+The default minimum pane size is zero, which means that
+either pane can be reduced to zero by dragging the sash,
+thus removing one of the panes. To prevent this behaviour (and
+veto out-of-range sash dragging), set a minimum size,
+for example 20 pixels. If the wx.SP_PERMIT_UNSPLIT style is
+used when a splitter window is created, the window may be
+unsplit even if minimum size is non-zero.</docstring>
<paramlist>
<param name="min" type="int" default=""/>
</paramlist>
</method>
<method name="GetMinimumPaneSize" type="int" overloaded="no">
<autodoc>GetMinimumPaneSize() -> int</autodoc>
+ <docstring>Gets the minimum pane size in pixels.</docstring>
</method>
<method name="SashHitTest" type="bool" overloaded="no">
<autodoc>SashHitTest(int x, int y, int tolerance=5) -> bool</autodoc>
+ <docstring>Tests for x, y over the sash</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</method>
<method name="SizeWindows" type="" overloaded="no">
<autodoc>SizeWindows()</autodoc>
+ <docstring>Resizes subwindows</docstring>
</method>
<method name="SetNeedUpdating" type="" overloaded="no">
<autodoc>SetNeedUpdating(bool needUpdating)</autodoc>
</method>
</class>
<class name="SplitterEvent" oldname="wxSplitterEvent" module="windows">
+ <docstring>This class represents the events generated by a splitter control.</docstring>
<baseclass name="NotifyEvent"/>
<constructor name="SplitterEvent" overloaded="no">
<autodoc>__init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent</autodoc>
+ <docstring>This class represents the events generated by a splitter control.</docstring>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="splitter" type="SplitterWindow" default="(wxSplitterWindow *) NULL"/>
</constructor>
<method name="SetSashPosition" type="" overloaded="no">
<autodoc>SetSashPosition(int pos)</autodoc>
+ <docstring>This funciton is only meaningful during
+EVT_SPLITTER_SASH_POS_CHANGING and
+EVT_SPLITTER_SASH_POS_CHANGED events. In the case of
+_CHANGED events, sets the the new sash position. In the case
+of _CHANGING events, sets the new tracking bar position so
+visual feedback during dragging will represent that change
+that will actually take place. Set to -1 from the event
+handler code to prevent repositioning.</docstring>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetSashPosition" type="int" overloaded="no">
<autodoc>GetSashPosition() -> int</autodoc>
+ <docstring>Returns the new sash position while in
+EVT_SPLITTER_SASH_POS_CHANGING and
+EVT_SPLITTER_SASH_POS_CHANGED events.</docstring>
</method>
<method name="GetWindowBeingRemoved" type="Window" overloaded="no">
<autodoc>GetWindowBeingRemoved() -> Window</autodoc>
+ <docstring>Returns a pointer to the window being removed when a
+splitter window is unsplit.</docstring>
</method>
<method name="GetX" type="int" overloaded="no">
<autodoc>GetX() -> int</autodoc>
+ <docstring>Returns the x coordinate of the double-click point in a
+EVT_SPLITTER_DCLICK event.</docstring>
</method>
<method name="GetY" type="int" overloaded="no">
<autodoc>GetY() -> int</autodoc>
+ <docstring>Returns the y coordinate of the double-click point in a
+EVT_SPLITTER_DCLICK event.</docstring>
</method>
</class>
<pythoncode>
EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, 1 )
EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, 1 )
EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_UNSPLIT, 1 )
+EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED
</pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
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"/>
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"/>
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=""/>
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=""/>
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 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,
</class>
<class name="PrintDialogData" oldname="wxPrintDialogData" module="windows">
<baseclass name="Object"/>
- <constructor name="PrintDialogData" overloaded="no">
- <autodoc>__init__() -> PrintDialogData</autodoc>
+ <constructor name="PrintDialogData" overloaded="yes"/>
+ <constructor name="PrintDialogData" overloaded="yes">
+ <autodoc>__init__() -> PrintDialogData
+__init__(PrintData printData) -> PrintDialogData</autodoc>
+ <paramlist>
+ <param name="printData" type="PrintData" default=""/>
+ </paramlist>
</constructor>
<destructor name="~wxPrintDialogData" overloaded="no">
<autodoc>__del__()</autodoc>
</class>
<class name="PrintPreview" oldname="wxPrintPreview" module="windows">
<baseclass name="Object"/>
- <constructor name="PrintPreview" overloaded="no">
- <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PrintPreview</autodoc>
+ <constructor name="PrintPreview" overloaded="yes">
+ <paramlist>
+ <param name="printout" type="Printout" default=""/>
+ <param name="printoutForPrinting" type="Printout" default=""/>
+ <param name="data" type="PrintDialogData" default="NULL"/>
+ </paramlist>
+ </constructor>
+ <constructor name="PrintPreview" overloaded="yes">
+ <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview
+__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview</autodoc>
<paramlist>
<param name="printout" type="Printout" default=""/>
<param name="printoutForPrinting" type="Printout" default=""/>
- <param name="data" type="PrintData" default="NULL"/>
+ <param name="data" type="PrintData" default=""/>
</paramlist>
</constructor>
<method name="SetCurrentPage" type="bool" overloaded="no">
</class>
<class name="PyPrintPreview" oldname="wxPyPrintPreview" module="windows">
<baseclass name="PrintPreview"/>
- <constructor name="PyPrintPreview" overloaded="no">
- <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PyPrintPreview</autodoc>
+ <constructor name="PyPrintPreview" overloaded="yes">
+ <paramlist>
+ <param name="printout" type="Printout" default=""/>
+ <param name="printoutForPrinting" type="Printout" default=""/>
+ <param name="data" type="PrintDialogData" default="NULL"/>
+ </paramlist>
+ </constructor>
+ <constructor name="PyPrintPreview" overloaded="yes">
+ <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview
+__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview</autodoc>
<paramlist>
<param name="printout" type="Printout" default=""/>
<param name="printoutForPrinting" type="Printout" default=""/>
- <param name="data" type="PrintData" default="NULL"/>
+ <param name="data" type="PrintData" default=""/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
the application needs more control, additional bitmaps for the selected state,
unpressed focused state, and greyed-out state may be supplied.
</docstring>
+ <refdoc>
+ Styles
+ wx.BU_AUTODRAW: If this is specified, the button will be drawn
+ automatically using the label bitmap only, providing a
+ 3D-look border. If this style is not specified, the button
+ will be drawn without borders and using all provided
+ bitmaps. WIN32 only.
+ wx.BU_LEFT: Left-justifies the label. WIN32 only.
+ wx.BU_TOP: Aligns the label to the top of the button. WIN32 only.
+ wx.BU_RIGHT: Right-justifies the bitmap label. WIN32 only.
+ wx.BU_BOTTOM: Aligns the label to the bottom of the button. WIN32 only.
+ wx.BU_EXACTFIT: Creates the button as small as possible instead of making
+ it of the standard size (which is the default behaviour.)
+
+ Events
+ EVT_BUTTON: Sent when the button is clicked.
+</refdoc>
<baseclass name="Button"/>
<constructor name="BitmapButton" overloaded="no">
<autodoc>__init__(Window parent, int id, Bitmap bitmap, 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 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,
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 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,
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 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,
<class name="Notebook" oldname="wxNotebook" module="controls">
<baseclass name="BookCtrl"/>
<constructor name="Notebook" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=NOTEBOOK_NAME) -> Notebook</autodoc>
+ <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<class name="Listbook" oldname="wxListbook" module="controls">
<baseclass name="BookCtrl"/>
<constructor name="Listbook" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=EmptyString) -> Listbook</autodoc>
+ <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</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>
+ <autodoc>SetForegroundColour(Colour col) -> bool</autodoc>
+ <paramlist>
+ <param name="col" type="Colour" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetBackgroundColour" type="bool" overloaded="no">
+ <autodoc>SetBackgroundColour(Colour col) -> bool</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
<param name="which" type="int" default=""/>
</paramlist>
</method>
+ <method name="InReportView" type="bool" overloaded="no">
+ <autodoc>InReportView() -> bool</autodoc>
+ </method>
<method name="IsVirtual" type="bool" overloaded="no">
<autodoc>IsVirtual() -> bool</autodoc>
</method>
<autodoc>__del__()</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(PyObject self, PyObject _class, int incref=1)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
+ <param name="incref" type="int" default="1"/>
</paramlist>
</method>
<method name="SetOwner" type="" overloaded="no">
<autodoc>GetId() -> int</autodoc>
</method>
</class>
- <pythoncode>
+ <pythoncode>
# For backwards compatibility with 2.4
class PyTimer(Timer):
def __init__(self, notify):
EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
-
+
</pythoncode>
<class name="TimerEvent" oldname="wxTimerEvent" module="misc">
<baseclass name="Event"/>
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.
+wx.ConfigBase organizes the items in a tree-like structure,
+modeled after the Unix/Dos filesystem. There are groups that act
+like directories and entries, key/value pairs that act like
+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>
<constructor name="Config" overloaded="no">
<autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
String localFilename=EmptyString, String globalFilename=EmptyString,
- long style=0) -> Config</autodoc>
+ long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> Config</autodoc>
<paramlist>
<param name="appName" type="String" default="wxPyEmptyString"/>
<param name="vendorName" type="String" default="wxPyEmptyString"/>
<param name="localFilename" type="String" default="wxPyEmptyString"/>
<param name="globalFilename" type="String" default="wxPyEmptyString"/>
- <param name="style" type="long" default="0"/>
+ <param name="style" type="long" default="wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/>
</paramlist>
</constructor>
<destructor name="~wxConfig" overloaded="no">
<constructor name="FileConfig" overloaded="no">
<autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
String localFilename=EmptyString, String globalFilename=EmptyString,
- long style=0) -> FileConfig</autodoc>
+ long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig</autodoc>
<paramlist>
<param name="appName" type="String" default="wxPyEmptyString"/>
<param name="vendorName" type="String" default="wxPyEmptyString"/>
<param name="localFilename" type="String" default="wxPyEmptyString"/>
<param name="globalFilename" type="String" default="wxPyEmptyString"/>
- <param name="style" type="long" default="0"/>
+ <param name="style" type="long" default="wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/>
</paramlist>
</constructor>
<destructor name="~wxFileConfig" overloaded="no">
successfully opened.</docstring>
</method>
</class>
+ <pythoncode>
+#---------------------------------------------------------------------------
+</pythoncode>
+ <class name="VideoMode" oldname="wxVideoMode" module="misc">
+ <docstring>A simple struct containing video mode parameters for a display</docstring>
+ <constructor name="VideoMode" overloaded="no">
+ <autodoc>__init__(int width=0, int height=0, int depth=0, int freq=0) -> VideoMode</autodoc>
+ <docstring>A simple struct containing video mode parameters for a display</docstring>
+ <paramlist>
+ <param name="width" type="int" default="0"/>
+ <param name="height" type="int" default="0"/>
+ <param name="depth" type="int" default="0"/>
+ <param name="freq" type="int" default="0"/>
+ </paramlist>
+ </constructor>
+ <destructor name="~wxVideoMode" overloaded="no">
+ <autodoc>__del__()</autodoc>
+ </destructor>
+ <method name="Matches" type="bool" overloaded="no">
+ <autodoc>Matches(VideoMode other) -> bool</autodoc>
+ <docstring>Returns true if this mode matches the other one in the sense that
+all non zero fields of the other mode have the same value in this
+one (except for refresh which is allowed to have a greater value)</docstring>
+ <paramlist>
+ <param name="other" type="VideoMode" default=""/>
+ </paramlist>
+ </method>
+ <method name="GetWidth" type="int" overloaded="no">
+ <autodoc>GetWidth() -> int</autodoc>
+ <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means
+unspecified</docstring>
+ </method>
+ <method name="GetHeight" type="int" overloaded="no">
+ <autodoc>GetHeight() -> int</autodoc>
+ <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means
+unspecified</docstring>
+ </method>
+ <method name="GetDepth" type="int" overloaded="no">
+ <autodoc>GetDepth() -> int</autodoc>
+ <docstring>Returns the screen's bits per pixel (e.g. 32), 1 is monochrome
+and 0 means unspecified/known</docstring>
+ </method>
+ <method name="IsOk" type="bool" overloaded="no">
+ <autodoc>IsOk() -> bool</autodoc>
+ <docstring>returns true if the object has been initialized</docstring>
+ </method>
+ <method name="__eq__" type="bool" overloaded="no">
+ <autodoc>__eq__(VideoMode other) -> bool</autodoc>
+ <paramlist>
+ <param name="other" type="VideoMode" default=""/>
+ </paramlist>
+ </method>
+ <method name="__ne__" type="bool" overloaded="no">
+ <autodoc>__ne__(VideoMode other) -> bool</autodoc>
+ <paramlist>
+ <param name="other" type="VideoMode" default=""/>
+ </paramlist>
+ </method>
+ <property name="w" type="int" readonly="no"/>
+ <property name="h" type="int" readonly="no"/>
+ <property name="bpp" type="int" readonly="no"/>
+ <property name="refresh" type="int" readonly="no"/>
+ </class>
+ <class name="Display" oldname="wxDisplay" module="misc">
+ <docstring>Represents a display/monitor attached to the system</docstring>
+ <constructor name="Display" overloaded="no">
+ <autodoc>__init__(size_t index=0) -> Display</autodoc>
+ <docstring>Set up a Display instance with the specified display. The
+displays are numbered from 0 to GetCount() - 1, 0 is always the
+primary display and the only one which is always supported</docstring>
+ <paramlist>
+ <param name="index" type="size_t" default="0"/>
+ </paramlist>
+ </constructor>
+ <destructor name="~wxDisplay" overloaded="no">
+ <autodoc>__del__()</autodoc>
+ </destructor>
+ <staticmethod name="GetCount" type="size_t" overloaded="no">
+ <autodoc>GetCount() -> size_t</autodoc>
+ <docstring>Return the number of available displays.</docstring>
+ </staticmethod>
+ <staticmethod name="GetFromPoint" type="int" overloaded="no">
+ <autodoc>GetFromPoint(Point pt) -> int</autodoc>
+ <docstring>Find the display where the given point lies, return wx.NOT_FOUND
+if it doesn't belong to any display</docstring>
+ <paramlist>
+ <param name="pt" type="Point" default=""/>
+ </paramlist>
+ </staticmethod>
+ <staticmethod name="GetFromWindow" type="int" overloaded="no">
+ <autodoc>GetFromWindow(Window window) -> int</autodoc>
+ <docstring>Find the display where the given window lies, return wx.NOT_FOUND
+if it is not shown at all.</docstring>
+ <paramlist>
+ <param name="window" type="Window" default=""/>
+ </paramlist>
+ </staticmethod>
+ <method name="IsOk" type="bool" overloaded="no">
+ <autodoc>IsOk() -> bool</autodoc>
+ <docstring>Return true if the object was initialized successfully</docstring>
+ </method>
+ <method name="GetGeometry" type="Rect" overloaded="no">
+ <autodoc>GetGeometry() -> Rect</autodoc>
+ <docstring>Returns the bounding rectangle of the display whose index was
+passed to the constructor.</docstring>
+ </method>
+ <method name="GetName" type="String" overloaded="no">
+ <autodoc>GetName() -> String</autodoc>
+ <docstring>Returns the display's name. A name is not available on all platforms.</docstring>
+ </method>
+ <method name="IsPrimary" type="bool" overloaded="no">
+ <autodoc>IsPrimary() -> bool</autodoc>
+ <docstring>Returns true if the display is the primary display. The primary
+display is the one whose index is 0.</docstring>
+ </method>
+ <method name="GetModes" type="PyObject" overloaded="no">
+ <autodoc>GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]</autodoc>
+ <docstring>Enumerate all video modes supported by this display matching the
+given one (in the sense of VideoMode.Match()).
+
+As any mode matches the default value of the argument and there
+is always at least one video mode supported by display, the
+returned array is only empty for the default value of the
+argument if this function is not supported at all on this
+platform.</docstring>
+ <paramlist>
+ <param name="mode" type="VideoMode" default="wxDefaultVideoMode"/>
+ </paramlist>
+ </method>
+ <method name="GetCurrentMode" type="VideoMode" overloaded="no">
+ <autodoc>GetCurrentMode() -> VideoMode</autodoc>
+ <docstring>Get the current video mode.</docstring>
+ </method>
+ <method name="ChangeMode" type="bool" overloaded="no">
+ <autodoc>ChangeMode(VideoMode mode=DefaultVideoMode) -> bool</autodoc>
+ <docstring>Change current mode, return true if succeeded, false otherwise</docstring>
+ <paramlist>
+ <param name="mode" type="VideoMode" default="wxDefaultVideoMode"/>
+ </paramlist>
+ </method>
+ <method name="ResetMode" type="" overloaded="no">
+ <autodoc>ResetMode()</autodoc>
+ <docstring>Restore the default video mode (just a more readable synonym)</docstring>
+ </method>
+ </class>
</module>
<module name="calendar">
<import name="misc"/>
long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
String name=CalendarNameStr) -> CalendarCtrl</autodoc>
<docstring>Create and show a calendar control.</docstring>
- <refdoc>The CalendarCtrl displays a window containing several parts: the control to
-pick the month and the year at the top (either or both of them may be
-disabled) and a month area below them which shows all the days in the
-month. The user can move the current selection using the keyboard and select
-the date (generating EVT_CALENDAR event) by pressing <Return> or double
-clicking it.
-
-It has advanced possibilities for the customization of its display. All global
-settings (such as colours and fonts used) can, of course, be changed. But
-also, the display style for each day in the month can be set independently
-using CalendarDateAttr class.
-
-An item without custom attributes is drawn with the default colours and font
-and without border, but setting custom attributes with SetAttr allows to
-modify its appearance. Just create a custom attribute object and set it for
-the day you want to be displayed specially A day may be marked as being a
-holiday, (even if it is not recognized as one by wx.DateTime) by using the
-SetHoliday method.
-
-As the attributes are specified for each day, they may change when the month
-is changed, so you will often want to update them in an EVT_CALENDAR_MONTH
-event handler.
-
- Styles
- CAL_SUNDAY_FIRST: Show Sunday as the first day in the week
- CAL_MONDAY_FIRST: Show Monday as the first day in the week
- CAL_SHOW_HOLIDAYS: Highlight holidays in the calendar
- CAL_NO_YEAR_CHANGE: Disable the year changing
- CAL_NO_MONTH_CHANGE: Disable the month (and, implicitly, the year) changing
- CAL_SHOW_SURROUNDING_WEEKS: Show the neighbouring weeks in the previous and next months
- CAL_SEQUENTIAL_MONTH_SELECTION: Use alternative, more compact, style for the month and year selection controls.
-
-The default calendar style is wxCAL_SHOW_HOLIDAYS.
-
- Events
- EVT_CALENDAR: A day was double clicked in the calendar.
- EVT_CALENDAR_SEL_CHANGED: The selected date changed.
- EVT_CALENDAR_DAY: The selected day changed.
- EVT_CALENDAR_MONTH: The selected month changed.
- EVT_CALENDAR_YEAR: The selected year changed.
- EVT_CALENDAR_WEEKDAY_CLICKED: User clicked on the week day header
-
-Note that changing the selected date will result in either of
-EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event.
-
-</refdoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
<constructor name="PreCalendarCtrl" overloaded="no">
<autodoc>PreCalendarCtrl() -> CalendarCtrl</autodoc>
<docstring>Precreate a CalendarCtrl for 2-phase creation.</docstring>
- <refdoc>The CalendarCtrl displays a window containing several parts: the control to
-pick the month and the year at the top (either or both of them may be
-disabled) and a month area below them which shows all the days in the
-month. The user can move the current selection using the keyboard and select
-the date (generating EVT_CALENDAR event) by pressing <Return> or double
-clicking it.
-
-It has advanced possibilities for the customization of its display. All global
-settings (such as colours and fonts used) can, of course, be changed. But
-also, the display style for each day in the month can be set independently
-using CalendarDateAttr class.
-
-An item without custom attributes is drawn with the default colours and font
-and without border, but setting custom attributes with SetAttr allows to
-modify its appearance. Just create a custom attribute object and set it for
-the day you want to be displayed specially A day may be marked as being a
-holiday, (even if it is not recognized as one by wx.DateTime) by using the
-SetHoliday method.
-
-As the attributes are specified for each day, they may change when the month
-is changed, so you will often want to update them in an EVT_CALENDAR_MONTH
-event handler.
-
- Styles
- CAL_SUNDAY_FIRST: Show Sunday as the first day in the week
- CAL_MONDAY_FIRST: Show Monday as the first day in the week
- CAL_SHOW_HOLIDAYS: Highlight holidays in the calendar
- CAL_NO_YEAR_CHANGE: Disable the year changing
- CAL_NO_MONTH_CHANGE: Disable the month (and, implicitly, the year) changing
- CAL_SHOW_SURROUNDING_WEEKS: Show the neighbouring weeks in the previous and next months
- CAL_SEQUENTIAL_MONTH_SELECTION: Use alternative, more compact, style for the month and year selection controls.
-
-The default calendar style is wxCAL_SHOW_HOLIDAYS.
-
- Events
- EVT_CALENDAR: A day was double clicked in the calendar.
- EVT_CALENDAR_SEL_CHANGED: The selected date changed.
- EVT_CALENDAR_DAY: The selected day changed.
- EVT_CALENDAR_MONTH: The selected month changed.
- EVT_CALENDAR_YEAR: The selected year changed.
- EVT_CALENDAR_WEEKDAY_CLICKED: User clicked on the week day header
-
-Note that changing the selected date will result in either of
-EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event.
-
-</refdoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
<autodoc>Create(Window parent, int id, DateTime date=DefaultDateTime,
<method name="ForceRefresh" type="" overloaded="no">
<autodoc>ForceRefresh()</autodoc>
</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"/>
- </paramlist>
- </method>
<method name="IsEditable" type="bool" overloaded="no">
<autodoc>IsEditable() -> bool</autodoc>
</method>
<method name="GetDescent" type="int" overloaded="no">
<autodoc>GetDescent() -> int</autodoc>
</method>
+ <method name="GetMaxTotalWidth" type="int" overloaded="no">
+ <autodoc>GetMaxTotalWidth() -> int</autodoc>
+ </method>
<method name="GetId" type="String" overloaded="no">
<autodoc>GetId() -> String</autodoc>
</method>
</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>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
+ <method name="LineDown" type="" overloaded="no">
+ <autodoc>LineDown()</autodoc>
+ <docstring>This is just a wrapper for ScrollLines(1).</docstring>
+ </method>
+ <method name="LineDownExtend" type="" overloaded="no">
+ <autodoc>LineDownExtend()</autodoc>
+ </method>
+ <method name="LineUp" type="" overloaded="no">
+ <autodoc>LineUp()</autodoc>
+ <docstring>This is just a wrapper for ScrollLines(-1).</docstring>
+ </method>
+ <method name="LineUpExtend" type="" overloaded="no">
+ <autodoc>LineUpExtend()</autodoc>
+ </method>
+ <method name="CharLeft" type="" overloaded="no">
+ <autodoc>CharLeft()</autodoc>
+ </method>
+ <method name="CharLeftExtend" type="" overloaded="no">
+ <autodoc>CharLeftExtend()</autodoc>
+ </method>
+ <method name="CharRight" type="" overloaded="no">
+ <autodoc>CharRight()</autodoc>
+ </method>
+ <method name="CharRightExtend" type="" overloaded="no">
+ <autodoc>CharRightExtend()</autodoc>
+ </method>
+ <method name="WordLeft" type="" overloaded="no">
+ <autodoc>WordLeft()</autodoc>
+ </method>
+ <method name="WordLeftExtend" type="" overloaded="no">
+ <autodoc>WordLeftExtend()</autodoc>
+ </method>
+ <method name="WordRight" type="" overloaded="no">
+ <autodoc>WordRight()</autodoc>
+ </method>
+ <method name="WordRightExtend" type="" overloaded="no">
+ <autodoc>WordRightExtend()</autodoc>
+ </method>
+ <method name="Home" type="" overloaded="no">
+ <autodoc>Home()</autodoc>
+ </method>
+ <method name="HomeExtend" type="" overloaded="no">
+ <autodoc>HomeExtend()</autodoc>
+ </method>
+ <method name="LineEnd" type="" overloaded="no">
+ <autodoc>LineEnd()</autodoc>
+ </method>
+ <method name="LineEndExtend" type="" overloaded="no">
+ <autodoc>LineEndExtend()</autodoc>
+ </method>
+ <method name="DocumentStart" type="" overloaded="no">
+ <autodoc>DocumentStart()</autodoc>
+ </method>
+ <method name="DocumentStartExtend" type="" overloaded="no">
+ <autodoc>DocumentStartExtend()</autodoc>
+ </method>
+ <method name="DocumentEnd" type="" overloaded="no">
+ <autodoc>DocumentEnd()</autodoc>
+ </method>
+ <method name="DocumentEndExtend" type="" overloaded="no">
+ <autodoc>DocumentEndExtend()</autodoc>
+ </method>
+ <method name="PageUp" type="" overloaded="no">
+ <autodoc>PageUp()</autodoc>
+ <docstring>This is just a wrapper for ScrollPages(-1).</docstring>
+ </method>
+ <method name="PageUpExtend" type="" overloaded="no">
+ <autodoc>PageUpExtend()</autodoc>
+ </method>
+ <method name="PageDown" type="" overloaded="no">
+ <autodoc>PageDown()</autodoc>
+ <docstring>This is just a wrapper for ScrollPages(1).</docstring>
+ </method>
+ <method name="PageDownExtend" type="" overloaded="no">
+ <autodoc>PageDownExtend()</autodoc>
+ </method>
+ <method name="EditToggleOvertype" type="" overloaded="no">
+ <autodoc>EditToggleOvertype()</autodoc>
+ </method>
+ <method name="Cancel" type="" overloaded="no">
+ <autodoc>Cancel()</autodoc>
+ </method>
+ <method name="DeleteBack" type="" overloaded="no">
+ <autodoc>DeleteBack()</autodoc>
+ </method>
+ <method name="Tab" type="" overloaded="no">
+ <autodoc>Tab()</autodoc>
+ </method>
+ <method name="BackTab" type="" overloaded="no">
+ <autodoc>BackTab()</autodoc>
+ </method>
+ <method name="NewLine" type="" overloaded="no">
+ <autodoc>NewLine()</autodoc>
+ </method>
+ <method name="FormFeed" type="" overloaded="no">
+ <autodoc>FormFeed()</autodoc>
+ </method>
+ <method name="VCHome" type="" overloaded="no">
+ <autodoc>VCHome()</autodoc>
+ </method>
+ <method name="VCHomeExtend" type="" overloaded="no">
+ <autodoc>VCHomeExtend()</autodoc>
+ </method>
+ <method name="ZoomIn" type="" overloaded="no">
+ <autodoc>ZoomIn()</autodoc>
+ </method>
+ <method name="ZoomOut" type="" overloaded="no">
+ <autodoc>ZoomOut()</autodoc>
+ </method>
+ <method name="DelWordLeft" type="" overloaded="no">
+ <autodoc>DelWordLeft()</autodoc>
+ </method>
+ <method name="DelWordRight" type="" overloaded="no">
+ <autodoc>DelWordRight()</autodoc>
+ </method>
+ <method name="LineCut" type="" overloaded="no">
+ <autodoc>LineCut()</autodoc>
+ </method>
+ <method name="LineDelete" type="" overloaded="no">
+ <autodoc>LineDelete()</autodoc>
+ </method>
+ <method name="LineTranspose" type="" overloaded="no">
+ <autodoc>LineTranspose()</autodoc>
+ </method>
<method name="LineDuplicate" type="" overloaded="no">
<autodoc>LineDuplicate()</autodoc>
</method>
+ <method name="LowerCase" type="" overloaded="no">
+ <autodoc>LowerCase()</autodoc>
+ </method>
+ <method name="UpperCase" type="" overloaded="no">
+ <autodoc>UpperCase()</autodoc>
+ </method>
+ <method name="LineScrollDown" type="" overloaded="no">
+ <autodoc>LineScrollDown()</autodoc>
+ </method>
+ <method name="LineScrollUp" type="" overloaded="no">
+ <autodoc>LineScrollUp()</autodoc>
+ </method>
+ <method name="DeleteBackNotLine" type="" overloaded="no">
+ <autodoc>DeleteBackNotLine()</autodoc>
+ </method>
<method name="HomeDisplay" type="" overloaded="no">
<autodoc>HomeDisplay()</autodoc>
</method>
<method name="LineEndDisplayExtend" type="" overloaded="no">
<autodoc>LineEndDisplayExtend()</autodoc>
</method>
+ <method name="HomeWrap" type="" overloaded="no">
+ <autodoc>HomeWrap()</autodoc>
+ </method>
+ <method name="HomeWrapExtend" type="" overloaded="no">
+ <autodoc>HomeWrapExtend()</autodoc>
+ </method>
+ <method name="LineEndWrap" type="" overloaded="no">
+ <autodoc>LineEndWrap()</autodoc>
+ </method>
+ <method name="LineEndWrapExtend" type="" overloaded="no">
+ <autodoc>LineEndWrapExtend()</autodoc>
+ </method>
+ <method name="VCHomeWrap" type="" overloaded="no">
+ <autodoc>VCHomeWrap()</autodoc>
+ </method>
+ <method name="VCHomeWrapExtend" type="" overloaded="no">
+ <autodoc>VCHomeWrapExtend()</autodoc>
+ </method>
<method name="LineCopy" type="" overloaded="no">
<autodoc>LineCopy()</autodoc>
</method>
<param name="singleLine" type="bool" default=""/>
</paramlist>
</method>
+ <method name="ParaDown" type="" overloaded="no">
+ <autodoc>ParaDown()</autodoc>
+ </method>
+ <method name="ParaDownExtend" type="" overloaded="no">
+ <autodoc>ParaDownExtend()</autodoc>
+ </method>
+ <method name="ParaUp" type="" overloaded="no">
+ <autodoc>ParaUp()</autodoc>
+ </method>
+ <method name="ParaUpExtend" type="" overloaded="no">
+ <autodoc>ParaUpExtend()</autodoc>
+ </method>
<method name="PositionBefore" type="int" overloaded="no">
<autodoc>PositionBefore(int pos) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
+ <method name="LineDownRectExtend" type="" overloaded="no">
+ <autodoc>LineDownRectExtend()</autodoc>
+ </method>
+ <method name="LineUpRectExtend" type="" overloaded="no">
+ <autodoc>LineUpRectExtend()</autodoc>
+ </method>
+ <method name="CharLeftRectExtend" type="" overloaded="no">
+ <autodoc>CharLeftRectExtend()</autodoc>
+ </method>
+ <method name="CharRightRectExtend" type="" overloaded="no">
+ <autodoc>CharRightRectExtend()</autodoc>
+ </method>
+ <method name="HomeRectExtend" type="" overloaded="no">
+ <autodoc>HomeRectExtend()</autodoc>
+ </method>
+ <method name="VCHomeRectExtend" type="" overloaded="no">
+ <autodoc>VCHomeRectExtend()</autodoc>
+ </method>
+ <method name="LineEndRectExtend" type="" overloaded="no">
+ <autodoc>LineEndRectExtend()</autodoc>
+ </method>
+ <method name="PageUpRectExtend" type="" overloaded="no">
+ <autodoc>PageUpRectExtend()</autodoc>
+ </method>
+ <method name="PageDownRectExtend" type="" overloaded="no">
+ <autodoc>PageDownRectExtend()</autodoc>
+ </method>
+ <method name="StutteredPageUp" type="" overloaded="no">
+ <autodoc>StutteredPageUp()</autodoc>
+ </method>
+ <method name="StutteredPageUpExtend" type="" overloaded="no">
+ <autodoc>StutteredPageUpExtend()</autodoc>
+ </method>
+ <method name="StutteredPageDown" type="" overloaded="no">
+ <autodoc>StutteredPageDown()</autodoc>
+ </method>
+ <method name="StutteredPageDownExtend" type="" overloaded="no">
+ <autodoc>StutteredPageDownExtend()</autodoc>
+ </method>
+ <method name="WordLeftEnd" type="" overloaded="no">
+ <autodoc>WordLeftEnd()</autodoc>
+ </method>
+ <method name="WordLeftEndExtend" type="" overloaded="no">
+ <autodoc>WordLeftEndExtend()</autodoc>
+ </method>
+ <method name="WordRightEnd" type="" overloaded="no">
+ <autodoc>WordRightEnd()</autodoc>
+ </method>
+ <method name="WordRightEndExtend" type="" overloaded="no">
+ <autodoc>WordRightEndExtend()</autodoc>
+ </method>
<method name="SetWhitespaceChars" type="" overloaded="no">
<autodoc>SetWhitespaceChars(String characters)</autodoc>
<paramlist>