| | |
- Frame(TopLevelWindow)
-
- TestFrame
- Shell(EditWindow)
-
- UpdatingShell
class TestFrame(Frame) |
| |
Base frame for the wx-based test framework
This is to be reminiscent of the wxPython demo in
a lot of ways.
Left-side, a list control with the available tests
Right-upper side, the Context window, hosted by a panel
Right-lower side, an output window
|
| |
- Method resolution order:
- TestFrame
- Frame
- TopLevelWindow
- Window
- EvtHandler
- Object
- object
Methods defined here:
- CreateContext(self, parent)
- Create the VRML browser context
- CreateControls(self, style=None)
- Create the controls for the frame
- CreateMenus(self)
- Create our application menu-bars
- CreateSelectionControl(self, parent)
- Create and populate the test-list control
- CreateShellControl(self, parent)
- Create the base shell control for the testing application
- CreateShellEnvironment(self)
- Create the working shell environment
- OnAddCommand(self, event)
- Add VRML97 nodes from a file
- OnExitCommand(self, event)
- Exit from the browser
- OnOpenCommand(self, event)
- Open a file-selection dialog to load a file
- UpdateShellVariables(self, **named)
- Update shell's local variables from named arguments
- __init__(self, parent=None, id=-1, title='OpenGLContext Visual Shell', pos=wx.Point(-1, -1), size=(600, 450), style=541072960, name='mainframe')
Data and other attributes defined here:
- currentTestIndex = 0
Methods inherited from Frame:
- Command = ProcessCommand(*args, **kwargs)
- ProcessCommand(self, int winid) -> bool
- Create(*args, **kwargs)
- Create(self, Window parent, int id=-1, String title=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> bool
- CreateStatusBar(*args, **kwargs)
- CreateStatusBar(self, int number=1, long style=DEFAULT_STATUSBAR_STYLE, int winid=0,
String name=StatusLineNameStr) -> StatusBar
- CreateToolBar(*args, **kwargs)
- CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar
- DoGiveHelp(*args, **kwargs)
- DoGiveHelp(self, String text, bool show)
- DoMenuUpdates(*args, **kwargs)
- DoMenuUpdates(self, Menu menu=None)
- GetMenuBar(*args, **kwargs)
- GetMenuBar(self) -> MenuBar
- GetStatusBar(*args, **kwargs)
- GetStatusBar(self) -> StatusBar
- GetStatusBarPane(*args, **kwargs)
- GetStatusBarPane(self) -> int
- GetToolBar(*args, **kwargs)
- GetToolBar(self) -> wxToolBar
- PopStatusText(*args, **kwargs)
- PopStatusText(self, int number=0)
- ProcessCommand(*args, **kwargs)
- ProcessCommand(self, int winid) -> bool
- PushStatusText(*args, **kwargs)
- PushStatusText(self, String text, int number=0)
- SendSizeEvent(*args, **kwargs)
- SendSizeEvent(self)
- SetMenuBar(*args, **kwargs)
- SetMenuBar(self, MenuBar menubar)
- SetStatusBar(*args, **kwargs)
- SetStatusBar(self, StatusBar statBar)
- SetStatusBarPane(*args, **kwargs)
- SetStatusBarPane(self, int n)
- SetStatusText(*args, **kwargs)
- SetStatusText(self, String text, int number=0)
- SetStatusWidths(*args, **kwargs)
- SetStatusWidths(self, int widths)
- SetToolBar(*args, **kwargs)
- SetToolBar(self, wxToolBar toolbar)
- __repr__ = _swig_repr(self)
Static methods inherited from Frame:
- GetClassDefaultAttributes(*args, **kwargs)
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want
to use the same font or colour in your own control as in a standard
control -- which is a much better idea than hard coding specific
colours or fonts which might look completely out of place on the
user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See `wx.Window.SetWindowVariant` for more about
this.
Data descriptors inherited from Frame:
- MenuBar
- See `GetMenuBar` and `SetMenuBar`
- StatusBar
- See `GetStatusBar` and `SetStatusBar`
- StatusBarPane
- See `GetStatusBarPane` and `SetStatusBarPane`
- ToolBar
- See `GetToolBar` and `SetToolBar`
- thisown
- The membership flag
Methods inherited from TopLevelWindow:
- CenterOnScreen(*args, **kwargs)
- CenterOnScreen(self, int dir=BOTH)
Center the window on screen
- CentreOnScreen = CenterOnScreen(*args, **kwargs)
- CenterOnScreen(self, int dir=BOTH)
Center the window on screen
- EnableCloseButton(*args, **kwargs)
- EnableCloseButton(self, bool enable) -> bool
- GetDefaultItem(*args, **kwargs)
- GetDefaultItem(self) -> Window
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.
- GetIcon(*args, **kwargs)
- GetIcon(self) -> Icon
- GetTitle(*args, **kwargs)
- GetTitle(self) -> String
- GetTmpDefaultItem(*args, **kwargs)
- GetTmpDefaultItem(self) -> Window
Return the temporary default item, which can be None.
- Iconize(*args, **kwargs)
- Iconize(self, bool iconize=True)
- IsActive(*args, **kwargs)
- IsActive(self) -> bool
- IsAlwaysMaximized(*args, **kwargs)
- IsAlwaysMaximized(self) -> bool
- IsFullScreen(*args, **kwargs)
- IsFullScreen(self) -> bool
- IsIconized(*args, **kwargs)
- IsIconized(self) -> bool
- IsMaximized(*args, **kwargs)
- IsMaximized(self) -> bool
- MacGetMetalAppearance(*args, **kwargs)
- MacGetMetalAppearance(self) -> bool
- MacGetTopLevelWindowRef(*args, **kwargs)
- MacGetTopLevelWindowRef(self) -> long
- MacGetUnifiedAppearance(*args, **kwargs)
- MacGetUnifiedAppearance(self) -> bool
- MacSetMetalAppearance(*args, **kwargs)
- MacSetMetalAppearance(self, bool on)
- Maximize(*args, **kwargs)
- Maximize(self, bool maximize=True)
- RequestUserAttention(*args, **kwargs)
- RequestUserAttention(self, int flags=USER_ATTENTION_INFO)
- Restore(*args, **kwargs)
- Restore(self)
- SetDefaultItem(*args, **kwargs)
- SetDefaultItem(self, Window child) -> Window
Set this child as default, return the old default.
- SetIcon(*args, **kwargs)
- SetIcon(self, Icon icon)
- SetIcons(*args, **kwargs)
- SetIcons(self, wxIconBundle icons)
- SetShape(*args, **kwargs)
- SetShape(self, Region region) -> bool
- SetTitle(*args, **kwargs)
- SetTitle(self, String title)
- SetTmpDefaultItem(*args, **kwargs)
- SetTmpDefaultItem(self, Window win)
Set this child as temporary default
- ShowFullScreen(*args, **kwargs)
- ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool
Data descriptors inherited from TopLevelWindow:
- DefaultItem
- See `GetDefaultItem` and `SetDefaultItem`
- Icon
- See `GetIcon` and `SetIcon`
- Title
- See `GetTitle` and `SetTitle`
- TmpDefaultItem
- See `GetTmpDefaultItem` and `SetTmpDefaultItem`
Methods inherited from Window:
- AcceptsFocus(*args, **kwargs)
- AcceptsFocus(self) -> bool
Can this window have focus?
- AcceptsFocusFromKeyboard(*args, **kwargs)
- AcceptsFocusFromKeyboard(self) -> bool
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.
- AddChild(*args, **kwargs)
- AddChild(self, Window child)
Adds a child window. This is called automatically by window creation
functions so should not be required by the application programmer.
- AdjustForLayoutDirection(*args, **kwargs)
- AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
Mirror coordinates for RTL layout if this window uses it and if the
mirroring is not done automatically like Win32.
- AssociateHandle(*args, **kwargs)
- AssociateHandle(self, long handle)
Associate the window with a new native handle
- CacheBestSize(*args, **kwargs)
- CacheBestSize(self, Size size)
Cache the best size so it doesn't need to be calculated again, (at least until
some properties of the window change.)
- CanSetTransparent(*args, **kwargs)
- CanSetTransparent(self) -> bool
Returns ``True`` if the platform supports setting the transparency for
this window. Note that this method will err on the side of caution,
so it is possible that this will return ``False`` when it is in fact
possible to set the transparency.
NOTE: On X-windows systems the X server must have the composite
extension loaded, and there must be a composite manager program (such
as xcompmgr) running.
- CaptureMouse(*args, **kwargs)
- CaptureMouse(self)
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, unless the window
receives the `wx.MouseCaptureLostEvent` event.
Any application which captures the mouse in the beginning of some
operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
operation when it receives the event. The event handler must not
recapture mouse.
- Center(*args, **kwargs)
- Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for
centering, 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.
- CenterOnParent(*args, **kwargs)
- CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
- Centre = Center(*args, **kwargs)
- Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for
centering, 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.
- CentreOnParent = CenterOnParent(*args, **kwargs)
- CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
- ClearBackground(*args, **kwargs)
- ClearBackground(self)
Clears the window by filling it with the current background
colour. Does not cause an erase background event to be generated.
- ClientToScreen(*args, **kwargs)
- ClientToScreen(self, Point pt) -> Point
Converts to screen coordinates from coordinates relative to this window.
- ClientToScreenXY(*args, **kwargs)
- ClientToScreenXY(int x, int y) -> (x,y)
Converts to screen coordinates from coordinates relative to this window.
- ClientToWindowSize(*args, **kwargs)
- ClientToWindowSize(self, Size size) -> Size
- Close(*args, **kwargs)
- Close(self, bool force=False) -> bool
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.
- ConvertDialogPointToPixels(*args, **kwargs)
- ConvertDialogPointToPixels(self, Point pt) -> Point
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.
- ConvertDialogSizeToPixels(*args, **kwargs)
- ConvertDialogSizeToPixels(self, Size sz) -> Size
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.
- ConvertPixelPointToDialog(*args, **kwargs)
- ConvertPixelPointToDialog(self, Point pt) -> Point
- ConvertPixelSizeToDialog(*args, **kwargs)
- ConvertPixelSizeToDialog(self, Size sz) -> Size
- DLG_PNT(*args, **kwargs)
- DLG_PNT(self, Point pt) -> Point
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.
- DLG_SZE(*args, **kwargs)
- DLG_SZE(self, Size sz) -> Size
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.
- Destroy(*args, **kwargs)
- Destroy(self) -> bool
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.
- DestroyChildren(*args, **kwargs)
- DestroyChildren(self) -> bool
Destroys all children of a window. Called automatically by the
destructor.
- Disable(*args, **kwargs)
- Disable(self) -> bool
Disables the window, same as Enable(false).
- DissociateHandle(*args, **kwargs)
- DissociateHandle(self)
Dissociate the current native handle from the window
- DragAcceptFiles(*args, **kwargs)
- DragAcceptFiles(self, bool accept)
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
- Enable(*args, **kwargs)
- Enable(self, bool enable=True) -> bool
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.
- FindWindowById(*args, **kwargs)
- FindWindowById(self, long winid) -> Window
Find a child of this window by window ID
- FindWindowByLabel(*args, **kwargs)
- FindWindowByLabel(self, String label) -> Window
Find a child of this window by label
- FindWindowByName(*args, **kwargs)
- FindWindowByName(self, String name) -> Window
Find a child of this window by name
- Fit(*args, **kwargs)
- Fit(self)
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.
- FitInside(*args, **kwargs)
- FitInside(self)
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.
- Freeze(*args, **kwargs)
- Freeze(self)
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
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.
- GetAcceleratorTable(*args, **kwargs)
- GetAcceleratorTable(self) -> AcceleratorTable
Gets the accelerator table for this window.
- GetAdjustedBestSize = deprecatedWrapper(*args, **kwargs)
- Use `GetEffectiveMinSize` instead.
- GetAutoLayout(*args, **kwargs)
- GetAutoLayout(self) -> bool
Returns the current autoLayout setting
- GetBackgroundColour(*args, **kwargs)
- GetBackgroundColour(self) -> Colour
Returns the background colour of the window.
- GetBackgroundStyle(*args, **kwargs)
- GetBackgroundStyle(self) -> int
Returns the background style of the window.
:see: `SetBackgroundStyle`
- GetBestFittingSize = deprecatedWrapper(*args, **kwargs)
- Use `GetEffectiveMinSize` instead.
- GetBestSize(*args, **kwargs)
- GetBestSize(self) -> Size
This function 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 (such as wx.Panel), the size returned by
this function will be the same as the size the window would have had
after calling Fit.
- GetBestSizeTuple(*args, **kwargs)
- GetBestSizeTuple() -> (width, height)
This function 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 (such as wx.Panel), the size returned by
this function will be the same as the size the window would have had
after calling Fit.
- GetBestVirtualSize(*args, **kwargs)
- GetBestVirtualSize(self) -> Size
Return the largest of ClientSize and BestSize (as determined by a
sizer, interior children, or other means)
- GetBorder(*args)
- GetBorder(self, long flags) -> int
GetBorder(self) -> int
Get border for the flags of this window
- GetCaret(*args, **kwargs)
- GetCaret(self) -> Caret
Returns the caret associated with the window.
- GetCharHeight(*args, **kwargs)
- GetCharHeight(self) -> int
Get the (average) character size for the current font.
- GetCharWidth(*args, **kwargs)
- GetCharWidth(self) -> int
Get the (average) character size for the current font.
- GetChildren(*args, **kwargs)
- GetChildren(self) -> WindowList
Returns an object containing a list of the window's children. The
object provides a Python sequence-like interface over the internal
list maintained by the window..
- GetClientAreaOrigin(*args, **kwargs)
- GetClientAreaOrigin(self) -> Point
Get the origin of the client area of the window relative to the
window's top left corner (the client area may be shifted because of
the borders, scrollbars, other decorations...)
- GetClientRect(*args, **kwargs)
- GetClientRect(self) -> Rect
Get the client area position and size as a `wx.Rect` object.
- GetClientSize(*args, **kwargs)
- GetClientSize(self) -> Size
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.
- GetClientSizeTuple(*args, **kwargs)
- GetClientSizeTuple() -> (width, height)
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.
- GetConstraints(*args, **kwargs)
- GetConstraints(self) -> LayoutConstraints
Returns a pointer to the window's layout constraints, or None if there
are none.
- GetContainingSizer(*args, **kwargs)
- GetContainingSizer(self) -> Sizer
Return the sizer that this window is a member of, if any, otherwise None.
- GetCursor(*args, **kwargs)
- GetCursor(self) -> Cursor
Return the cursor associated with this window.
- GetDefaultAttributes(*args, **kwargs)
- GetDefaultAttributes(self) -> VisualAttributes
Get the default attributes for an instance of this class. This is
useful if you want to use the same font or colour in your own control
as in a standard control -- which is a much better idea than hard
coding specific colours or fonts which might look completely out of
place on the user's system, especially if it uses themes.
- GetDropTarget(*args, **kwargs)
- GetDropTarget(self) -> DropTarget
Returns the associated drop target, which may be None.
- GetEffectiveMinSize(*args, **kwargs)
- GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's
minimum size, giving priority to the min size components, and returns
the results.
- GetEventHandler(*args, **kwargs)
- GetEventHandler(self) -> EvtHandler
Returns the event handler for this window. By default, the window is
its own event handler.
- GetExtraStyle(*args, **kwargs)
- GetExtraStyle(self) -> long
Returns the extra style bits for the window.
- GetFont(*args, **kwargs)
- GetFont(self) -> Font
Returns the default font used for this window.
- GetForegroundColour(*args, **kwargs)
- GetForegroundColour(self) -> Colour
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.
- GetFullTextExtent(*args, **kwargs)
- GetFullTextExtent(String string, Font font=None) ->
(width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the
current or specified font.
- GetGrandParent(*args, **kwargs)
- GetGrandParent(self) -> Window
Returns the parent of the parent of this window, or None if there
isn't one.
- GetGtkWidget(*args, **kwargs)
- GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long
integer. On the other platforms this method returns zero.
- GetHandle(*args, **kwargs)
- GetHandle(self) -> long
Returns the platform-specific handle (as a long integer) of the
physical window. On wxMSW this is the win32 window handle, on wxGTK
it is the XWindow ID, and on wxMac it is the ControlRef.
- GetHelpText(*args, **kwargs)
- GetHelpText(self) -> String
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
`wx.HelpProvider` implementation, and not in the window object itself.
- GetHelpTextAtPoint(*args, **kwargs)
- GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown
and this method should return the global window help text then
- GetId(*args, **kwargs)
- GetId(self) -> int
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.
- GetLabel(*args, **kwargs)
- GetLabel(self) -> String
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.
- GetLayoutDirection(*args, **kwargs)
- GetLayoutDirection(self) -> int
Get the layout direction (LTR or RTL) for this window. Returns
``wx.Layout_Default`` if layout direction is not supported.
- GetMaxHeight(*args, **kwargs)
- GetMaxHeight(self) -> int
- GetMaxSize(*args, **kwargs)
- GetMaxSize(self) -> Size
- GetMaxWidth(*args, **kwargs)
- GetMaxWidth(self) -> int
- GetMinHeight(*args, **kwargs)
- GetMinHeight(self) -> int
- GetMinSize(*args, **kwargs)
- GetMinSize(self) -> Size
- GetMinWidth(*args, **kwargs)
- GetMinWidth(self) -> int
- GetName(*args, **kwargs)
- GetName(self) -> String
Returns the windows 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.
- GetParent(*args, **kwargs)
- GetParent(self) -> Window
Returns the parent window of this window, or None if there isn't one.
- GetPosition(*args, **kwargs)
- GetPosition(self) -> Point
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use `GetScreenPosition` if you need screen coordinates for all
kinds of windows.
- GetPositionTuple(*args, **kwargs)
- GetPositionTuple() -> (x,y)
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use `GetScreenPosition` if you need screen coordinates for all
kinds of windows.
- GetRect(*args, **kwargs)
- GetRect(self) -> Rect
Returns the size and position of the window as a `wx.Rect` object.
- GetScreenPosition(*args, **kwargs)
- GetScreenPosition(self) -> Point
Get the position of the window in screen coordinantes.
- GetScreenPositionTuple(*args, **kwargs)
- GetScreenPositionTuple() -> (x,y)
Get the position of the window in screen coordinantes.
- GetScreenRect(*args, **kwargs)
- GetScreenRect(self) -> Rect
Returns the size and position of the window in screen coordinantes as
a `wx.Rect` object.
- GetScrollPos(*args, **kwargs)
- GetScrollPos(self, int orientation) -> int
Returns the built-in scrollbar position.
- GetScrollRange(*args, **kwargs)
- GetScrollRange(self, int orientation) -> int
Returns the built-in scrollbar range.
- GetScrollThumb(*args, **kwargs)
- GetScrollThumb(self, int orientation) -> int
Returns the built-in scrollbar thumb size.
- GetSize(*args, **kwargs)
- GetSize(self) -> Size
Get the window size.
- GetSizeTuple(*args, **kwargs)
- GetSizeTuple() -> (width, height)
Get the window size.
- GetSizer(*args, **kwargs)
- GetSizer(self) -> Sizer
Return the sizer associated with the window by a previous call to
SetSizer or None if there isn't one.
- GetTextExtent(*args, **kwargs)
- GetTextExtent(String string) -> (width, height)
Get the width and height of the text using the current font.
- GetThemeEnabled(*args, **kwargs)
- GetThemeEnabled(self) -> bool
Return the themeEnabled flag.
- GetToolTip(*args, **kwargs)
- GetToolTip(self) -> ToolTip
get the associated tooltip or None if none
- GetToolTipString(self)
- GetTopLevelParent(*args, **kwargs)
- GetTopLevelParent(self) -> Window
Returns the first frame or dialog in this window's parental hierarchy.
- GetUpdateClientRect(*args, **kwargs)
- GetUpdateClientRect(self) -> Rect
Get the update rectangle region bounding box in client coords.
- GetUpdateRegion(*args, **kwargs)
- GetUpdateRegion(self) -> Region
Returns the region specifying which parts of the window have been
damaged. Should only be called within an EVT_PAINT handler.
- GetValidator(*args, **kwargs)
- GetValidator(self) -> Validator
Returns a pointer to the current validator for the window, or None if
there is none.
- GetVirtualSize(*args, **kwargs)
- GetVirtualSize(self) -> Size
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.
- GetVirtualSizeTuple(*args, **kwargs)
- GetVirtualSizeTuple() -> (width, height)
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.
- GetWindowBorderSize(*args, **kwargs)
- GetWindowBorderSize(self) -> Size
Return the size of the left/right and top/bottom borders.
- GetWindowStyle = GetWindowStyleFlag(*args, **kwargs)
- GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create
method.
- GetWindowStyleFlag(*args, **kwargs)
- GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create
method.
- GetWindowVariant(*args, **kwargs)
- GetWindowVariant(self) -> int
- HasCapture(*args, **kwargs)
- HasCapture(self) -> bool
Returns true if this window has the current mouse capture.
- HasFlag(*args, **kwargs)
- HasFlag(self, int flag) -> bool
Test if the given style is set for this window.
- HasMultiplePages(*args, **kwargs)
- HasMultiplePages(self) -> bool
- HasScrollbar(*args, **kwargs)
- HasScrollbar(self, int orient) -> bool
Does the window have the scrollbar for this orientation?
- HasTransparentBackground(*args, **kwargs)
- HasTransparentBackground(self) -> bool
Returns True if this window's background is transparent (as, for
example, for `wx.StaticText`) and should show the parent window's
background.
This method is mostly used internally by the library itself and you
normally shouldn't have to call it. You may, however, have to override
it in your custom control classes to ensure that background is painted
correctly.
- Hide(*args, **kwargs)
- Hide(self) -> bool
Equivalent to calling Show(False).
- HitTest(*args, **kwargs)
- HitTest(self, Point pt) -> int
Test where the given (in client coords) point lies
- HitTestXY(*args, **kwargs)
- HitTestXY(self, int x, int y) -> int
Test where the given (in client coords) point lies
- InheritAttributes(*args, **kwargs)
- InheritAttributes(self)
This function is (or should be, in case of custom controls) called
during window creation to intelligently set up the window visual
attributes, that is the font and the foreground and background
colours.
By 'intelligently' the following is meant: by default, all windows use
their own default attributes. However if some of the parent's
attributes are explicitly changed (that is, using SetFont and not
SetOwnFont) and if the corresponding attribute hadn't been
explicitly set for this window itself, then this window takes the same
value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might.
This rather complicated logic is necessary in order to accommodate the
different usage scenarios. The most common one is when all default
attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours)
than their siblings so they can't inherit the same value from the
parent. However it was also deemed desirable to allow to simply change
the attributes of all children at once by just changing the font or
colour of their common parent, hence in this case we do inherit the
parents attributes.
- InheritsBackgroundColour(*args, **kwargs)
- InheritsBackgroundColour(self) -> bool
- InitDialog(*args, **kwargs)
- InitDialog(self)
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
to the dialog via validators.
- InvalidateBestSize(*args, **kwargs)
- InvalidateBestSize(self)
Reset the cached best size value so it will be recalculated the next
time it is needed.
- IsBeingDeleted(*args, **kwargs)
- IsBeingDeleted(self) -> bool
Is the window in the process of being deleted?
- IsDoubleBuffered(*args, **kwargs)
- IsDoubleBuffered(self) -> bool
Returns ``True`` if the window contents is double-buffered by the
system, i.e. if any drawing done on the window is really done on a
temporary backing surface and transferred to the screen all at once
later.
- IsEnabled(*args, **kwargs)
- IsEnabled(self) -> bool
Returns true if the window is enabled for input, false otherwise.
- IsExposed(*args, **kwargs)
- IsExposed(self, int x, int y, int w=1, int h=1) -> bool
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.
- IsExposedPoint(*args, **kwargs)
- IsExposedPoint(self, Point pt) -> bool
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.
- IsExposedRect(*args, **kwargs)
- IsExposedRect(self, Rect rect) -> bool
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.
- IsFrozen(*args, **kwargs)
- IsFrozen(self) -> bool
Returns ``True`` if the window has been frozen and not thawed yet.
:see: `Freeze` and `Thaw`
- IsRetained(*args, **kwargs)
- IsRetained(self) -> bool
Returns true if the window is retained, false otherwise. Retained
windows are only available on X platforms.
- IsShown(*args, **kwargs)
- IsShown(self) -> bool
Returns true if the window is shown, false if it has been hidden.
- IsShownOnScreen(*args, **kwargs)
- IsShownOnScreen(self) -> bool
Returns ``True`` if the window is physically visible on the screen,
i.e. it is shown and all its parents up to the toplevel window are
shown as well.
- IsTopLevel(*args, **kwargs)
- IsTopLevel(self) -> bool
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).
- Layout(*args, **kwargs)
- Layout(self) -> bool
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.
- LineDown(*args, **kwargs)
- LineDown(self) -> bool
This is just a wrapper for ScrollLines(1).
- LineUp(*args, **kwargs)
- LineUp(self) -> bool
This is just a wrapper for ScrollLines(-1).
- Lower(*args, **kwargs)
- Lower(self)
Lowers the window to the bottom of the window hierarchy. In current
version of wxWidgets this works both for managed and child windows.
- MakeModal(*args, **kwargs)
- MakeModal(self, bool modal=True)
Disables all other windows in the application so that the user can
only interact with this window. Passing False will reverse this
effect.
- Move(*args, **kwargs)
- Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- MoveAfterInTabOrder(*args, **kwargs)
- MoveAfterInTabOrder(self, Window win)
Moves this window in the tab navigation order after the specified
sibling window. This means that when the user presses the TAB key on
that other window, the focus switches to this window.
The default tab order is the same as creation order. This function
and `MoveBeforeInTabOrder` allow to change it after creating all the
windows.
- MoveBeforeInTabOrder(*args, **kwargs)
- MoveBeforeInTabOrder(self, Window win)
Same as `MoveAfterInTabOrder` except that it inserts this window just
before win instead of putting it right after it.
- MoveXY(*args, **kwargs)
- MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- Navigate(*args, **kwargs)
- Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
Does keyboard navigation from this window to another, by sending a
`wx.NavigationKeyEvent`.
- PageDown(*args, **kwargs)
- PageDown(self) -> bool
This is just a wrapper for ScrollPages(1).
- PageUp(*args, **kwargs)
- PageUp(self) -> bool
This is just a wrapper for ScrollPages(-1).
- PopEventHandler(*args, **kwargs)
- PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
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, and ``None`` will be returned instead.
- PopupMenu(*args, **kwargs)
- PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
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. If the default position is given then the current position of the
mouse cursor will be used.
- PopupMenuXY(*args, **kwargs)
- PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
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. If the default position is given then the current position of the
mouse cursor will be used.
- PostCreate(self, pre)
- Phase 3 of the 2-phase create <wink!>
Call this method after precreating the window with the 2-phase create method.
- PrepareDC(*args, **kwargs)
- PrepareDC(self, DC dc)
Call this function to prepare the device context for drawing a
scrolled image. It sets the device origin according to the current
scroll position.
- PushEventHandler(*args, **kwargs)
- PushEventHandler(self, EvtHandler handler)
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. (In other words, is able to dispatch the events to a
handler function.) 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. Ownership of the handler is *not* given
to the window, so you should be sure to pop the handler before the
window is destroyed and either let PopEventHandler destroy it, or call
its Destroy method yourself.
- Raise(*args, **kwargs)
- Raise(self)
Raises the window to the top of the window hierarchy. In current
version of wxWidgets this works both for managed and child windows.
- Refresh(*args, **kwargs)
- Refresh(self, bool eraseBackground=True, Rect rect=None)
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.
- RefreshRect(*args, **kwargs)
- RefreshRect(self, Rect rect, bool eraseBackground=True)
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.
- RegisterHotKey(*args, **kwargs)
- RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
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.
- ReleaseMouse(*args, **kwargs)
- ReleaseMouse(self)
Releases mouse input captured with wx.Window.CaptureMouse.
- RemoveChild(*args, **kwargs)
- RemoveChild(self, Window child)
Removes a child window. This is called automatically by window
deletion functions so should not be required by the application
programmer.
- RemoveEventHandler(*args, **kwargs)
- RemoveEventHandler(self, EvtHandler handler) -> bool
Find the given handler in the event handler chain and remove (but not
delete) it from the event handler chain, returns 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.)
- Reparent(*args, **kwargs)
- Reparent(self, Window newParent) -> bool
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)
- ScreenToClient(*args, **kwargs)
- ScreenToClient(self, Point pt) -> Point
Converts from screen to client window coordinates.
- ScreenToClientXY(*args, **kwargs)
- ScreenToClientXY(int x, int y) -> (x,y)
Converts from screen to client window coordinates.
- ScrollLines(*args, **kwargs)
- ScrollLines(self, int lines) -> bool
If the platform and window class supports it, scrolls the window by
the given number of lines down, if lines is positive, or up if lines
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.
- ScrollPages(*args, **kwargs)
- ScrollPages(self, int pages) -> bool
If the platform and window class supports it, scrolls the window by
the given number of pages down, if pages is positive, or up if pages
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.
- ScrollWindow(*args, **kwargs)
- ScrollWindow(self, int dx, int dy, Rect rect=None)
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.
- SetAcceleratorTable(*args, **kwargs)
- SetAcceleratorTable(self, AcceleratorTable accel)
Sets the accelerator table for this window.
- SetAutoLayout(*args, **kwargs)
- SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
when the window is resized. lease note that this only happens for the
windows usually used to contain children, namely `wx.Panel` and
`wx.TopLevelWindow` (and the classes deriving from them).
This method 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.
- SetBackgroundColour(*args, **kwargs)
- SetBackgroundColour(self, Colour colour) -> bool
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. Using `wx.NullColour` will reset the window
to the default background colour.
Note that setting the background colour may not cause an immediate
refresh, so you may wish to call `ClearBackground` or `Refresh` after
calling this function.
Using this function will disable attempts to use themes for this
window, if the system supports them. Use with care since usually the
themes represent the appearance chosen by the user to be used for all
applications on the system.
- SetBackgroundStyle(*args, **kwargs)
- SetBackgroundStyle(self, int style) -> bool
Returns the background style of the window. The background style
indicates how the background of the window is drawn.
====================== ========================================
wx.BG_STYLE_SYSTEM The background colour or pattern should
be determined by the system
wx.BG_STYLE_COLOUR The background should be a solid colour
wx.BG_STYLE_CUSTOM The background will be implemented by the
application.
====================== ========================================
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
a custom background, such as a tiled bitmap. Currently the style has
no effect on other platforms.
:see: `GetBackgroundStyle`, `SetBackgroundColour`
- SetBestFittingSize = deprecatedWrapper(*args, **kwargs)
- Use `SetInitialSize`
- SetCaret(*args, **kwargs)
- SetCaret(self, Caret caret)
Sets the caret associated with the window.
- SetClientRect(*args, **kwargs)
- SetClientRect(self, Rect rect)
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.
- SetClientSize(*args, **kwargs)
- SetClientSize(self, Size size)
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.
- SetClientSizeWH(*args, **kwargs)
- SetClientSizeWH(self, int width, int height)
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.
- SetConstraints(*args, **kwargs)
- SetConstraints(self, LayoutConstraints constraints)
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.
- SetContainingSizer(*args, **kwargs)
- SetContainingSizer(self, Sizer sizer)
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.
- SetCursor(*args, **kwargs)
- SetCursor(self, Cursor cursor) -> bool
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.
- SetDimensions(*args, **kwargs)
- SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels. The sizeFlags
parameter indicates the interpretation of the other params if they are
equal to -1.
======================== ======================================
wx.SIZE_AUTO A -1 indicates that a class-specific
default should 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.
======================== ======================================
- SetDoubleBuffered(*args, **kwargs)
- SetDoubleBuffered(self, bool on)
Put the native window into double buffered or composited mode.
- SetDropTarget(*args, **kwargs)
- SetDropTarget(self, DropTarget dropTarget)
Associates a drop target with this window. If the window already has
a drop target, it is deleted.
- SetEventHandler(*args, **kwargs)
- SetEventHandler(self, EvtHandler handler)
Sets the event handler for this window. An event handler is an object
that is capable of processing the events sent to a window. (In other
words, is able to dispatch the events to handler function.) 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 off to the next one in the chain.
- SetExtraStyle(*args, **kwargs)
- SetExtraStyle(self, long exStyle)
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()
- SetFocus(*args, **kwargs)
- SetFocus(self)
Set's the focus to this window, allowing it to receive keyboard input.
- SetFocusFromKbd(*args, **kwargs)
- SetFocusFromKbd(self)
Set focus to this window as the result of a keyboard action. Normally
only called internally.
- SetFont(*args, **kwargs)
- SetFont(self, Font font) -> bool
Sets the font for this window.
- SetForegroundColour(*args, **kwargs)
- SetForegroundColour(self, Colour colour) -> bool
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.
- SetHelpText(*args, **kwargs)
- SetHelpText(self, String text)
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
`wx.HelpProvider` implementation, and not in the window object itself.
- SetHelpTextForId(*args, **kwargs)
- SetHelpTextForId(self, String text)
Associate this help text with all windows with the same id as this
one.
- SetId(*args, **kwargs)
- SetId(self, int winid)
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.
- SetInitialSize(*args, **kwargs)
- SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the
window's *best size* values. Also set's the minsize for use with sizers.
- SetLabel(*args, **kwargs)
- SetLabel(self, String label)
Set the text which the window shows in its label if applicable.
- SetLayoutDirection(*args, **kwargs)
- SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
- SetMaxSize(*args, **kwargs)
- SetMaxSize(self, Size maxSize)
A more convenient method than `SetSizeHints` for setting just the
max size.
- SetMinSize(*args, **kwargs)
- SetMinSize(self, Size minSize)
A more convenient method than `SetSizeHints` for setting just the
min size.
- SetName(*args, **kwargs)
- SetName(self, String name)
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
- SetOwnBackgroundColour(*args, **kwargs)
- SetOwnBackgroundColour(self, Colour colour)
- SetOwnFont(*args, **kwargs)
- SetOwnFont(self, Font font)
- SetOwnForegroundColour(*args, **kwargs)
- SetOwnForegroundColour(self, Colour colour)
- SetPosition = Move(*args, **kwargs)
- Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- SetRect(*args, **kwargs)
- SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels using a wx.Rect.
- SetScrollPos(*args, **kwargs)
- SetScrollPos(self, int orientation, int pos, bool refresh=True)
Sets the position of one of the built-in scrollbars.
- SetScrollbar(*args, **kwargs)
- SetScrollbar(self, int orientation, int position, int thumbSize, int range,
bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
- SetSize(*args, **kwargs)
- SetSize(self, Size size)
Sets the size of the window in pixels.
- SetSizeHints(*args, **kwargs)
- SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
int incH=-1)
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 (if it is
a top-level window.) Sizers will also inspect the minimum window size
and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
- SetSizeHintsSz(*args, **kwargs)
- SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
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 (if it is
a top-level window.) Sizers will also inspect the minimum window size
and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
- SetSizeWH(*args, **kwargs)
- SetSizeWH(self, int width, int height)
Sets the size of the window in pixels.
- SetSizer(*args, **kwargs)
- SetSizer(self, Sizer sizer, bool deleteOld=True)
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-None, and False otherwise.
- SetSizerAndFit(*args, **kwargs)
- SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
The same as SetSizer, except it also sets the size hints for the
window based on the sizer's minimum size.
- SetThemeEnabled(*args, **kwargs)
- SetThemeEnabled(self, bool enableTheme)
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.
- SetToolTip(*args, **kwargs)
- SetToolTip(self, ToolTip tip)
Attach a tooltip to the window.
- SetToolTipString(*args, **kwargs)
- SetToolTipString(self, String tip)
Attach a tooltip to the window.
- SetTransparent(*args, **kwargs)
- SetTransparent(self, byte alpha) -> bool
Attempt to set the transparency of this window to the ``alpha`` value,
returns True on success. The ``alpha`` value is an integer in the
range of 0 to 255, where 0 is fully transparent and 255 is fully
opaque.
- SetValidator(*args, **kwargs)
- SetValidator(self, Validator validator)
Deletes the current validator (if any) and sets the window validator,
having called wx.Validator.Clone to create a new validator of this
type.
- SetVirtualSize(*args, **kwargs)
- SetVirtualSize(self, Size size)
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.
- SetVirtualSizeHints(*args, **kwargs)
- SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
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.
- SetVirtualSizeHintsSz(*args, **kwargs)
- SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
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.
- SetVirtualSizeWH(*args, **kwargs)
- SetVirtualSizeWH(self, int w, int h)
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.
- SetWindowStyle = SetWindowStyleFlag(*args, **kwargs)
- SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be
changed after the window creation and that Refresh() might need to be
called after changing the others for the change to take place
immediately.
- SetWindowStyleFlag(*args, **kwargs)
- SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be
changed after the window creation and that Refresh() might need to be
called after changing the others for the change to take place
immediately.
- SetWindowVariant(*args, **kwargs)
- SetWindowVariant(self, int variant)
Sets the variant of the window/font size to use for this window, if
the platform supports variants, for example, wxMac.
- ShouldInheritColours(*args, **kwargs)
- ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be
changed by InheritAttributes, returning false forbids inheriting them
from the parent window.
The base class version returns false, but this method is overridden in
wxControl where it returns true.
- Show(*args, **kwargs)
- Show(self, bool show=True) -> bool
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.
- Thaw(*args, **kwargs)
- Thaw(self)
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.
- ToggleWindowStyle(*args, **kwargs)
- ToggleWindowStyle(self, int flag) -> bool
Turn the flag on if it had been turned off before and vice versa,
returns True if the flag is turned on by this function call.
- TransferDataFromWindow(*args, **kwargs)
- TransferDataFromWindow(self) -> bool
Transfers values from child controls to data areas specified by their
validators. Returns false if a transfer failed. If the window has
wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
also call TransferDataFromWindow() of all child windows.
- TransferDataToWindow(*args, **kwargs)
- TransferDataToWindow(self) -> bool
Transfers values to child controls from data areas specified by their
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
style flag set, the method will also call TransferDataToWindow() of
all child windows.
- UnregisterHotKey(*args, **kwargs)
- UnregisterHotKey(self, int hotkeyId) -> bool
Unregisters a system wide hotkey.
- Update(*args, **kwargs)
- Update(self)
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.
- UpdateWindowUI(*args, **kwargs)
- UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
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.
- UseBgCol(*args, **kwargs)
- UseBgCol(self) -> bool
- Validate(*args, **kwargs)
- Validate(self) -> bool
Validates the current values of the child controls using their
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
style flag set, the method will also call Validate() of all child
windows. Returns false if any of the validations failed.
- WarpPointer(*args, **kwargs)
- WarpPointer(self, int x, int y)
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.
- WindowToClientSize(*args, **kwargs)
- WindowToClientSize(self, Size size) -> Size
Static methods inherited from Window:
- FindFocus(*args, **kwargs)
- FindFocus() -> Window
Returns the window or control that currently has the keyboard focus,
or None.
- GetCapture(*args, **kwargs)
- GetCapture() -> Window
Returns the window which currently captures the mouse or None
- NewControlId(*args, **kwargs)
- NewControlId() -> int
Generate a control id for the controls which were not given one.
- NextControlId(*args, **kwargs)
- NextControlId(int winid) -> int
Get the id of the control following the one with the given
autogenerated) id
- PrevControlId(*args, **kwargs)
- PrevControlId(int winid) -> int
Get the id of the control preceding the one with the given
autogenerated) id
Data descriptors inherited from Window:
- AcceleratorTable
- See `GetAcceleratorTable` and `SetAcceleratorTable`
- AutoLayout
- See `GetAutoLayout` and `SetAutoLayout`
- BackgroundColour
- See `GetBackgroundColour` and `SetBackgroundColour`
- BackgroundStyle
- See `GetBackgroundStyle` and `SetBackgroundStyle`
- BestSize
- See `GetBestSize`
- BestVirtualSize
- See `GetBestVirtualSize`
- Border
- See `GetBorder`
- Caret
- See `GetCaret` and `SetCaret`
- CharHeight
- See `GetCharHeight`
- CharWidth
- See `GetCharWidth`
- Children
- See `GetChildren`
- ClientAreaOrigin
- See `GetClientAreaOrigin`
- ClientRect
- See `GetClientRect` and `SetClientRect`
- ClientSize
- See `GetClientSize` and `SetClientSize`
- Constraints
- See `GetConstraints` and `SetConstraints`
- ContainingSizer
- See `GetContainingSizer` and `SetContainingSizer`
- Cursor
- See `GetCursor` and `SetCursor`
- DefaultAttributes
- See `GetDefaultAttributes`
- DropTarget
- See `GetDropTarget` and `SetDropTarget`
- EffectiveMinSize
- See `GetEffectiveMinSize`
- Enabled
- See `IsEnabled` and `Enable`
- EventHandler
- See `GetEventHandler` and `SetEventHandler`
- ExtraStyle
- See `GetExtraStyle` and `SetExtraStyle`
- Font
- See `GetFont` and `SetFont`
- ForegroundColour
- See `GetForegroundColour` and `SetForegroundColour`
- GrandParent
- See `GetGrandParent`
- GtkWidget
- GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long
integer. On the other platforms this method returns zero.
- Handle
- See `GetHandle`
- HelpText
- See `GetHelpText` and `SetHelpText`
- Id
- See `GetId` and `SetId`
- Label
- See `GetLabel` and `SetLabel`
- LayoutDirection
- See `GetLayoutDirection` and `SetLayoutDirection`
- MaxHeight
- See `GetMaxHeight`
- MaxSize
- See `GetMaxSize` and `SetMaxSize`
- MaxWidth
- See `GetMaxWidth`
- MinHeight
- See `GetMinHeight`
- MinSize
- See `GetMinSize` and `SetMinSize`
- MinWidth
- See `GetMinWidth`
- Name
- See `GetName` and `SetName`
- Parent
- See `GetParent`
- Position
- See `GetPosition` and `SetPosition`
- Rect
- See `GetRect` and `SetRect`
- ScreenPosition
- See `GetScreenPosition`
- ScreenRect
- See `GetScreenRect`
- Shown
- See `IsShown` and `Show`
- Size
- See `GetSize` and `SetSize`
- Sizer
- See `GetSizer` and `SetSizer`
- ThemeEnabled
- See `GetThemeEnabled` and `SetThemeEnabled`
- ToolTip
- See `GetToolTip` and `SetToolTip`
- ToolTipString
- TopLevel
- See `IsTopLevel`
- TopLevelParent
- See `GetTopLevelParent`
- UpdateClientRect
- See `GetUpdateClientRect`
- UpdateRegion
- See `GetUpdateRegion`
- Validator
- See `GetValidator` and `SetValidator`
- VirtualSize
- See `GetVirtualSize` and `SetVirtualSize`
- WindowStyle
- See `GetWindowStyle` and `SetWindowStyle`
- WindowStyleFlag
- See `GetWindowStyleFlag` and `SetWindowStyleFlag`
- WindowVariant
- See `GetWindowVariant` and `SetWindowVariant`
Methods inherited from EvtHandler:
- AddPendingEvent(*args, **kwargs)
- AddPendingEvent(self, Event event)
- Bind(self, event, handler, source=None, id=-1, id2=-1)
- Bind an event to an event handler.
:param event: One of the EVT_* objects that specifies the
type of event to bind,
:param handler: A callable object to be invoked when the
event is delivered to self. Pass None to
disconnect an event handler.
:param source: Sometimes the event originates from a
different window than self, but you still
want to catch it in self. (For example, a
button event delivered to a frame.) By
passing the source of the event, the event
handling system is able to differentiate
between the same event type from different
controls.
:param id: Used to spcify the event source by ID instead
of instance.
:param id2: Used when it is desirable to bind a handler
to a range of IDs, such as with EVT_MENU_RANGE.
- Connect(*args, **kwargs)
- Connect(self, int id, int lastId, int eventType, PyObject func)
- Disconnect(*args, **kwargs)
- Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL,
PyObject func=None) -> bool
- GetEvtHandlerEnabled(*args, **kwargs)
- GetEvtHandlerEnabled(self) -> bool
- GetNextHandler(*args, **kwargs)
- GetNextHandler(self) -> EvtHandler
- GetPreviousHandler(*args, **kwargs)
- GetPreviousHandler(self) -> EvtHandler
- ProcessEvent(*args, **kwargs)
- ProcessEvent(self, Event event) -> bool
- ProcessPendingEvents(*args, **kwargs)
- ProcessPendingEvents(self)
- SetEvtHandlerEnabled(*args, **kwargs)
- SetEvtHandlerEnabled(self, bool enabled)
- SetNextHandler(*args, **kwargs)
- SetNextHandler(self, EvtHandler handler)
- SetPreviousHandler(*args, **kwargs)
- SetPreviousHandler(self, EvtHandler handler)
- Unbind(self, event, source=None, id=-1, id2=-1, handler=None)
- Disconnects the event handler binding for event from self.
Returns True if successful.
Data descriptors inherited from EvtHandler:
- EvtHandlerEnabled
- See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`
- NextHandler
- See `GetNextHandler` and `SetNextHandler`
- PreviousHandler
- See `GetPreviousHandler` and `SetPreviousHandler`
Methods inherited from Object:
- GetClassName(*args, **kwargs)
- GetClassName(self) -> String
Returns the class name of the C++ class using wxRTTI.
- IsSameAs(*args, **kwargs)
- IsSameAs(self, Object p) -> bool
For wx.Objects that use C++ reference counting internally, this method
can be used to determine if two objects are referencing the same data
object.
Data descriptors inherited from Object:
- ClassName
- See `GetClassName`
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class UpdatingShell(Shell) |
| | |
- Method resolution order:
- UpdatingShell
- Shell
- EditWindow
- StyledTextCtrl
- Control
- Window
- EvtHandler
- Object
- object
Methods defined here:
- push(self, command)
- Send command to the interpreter for execution.
Methods inherited from Shell:
- CanCut(self)
- Return true if text is selected and can be cut.
- CanEdit(self)
- Return true if editing should succeed.
- CanPaste(self)
- Return true if a paste should succeed.
- Copy(self)
- Copy selection and place it on the clipboard.
- CopyWithPrompts(self)
- Copy selection, including prompts, and place it on the clipboard.
- CopyWithPromptsPrefixed(self)
- Copy selection, including prompts prefixed with four
spaces, and place it on the clipboard.
- Cut(self)
- Remove selection and place it on the clipboard.
- Execute(self, text)
- Replace selection with text and run commands.
- GetContextMenu(self)
- Create and return a context menu for the shell.
This is used instead of the scintilla default menu
in order to correctly respect our immutable buffer.
- LoadSettings(self, config)
- OnCallTipAutoCompleteManually(self, shiftDown)
- AutoComplete and Calltips manually.
- OnChar(self, event)
- Keypress event handler.
Only receives an event if OnKeyDown calls event.Skip() for the
corresponding event.
- OnContextMenu(self, evt)
- OnHistoryInsert(self, step)
- Insert the previous/next command from the history buffer.
- OnHistoryReplace(self, step)
- Replace with the previous/next command from the history buffer.
- OnHistorySearch(self)
- Search up the history buffer for the text in front of the cursor.
- OnIdle(self, event)
- Free the CPU to do other things.
- OnKeyDown(self, event)
- Key down event handler.
- OnShowCompHistory(self)
- Show possible autocompletion Words from already typed words.
- OnUpdateUI(self, evt)
- Paste(self)
- Replace selection with clipboard contents.
- PasteAndRun(self)
- Replace selection with clipboard contents, run commands.
- SaveSettings(self, config)
- __init__(self, parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=4194304, introText='', locals=None, InterpClass=None, startupScript=None, execStartupScript=True, *args, **kwds)
- Create Shell instance.
- about(self)
- Display information about Py.
- addHistory(self, command)
- Add command to the command history.
- ask(self, prompt='Please enter your response:')
- Get response from the user using a dialog box.
- autoCallTipShow(self, command, insertcalltip=True, forceCallTip=False)
- Display argument spec and docstring in a popup window.
- autoCompleteShow(self, command, offset=0)
- Display auto-completion popup list.
- clear(self)
- Delete all text from the shell.
- clearCommand(self)
- Delete the current, unexecuted command.
- clearHistory(self)
- destroy(self)
- execStartupScript(self, startupScript)
- Execute the user's PYTHONSTARTUP script if they have one.
- fixLineEndings(self, text)
- Return text with line endings replaced by OS-specific endings.
- getCommand(self, text=None, rstrip=True)
- Extract a command from text which may include a shell prompt.
The command may not necessarily be valid Python syntax.
- getMultilineCommand(self, rstrip=True)
- Extract a multi-line command from the editor.
The command may not necessarily be valid Python syntax.
- insertLineBreak(self)
- Insert a new line break.
- lstripPrompt(self, text)
- Return text without a leading prompt.
- pause(self)
- Halt execution pending a response from the user.
- processLine(self)
- Process the line of text at which the user hit Enter.
- prompt(self)
- Display proper prompt for the context: ps1, ps2 or ps3.
If this is a continuation line, autoindent as necessary.
- quit(self)
- Quit the application.
- raw_input(self, prompt='')
- Return string based on user input.
- readline(self)
- Replacement for stdin.readline().
- readlines(self)
- Replacement for stdin.readlines().
- redirectStderr(self, redirect=True)
- If redirect is true then sys.stderr will go to the shell.
- redirectStdin(self, redirect=True)
- If redirect is true then sys.stdin will come from the shell.
- redirectStdout(self, redirect=True)
- If redirect is true then sys.stdout will go to the shell.
- replaceFromHistory(self, step)
- Replace selection with command from the history buffer.
- run(self, command, prompt=True, verbose=True)
- Execute command as if it was typed in directly.
>>> shell.run('print "this"')
>>> print "this"
this
>>>
- runfile(self, filename)
- Execute all commands in file as if they were typed into the
shell.
- setBuiltinKeywords(self)
- Create pseudo keywords as part of builtins.
This sets "close", "exit" and "quit" to a helpful string.
- setFocus(self)
- Set focus to the shell.
- setLocalShell(self)
- Add 'shell' to locals as reference to ShellFacade instance.
- setStatusText(self, text)
- Display status information.
- showIntro(self, text='')
- Display introductory text in the shell.
- wrap(self, wrap=True)
- Sets whether text is word wrapped.
- write(self, text)
- Display text in the shell.
Replace line endings with OS-specific endings.
- writeErr(self, text)
- Replacement for stderr.
- writeOut(self, text)
- Replacement for stdout.
- zoom(self, points=0)
- Set the zoom level.
This number of points is added to the size of all fonts. It
may be positive to magnify or negative to reduce.
Data and other attributes inherited from Shell:
- name = 'Shell'
- revision = '63479'
Methods inherited from EditWindow:
- CanCopy(self)
- Return True if text is selected and can be copied.
- DoFindNext(self, findData, findDlg=None)
- GetLastPosition(self)
- GetRange(self, start, end)
- GetSelection(self)
- ShowPosition(self, pos)
- setDisplayLineNumbers(self, state)
- setStyles(self, faces)
- Configure font size, typeface and color for lexer.
Methods inherited from StyledTextCtrl:
- AddRefDocument(*args, **kwargs)
- AddRefDocument(self, void docPointer)
Extend life of document.
- AddStyledText(*args, **kwargs)
- AddStyledText(self, wxMemoryBuffer data)
Add array of cells to document.
- AddText(*args, **kwargs)
- AddText(self, String text)
Add text to the document at current position.
- AddTextRaw(*args, **kwargs)
- AddTextRaw(self, char text)
Add text to the document at current position. The text should be
utf-8 encoded on unicode builds of wxPython, or can be any 8-bit text
in ansi builds.
- AddTextUTF8(self, text)
- Add UTF8 encoded text to the document at the current position.
Works 'natively' in a unicode build of wxPython, and will also work
in an ansi build if the UTF8 text is compatible with the current
encoding.
- Allocate(*args, **kwargs)
- Allocate(self, int bytes)
Enlarge the document to a particular size of text bytes.
- AppendText(*args, **kwargs)
- AppendText(self, String text)
Append a string to the end of the document without changing the selection.
- AppendTextRaw(*args, **kwargs)
- AppendTextRaw(self, char text)
Append a string to the end of the document without changing the
selection. The text should be utf-8 encoded on unicode builds of
wxPython, or can be any 8-bit text in ansi builds.
- AppendTextUTF8(self, text)
- Append a UTF8 string to the end of the document without changing
the selection. Works 'natively' in a unicode build of wxPython,
and will also work in an ansi build if the UTF8 text is compatible
with the current encoding.
- AutoCompActive(*args, **kwargs)
- AutoCompActive(self) -> bool
Is there an auto-completion list visible?
- AutoCompCancel(*args, **kwargs)
- AutoCompCancel(self)
Remove the auto-completion list from the screen.
- AutoCompComplete(*args, **kwargs)
- AutoCompComplete(self)
User has selected an item so remove the list and insert the selection.
- AutoCompGetAutoHide(*args, **kwargs)
- AutoCompGetAutoHide(self) -> bool
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
- AutoCompGetCancelAtStart(*args, **kwargs)
- AutoCompGetCancelAtStart(self) -> bool
Retrieve whether auto-completion cancelled by backspacing before start.
- AutoCompGetChooseSingle(*args, **kwargs)
- AutoCompGetChooseSingle(self) -> bool
Retrieve whether a single item auto-completion list automatically choose the item.
- AutoCompGetCurrent(*args, **kwargs)
- AutoCompGetCurrent(self) -> int
Get currently selected item position in the auto-completion list
- AutoCompGetDropRestOfWord(*args, **kwargs)
- AutoCompGetDropRestOfWord(self) -> bool
Retrieve whether or not autocompletion deletes any word characters
after the inserted text upon completion.
- AutoCompGetIgnoreCase(*args, **kwargs)
- AutoCompGetIgnoreCase(self) -> bool
Retrieve state of ignore case flag.
- AutoCompGetMaxHeight(*args, **kwargs)
- AutoCompGetMaxHeight(self) -> int
Set the maximum height, in rows, of auto-completion and user lists.
- AutoCompGetMaxWidth(*args, **kwargs)
- AutoCompGetMaxWidth(self) -> int
Get the maximum width, in characters, of auto-completion and user lists.
- AutoCompGetSeparator(*args, **kwargs)
- AutoCompGetSeparator(self) -> int
Retrieve the auto-completion list separator character.
- AutoCompGetTypeSeparator(*args, **kwargs)
- AutoCompGetTypeSeparator(self) -> int
Retrieve the auto-completion list type-separator character.
- AutoCompPosStart(*args, **kwargs)
- AutoCompPosStart(self) -> int
Retrieve the position of the caret when the auto-completion list was displayed.
- AutoCompSelect(*args, **kwargs)
- AutoCompSelect(self, String text)
Select the item in the auto-completion list that starts with a string.
- AutoCompSetAutoHide(*args, **kwargs)
- AutoCompSetAutoHide(self, bool autoHide)
Set whether or not autocompletion is hidden automatically when nothing matches.
- AutoCompSetCancelAtStart(*args, **kwargs)
- AutoCompSetCancelAtStart(self, bool cancel)
Should the auto-completion list be cancelled if the user backspaces to a
position before where the box was created.
- AutoCompSetChooseSingle(*args, **kwargs)
- AutoCompSetChooseSingle(self, bool chooseSingle)
Should a single item auto-completion list automatically choose the item.
- AutoCompSetDropRestOfWord(*args, **kwargs)
- AutoCompSetDropRestOfWord(self, bool dropRestOfWord)
Set whether or not autocompletion deletes any word characters
after the inserted text upon completion.
- AutoCompSetFillUps(*args, **kwargs)
- AutoCompSetFillUps(self, String characterSet)
Define a set of characters that when typed will cause the autocompletion to
choose the selected item.
- AutoCompSetIgnoreCase(*args, **kwargs)
- AutoCompSetIgnoreCase(self, bool ignoreCase)
Set whether case is significant when performing auto-completion searches.
- AutoCompSetMaxHeight(*args, **kwargs)
- AutoCompSetMaxHeight(self, int rowCount)
Set the maximum height, in rows, of auto-completion and user lists.
The default is 5 rows.
- AutoCompSetMaxWidth(*args, **kwargs)
- AutoCompSetMaxWidth(self, int characterCount)
Set the maximum width, in characters, of auto-completion and user lists.
Set to 0 to autosize to fit longest item, which is the default.
- AutoCompSetSeparator(*args, **kwargs)
- AutoCompSetSeparator(self, int separatorCharacter)
Change the separator character in the string setting up an auto-completion list.
Default is space but can be changed if items contain space.
- AutoCompSetTypeSeparator(*args, **kwargs)
- AutoCompSetTypeSeparator(self, int separatorCharacter)
Change the type-separator character in the string setting up an auto-completion list.
Default is '?' but can be changed if items contain '?'.
- AutoCompShow(*args, **kwargs)
- AutoCompShow(self, int lenEntered, String itemList)
Display a auto-completion list.
The lenEntered parameter indicates how many characters before
the caret should be used to provide context.
- AutoCompStops(*args, **kwargs)
- AutoCompStops(self, String characterSet)
Define a set of character that when typed cancel the auto-completion list.
- BackTab(*args, **kwargs)
- BackTab(self)
Dedent the selected lines.
- BeginUndoAction(*args, **kwargs)
- BeginUndoAction(self)
Start a sequence of actions that is undone and redone as a unit.
May be nested.
- BraceBadLight(*args, **kwargs)
- BraceBadLight(self, int pos)
Highlight the character at a position indicating there is no matching brace.
- BraceHighlight(*args, **kwargs)
- BraceHighlight(self, int pos1, int pos2)
Highlight the characters at two positions.
- BraceMatch(*args, **kwargs)
- BraceMatch(self, int pos) -> int
Find the position of a matching brace or INVALID_POSITION if no match.
- CallTipActive(*args, **kwargs)
- CallTipActive(self) -> bool
Is there an active call tip?
- CallTipCancel(*args, **kwargs)
- CallTipCancel(self)
Remove the call tip from the screen.
- CallTipPosAtStart(*args, **kwargs)
- CallTipPosAtStart(self) -> int
Retrieve the position where the caret was before displaying the call tip.
- CallTipSetBackground(*args, **kwargs)
- CallTipSetBackground(self, Colour back)
Set the background colour for the call tip.
- CallTipSetForeground(*args, **kwargs)
- CallTipSetForeground(self, Colour fore)
Set the foreground colour for the call tip.
- CallTipSetForegroundHighlight(*args, **kwargs)
- CallTipSetForegroundHighlight(self, Colour fore)
Set the foreground colour for the highlighted part of the call tip.
- CallTipSetHighlight(*args, **kwargs)
- CallTipSetHighlight(self, int start, int end)
Highlight a segment of the definition.
- CallTipShow(*args, **kwargs)
- CallTipShow(self, int pos, String definition)
Show a call tip containing a definition near position pos.
- CallTipUseStyle(*args, **kwargs)
- CallTipUseStyle(self, int tabSize)
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
- CanRedo(*args, **kwargs)
- CanRedo(self) -> bool
Are there any redoable actions in the undo history?
- CanUndo(*args, **kwargs)
- CanUndo(self) -> bool
Are there any undoable actions in the undo history?
- Cancel(*args, **kwargs)
- Cancel(self)
Cancel any modes such as call tip or auto-completion list display.
- CharLeft(*args, **kwargs)
- CharLeft(self)
Move caret left one character.
- CharLeftExtend(*args, **kwargs)
- CharLeftExtend(self)
Move caret left one character extending selection to new caret position.
- CharLeftRectExtend(*args, **kwargs)
- CharLeftRectExtend(self)
Move caret left one character, extending rectangular selection to new caret position.
- CharRight(*args, **kwargs)
- CharRight(self)
Move caret right one character.
- CharRightExtend(*args, **kwargs)
- CharRightExtend(self)
Move caret right one character extending selection to new caret position.
- CharRightRectExtend(*args, **kwargs)
- CharRightRectExtend(self)
Move caret right one character, extending rectangular selection to new caret position.
- ChooseCaretX(*args, **kwargs)
- ChooseCaretX(self)
Set the last x chosen value to be the caret x position.
- Clear(*args, **kwargs)
- Clear(self)
Clear the selection.
- ClearAll(*args, **kwargs)
- ClearAll(self)
Delete all text in the document.
- ClearDocumentStyle(*args, **kwargs)
- ClearDocumentStyle(self)
Set all style bytes to 0, remove all folding information.
- ClearRegisteredImages(*args, **kwargs)
- ClearRegisteredImages(self)
Clear all the registered images.
- CmdKeyAssign(*args, **kwargs)
- CmdKeyAssign(self, int key, int modifiers, int cmd)
When key+modifier combination km is pressed perform msg.
- CmdKeyClear(*args, **kwargs)
- CmdKeyClear(self, int key, int modifiers)
When key+modifier combination km is pressed do nothing.
- CmdKeyClearAll(*args, **kwargs)
- CmdKeyClearAll(self)
Drop all key mappings.
- CmdKeyExecute(*args, **kwargs)
- CmdKeyExecute(self, int cmd)
Perform one of the operations defined by the wx.stc.STC_CMD_* constants.
- Colourise(*args, **kwargs)
- Colourise(self, int start, int end)
Colourise a segment of the document using the current lexing language.
- ConvertEOLs(*args, **kwargs)
- ConvertEOLs(self, int eolMode)
Convert all line endings in the document to one mode.
- CopyRange(*args, **kwargs)
- CopyRange(self, int start, int end)
Copy a range of text to the clipboard. Positions are clipped into the document.
- CopyText(*args, **kwargs)
- CopyText(self, int length, String text)
Copy argument text to the clipboard.
- Create(*args, **kwargs)
- Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool
- CreateDocument(*args, **kwargs)
- CreateDocument(self) -> void
Create a new document object.
Starts with reference count of 1 and not selected into editor.
- DelLineLeft(*args, **kwargs)
- DelLineLeft(self)
Delete back from the current position to the start of the line.
- DelLineRight(*args, **kwargs)
- DelLineRight(self)
Delete forwards from the current position to the end of the line.
- DelWordLeft(*args, **kwargs)
- DelWordLeft(self)
Delete the word to the left of the caret.
- DelWordRight(*args, **kwargs)
- DelWordRight(self)
Delete the word to the right of the caret.
- DeleteBack(*args, **kwargs)
- DeleteBack(self)
Delete the selection or if no selection, the character before the caret.
- DeleteBackNotLine(*args, **kwargs)
- DeleteBackNotLine(self)
Delete the selection or if no selection, the character before the caret.
Will not delete the character before at the start of a line.
- DoDragOver(*args, **kwargs)
- DoDragOver(self, int x, int y, int def) -> int
Allow for simulating a DnD DragOver.
- DoDropText(*args, **kwargs)
- DoDropText(self, long x, long y, String data) -> bool
Allow for simulating a DnD DropText.
- DocLineFromVisible(*args, **kwargs)
- DocLineFromVisible(self, int lineDisplay) -> int
Find the document line of a display line taking hidden lines into account.
- DocumentEnd(*args, **kwargs)
- DocumentEnd(self)
Move caret to last position in document.
- DocumentEndExtend(*args, **kwargs)
- DocumentEndExtend(self)
Move caret to last position in document extending selection to new caret position.
- DocumentStart(*args, **kwargs)
- DocumentStart(self)
Move caret to first position in document.
- DocumentStartExtend(*args, **kwargs)
- DocumentStartExtend(self)
Move caret to first position in document extending selection to new caret position.
- EditToggleOvertype(*args, **kwargs)
- EditToggleOvertype(self)
Switch from insert to overtype mode or the reverse.
- EmptyUndoBuffer(*args, **kwargs)
- EmptyUndoBuffer(self)
Delete the undo history.
- EndUndoAction(*args, **kwargs)
- EndUndoAction(self)
End a sequence of actions that is undone and redone as a unit.
- EnsureCaretVisible(*args, **kwargs)
- EnsureCaretVisible(self)
Ensure the caret is visible.
- EnsureVisible(*args, **kwargs)
- EnsureVisible(self, int line)
Ensure a particular line is visible by expanding any header line hiding it.
- EnsureVisibleEnforcePolicy(*args, **kwargs)
- EnsureVisibleEnforcePolicy(self, int line)
Ensure a particular line is visible by expanding any header line hiding it.
Use the currently set visibility policy to determine which range to display.
- FindColumn(*args, **kwargs)
- FindColumn(self, int line, int column) -> int
Find the position of a column on a line taking into account tabs and
multi-byte characters. If beyond end of line, return line end position.
- FindText(*args, **kwargs)
- FindText(self, int minPos, int maxPos, String text, int flags=0) -> int
Find some text in the document.
- FormFeed(*args, **kwargs)
- FormFeed(self)
Insert a Form Feed character.
- FormatRange(*args, **kwargs)
- FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target,
Rect renderRect, Rect pageRect) -> int
On Windows, will draw the document into a display context such as a printer.
- GetAnchor(*args, **kwargs)
- GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
- GetBackSpaceUnIndents(*args, **kwargs)
- GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
- GetBufferedDraw(*args, **kwargs)
- GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
- GetCaretForeground(*args, **kwargs)
- GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
- GetCaretLineBack = GetCaretLineBackground(*args, **kwargs)
- GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
- GetCaretLineBackAlpha(*args, **kwargs)
- GetCaretLineBackAlpha(self) -> int
Get the background alpha of the caret line.
- GetCaretLineBackground(*args, **kwargs)
- GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
- GetCaretLineVisible(*args, **kwargs)
- GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
- GetCaretPeriod(*args, **kwargs)
- GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
- GetCaretSticky(*args, **kwargs)
- GetCaretSticky(self) -> bool
Can the caret preferred x position only be changed by explicit movement commands?
- GetCaretWidth(*args, **kwargs)
- GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
- GetCharAt(*args, **kwargs)
- GetCharAt(self, int pos) -> int
Returns the character byte at the position.
- GetCodePage(*args, **kwargs)
- GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
- GetColumn(*args, **kwargs)
- GetColumn(self, int pos) -> int
Retrieve the column number of a position, taking tab width into account.
- GetControlCharSymbol(*args, **kwargs)
- GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
- GetCurLine(*args, **kwargs)
- GetCurLine(self) -> (text, pos)
Retrieve the text of the line containing the caret, and also theindex
of the caret on the line.
- GetCurLineRaw(*args, **kwargs)
- GetCurLineRaw() -> (text, index)
Retrieve the text of the line containing the caret, and also the index
of the caret on the line. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
- GetCurLineUTF8(self)
- Retrieve the UTF8 text of the line containing the caret, and also
the index of the caret on the line. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
- GetCurrentLine(*args, **kwargs)
- GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
- GetCurrentPos(*args, **kwargs)
- GetCurrentPos(self) -> int
Returns the position of the caret.
- GetDocPointer(*args, **kwargs)
- GetDocPointer(self) -> void
Retrieve a pointer to the document object.
- GetEOLMode(*args, **kwargs)
- GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
- GetEdgeColour(*args, **kwargs)
- GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
- GetEdgeColumn(*args, **kwargs)
- GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
- GetEdgeMode(*args, **kwargs)
- GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
- GetEndAtLastLine(*args, **kwargs)
- GetEndAtLastLine(self) -> bool
Retrieve whether the maximum scroll position has the last
line at the bottom of the view.
- GetEndStyled(*args, **kwargs)
- GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
- GetFirstVisibleLine(*args, **kwargs)
- GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
- GetFoldExpanded(*args, **kwargs)
- GetFoldExpanded(self, int line) -> bool
Is a header line expanded?
- GetFoldLevel(*args, **kwargs)
- GetFoldLevel(self, int line) -> int
Retrieve the fold level of a line.
- GetFoldParent(*args, **kwargs)
- GetFoldParent(self, int line) -> int
Find the parent line of a child line.
- GetHighlightGuide(*args, **kwargs)
- GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
- GetIndent(*args, **kwargs)
- GetIndent(self) -> int
Retrieve indentation size.
- GetIndentationGuides(*args, **kwargs)
- GetIndentationGuides(self) -> bool
Are the indentation guides visible?
- GetLastChild(*args, **kwargs)
- GetLastChild(self, int line, int level) -> int
Find the last child line of a header line.
- GetLastKeydownProcessed(*args, **kwargs)
- GetLastKeydownProcessed(self) -> bool
- GetLayoutCache(*args, **kwargs)
- GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
- GetLength(*args, **kwargs)
- GetLength(self) -> int
Returns the number of characters in the document.
- GetLexer(*args, **kwargs)
- GetLexer(self) -> int
Retrieve the lexing language of the document.
- GetLine(*args, **kwargs)
- GetLine(self, int line) -> String
Retrieve the contents of a line.
- GetLineCount(*args, **kwargs)
- GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
- GetLineEndPosition(*args, **kwargs)
- GetLineEndPosition(self, int line) -> int
Get the position after the last visible characters on a line.
- GetLineIndentPosition(*args, **kwargs)
- GetLineIndentPosition(self, int line) -> int
Retrieve the position before the first non indentation character on a line.
- GetLineIndentation(*args, **kwargs)
- GetLineIndentation(self, int line) -> int
Retrieve the number of columns that a line is indented.
- GetLineRaw(*args, **kwargs)
- GetLineRaw(self, int line) -> wxCharBuffer
Retrieve the contents of a line. The returned value is a utf-8
encoded string in unicode builds of wxPython, or raw 8-bit text
otherwise.
- GetLineSelEndPosition(*args, **kwargs)
- GetLineSelEndPosition(self, int line) -> int
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
- GetLineSelStartPosition(*args, **kwargs)
- GetLineSelStartPosition(self, int line) -> int
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
- GetLineState(*args, **kwargs)
- GetLineState(self, int line) -> int
Retrieve the extra styling information for a line.
- GetLineUTF8(self, line)
- Retrieve the contents of a line as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
- GetLineVisible(*args, **kwargs)
- GetLineVisible(self, int line) -> bool
Is a line visible?
- GetMarginLeft(*args, **kwargs)
- GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
- GetMarginMask(*args, **kwargs)
- GetMarginMask(self, int margin) -> int
Retrieve the marker mask of a margin.
- GetMarginRight(*args, **kwargs)
- GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
- GetMarginSensitive(*args, **kwargs)
- GetMarginSensitive(self, int margin) -> bool
Retrieve the mouse click sensitivity of a margin.
- GetMarginType(*args, **kwargs)
- GetMarginType(self, int margin) -> int
Retrieve the type of a margin.
- GetMarginWidth(*args, **kwargs)
- GetMarginWidth(self, int margin) -> int
Retrieve the width of a margin in pixels.
- GetMaxLineState(*args, **kwargs)
- GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
- GetModEventMask(*args, **kwargs)
- GetModEventMask(self) -> int
Get which document modification events are sent to the container.
- GetModify(*args, **kwargs)
- GetModify(self) -> bool
Is the document different from when it was last saved?
- GetMouseDownCaptures(*args, **kwargs)
- GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
- GetMouseDwellTime(*args, **kwargs)
- GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
- GetOvertype(*args, **kwargs)
- GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
- GetPasteConvertEndings(*args, **kwargs)
- GetPasteConvertEndings(self) -> bool
Get convert-on-paste setting
- GetPrintColourMode(*args, **kwargs)
- GetPrintColourMode(self) -> int
Returns the print colour mode.
- GetPrintMagnification(*args, **kwargs)
- GetPrintMagnification(self) -> int
Returns the print magnification.
- GetPrintWrapMode(*args, **kwargs)
- GetPrintWrapMode(self) -> int
Is printing line wrapped?
- GetProperty(*args, **kwargs)
- GetProperty(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty.
- GetPropertyExpanded(*args, **kwargs)
- GetPropertyExpanded(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty,
with '$()' variable replacement on returned buffer.
- GetPropertyInt(*args, **kwargs)
- GetPropertyInt(self, String key) -> int
Retrieve a 'property' value previously set with SetProperty,
interpreted as an int AFTER any '$()' variable replacement.
- GetReadOnly(*args, **kwargs)
- GetReadOnly(self) -> bool
In read-only mode?
- GetSTCCursor(*args, **kwargs)
- GetSTCCursor(self) -> int
Get cursor type.
- GetSTCFocus(*args, **kwargs)
- GetSTCFocus(self) -> bool
Get internal focus flag.
- GetScrollWidth(*args, **kwargs)
- GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
- GetSearchFlags(*args, **kwargs)
- GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
- GetSelAlpha(*args, **kwargs)
- GetSelAlpha(self) -> int
Get the alpha of the selection.
- GetSelectedText(*args, **kwargs)
- GetSelectedText(self) -> String
Retrieve the selected text.
- GetSelectedTextRaw(*args, **kwargs)
- GetSelectedTextRaw(self) -> wxCharBuffer
Retrieve the selected text. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
- GetSelectedTextUTF8(self)
- Retrieve the selected text as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
- GetSelectionEnd(*args, **kwargs)
- GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
- GetSelectionMode(*args, **kwargs)
- GetSelectionMode(self) -> int
Get the mode of the current selection.
- GetSelectionStart(*args, **kwargs)
- GetSelectionStart(self) -> int
Returns the position at the start of the selection.
- GetStatus(*args, **kwargs)
- GetStatus(self) -> int
Get error status.
- GetStyleAt(*args, **kwargs)
- GetStyleAt(self, int pos) -> int
Returns the style byte at the position.
- GetStyleBits(*args, **kwargs)
- GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
- GetStyleBitsNeeded(*args, **kwargs)
- GetStyleBitsNeeded(self) -> int
Retrieve the number of bits the current lexer needs for styling.
- GetStyledText(*args, **kwargs)
- GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer
Retrieve a buffer of cells.
- GetTabIndents(*args, **kwargs)
- GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
- GetTabWidth(*args, **kwargs)
- GetTabWidth(self) -> int
Retrieve the visible size of a tab.
- GetTargetEnd(*args, **kwargs)
- GetTargetEnd(self) -> int
Get the position that ends the target.
- GetTargetStart(*args, **kwargs)
- GetTargetStart(self) -> int
Get the position that starts the target.
- GetText(*args, **kwargs)
- GetText(self) -> String
Retrieve all the text in the document.
- GetTextLength(*args, **kwargs)
- GetTextLength(self) -> int
Retrieve the number of characters in the document.
- GetTextRange(*args, **kwargs)
- GetTextRange(self, int startPos, int endPos) -> String
Retrieve a range of text.
- GetTextRangeRaw(*args, **kwargs)
- GetTextRangeRaw(self, int startPos, int endPos) -> wxCharBuffer
Retrieve a range of text. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
- GetTextRangeUTF8(self, startPos, endPos)
- Retrieve a range of text as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
- GetTextRaw(*args, **kwargs)
- GetTextRaw(self) -> wxCharBuffer
Retrieve all the text in the document. The returned value is a utf-8
encoded string in unicode builds of wxPython, or raw 8-bit text
otherwise.
- GetTextUTF8(self)
- Retrieve all the text in the document as UTF8. In an ansi build
of wxPython the text retrieved from the document is assumed to be
in the current default encoding.
- GetTwoPhaseDraw(*args, **kwargs)
- GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
- GetUndoCollection(*args, **kwargs)
- GetUndoCollection(self) -> bool
Is undo history being collected?
- GetUseAntiAliasing(*args, **kwargs)
- GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
- GetUseHorizontalScrollBar(*args, **kwargs)
- GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
- GetUseTabs(*args, **kwargs)
- GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
- GetUseVerticalScrollBar(*args, **kwargs)
- GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
- GetViewEOL(*args, **kwargs)
- GetViewEOL(self) -> bool
Are the end of line characters visible?
- GetViewWhiteSpace(*args, **kwargs)
- GetViewWhiteSpace(self) -> int
Are white space characters currently visible?
Returns one of SCWS_* constants.
- GetWrapMode(*args, **kwargs)
- GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
- GetWrapStartIndent(*args, **kwargs)
- GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
- GetWrapVisualFlags(*args, **kwargs)
- GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
- GetWrapVisualFlagsLocation(*args, **kwargs)
- GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
- GetXOffset(*args, **kwargs)
- GetXOffset(self) -> int
- GetZoom(*args, **kwargs)
- GetZoom(self) -> int
Retrieve the zoom level.
- GotoLine(*args, **kwargs)
- GotoLine(self, int line)
Set caret to start of a line and ensure it is visible.
- GotoPos(*args, **kwargs)
- GotoPos(self, int pos)
Set caret to a position and ensure it is visible.
- HideLines(*args, **kwargs)
- HideLines(self, int lineStart, int lineEnd)
Make a range of lines invisible.
- HideSelection(*args, **kwargs)
- HideSelection(self, bool normal)
Draw the selection in normal style or with selection highlighted.
- Home(*args, **kwargs)
- Home(self)
Move caret to first position on line.
- HomeDisplay(*args, **kwargs)
- HomeDisplay(self)
Move caret to first position on display line.
- HomeDisplayExtend(*args, **kwargs)
- HomeDisplayExtend(self)
Move caret to first position on display line extending selection to
new caret position.
- HomeExtend(*args, **kwargs)
- HomeExtend(self)
Move caret to first position on line extending selection to new caret position.
- HomeRectExtend(*args, **kwargs)
- HomeRectExtend(self)
Move caret to first position on line, extending rectangular selection to new caret position.
- HomeWrap(*args, **kwargs)
- HomeWrap(self)
These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?
except they behave differently when word-wrap is enabled:
They go first to the start / end of the display line, like (Home|LineEnd)Display
The difference is that, the cursor is already at the point, it goes on to the start
or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
- HomeWrapExtend(*args, **kwargs)
- HomeWrapExtend(self)
- IndicatorGetForeground(*args, **kwargs)
- IndicatorGetForeground(self, int indic) -> Colour
Retrieve the foreground colour of an indicator.
- IndicatorGetStyle(*args, **kwargs)
- IndicatorGetStyle(self, int indic) -> int
Retrieve the style of an indicator.
- IndicatorSetForeground(*args, **kwargs)
- IndicatorSetForeground(self, int indic, Colour fore)
Set the foreground colour of an indicator.
- IndicatorSetStyle(*args, **kwargs)
- IndicatorSetStyle(self, int indic, int style)
Set an indicator to plain, squiggle or TT.
- InsertText(*args, **kwargs)
- InsertText(self, int pos, String text)
Insert string at a position.
- InsertTextRaw(*args, **kwargs)
- InsertTextRaw(self, int pos, char text)
Insert string at a position. The text should be utf-8 encoded on
unicode builds of wxPython, or can be any 8-bit text in ansi builds.
- InsertTextUTF8(self, pos, text)
- Insert UTF8 encoded text at a position. Works 'natively' in a
unicode build of wxPython, and will also work in an ansi build if
the UTF8 text is compatible with the current encoding.
- LineCopy(*args, **kwargs)
- LineCopy(self)
Copy the line containing the caret.
- LineCut(*args, **kwargs)
- LineCut(self)
Cut the line containing the caret.
- LineDelete(*args, **kwargs)
- LineDelete(self)
Delete the line containing the caret.
- LineDown(*args, **kwargs)
- LineDown(self)
Move caret down one line.
- LineDownExtend(*args, **kwargs)
- LineDownExtend(self)
Move caret down one line extending selection to new caret position.
- LineDownRectExtend(*args, **kwargs)
- LineDownRectExtend(self)
Move caret down one line, extending rectangular selection to new caret position.
- LineDuplicate(*args, **kwargs)
- LineDuplicate(self)
Duplicate the current line.
- LineEnd(*args, **kwargs)
- LineEnd(self)
Move caret to last position on line.
- LineEndDisplay(*args, **kwargs)
- LineEndDisplay(self)
Move caret to last position on display line.
- LineEndDisplayExtend(*args, **kwargs)
- LineEndDisplayExtend(self)
Move caret to last position on display line extending selection to new
caret position.
- LineEndExtend(*args, **kwargs)
- LineEndExtend(self)
Move caret to last position on line extending selection to new caret position.
- LineEndRectExtend(*args, **kwargs)
- LineEndRectExtend(self)
Move caret to last position on line, extending rectangular selection to new caret position.
- LineEndWrap(*args, **kwargs)
- LineEndWrap(self)
- LineEndWrapExtend(*args, **kwargs)
- LineEndWrapExtend(self)
- LineFromPosition(*args, **kwargs)
- LineFromPosition(self, int pos) -> int
Retrieve the line containing a position.
- LineLength(*args, **kwargs)
- LineLength(self, int line) -> int
How many characters are on a line, not including end of line characters?
- LineScroll(*args, **kwargs)
- LineScroll(self, int columns, int lines)
Scroll horizontally and vertically.
- LineScrollDown(*args, **kwargs)
- LineScrollDown(self)
Scroll the document down, keeping the caret visible.
- LineScrollUp(*args, **kwargs)
- LineScrollUp(self)
Scroll the document up, keeping the caret visible.
- LineTranspose(*args, **kwargs)
- LineTranspose(self)
Switch the current line with the previous.
- LineUp(*args, **kwargs)
- LineUp(self)
Move caret up one line.
- LineUpExtend(*args, **kwargs)
- LineUpExtend(self)
Move caret up one line extending selection to new caret position.
- LineUpRectExtend(*args, **kwargs)
- LineUpRectExtend(self)
Move caret up one line, extending rectangular selection to new caret position.
- LinesJoin(*args, **kwargs)
- LinesJoin(self)
Join the lines in the target.
- LinesOnScreen(*args, **kwargs)
- LinesOnScreen(self) -> int
Retrieves the number of lines completely visible.
- LinesSplit(*args, **kwargs)
- LinesSplit(self, int pixelWidth)
Split the lines in the target into lines that are less wide than pixelWidth
where possible.
- LoadFile(*args, **kwargs)
- LoadFile(self, String filename) -> bool
Load the contents of filename into the editor
- LowerCase(*args, **kwargs)
- LowerCase(self)
Transform the selection to lower case.
- MarkerAdd(*args, **kwargs)
- MarkerAdd(self, int line, int markerNumber) -> int
Add a marker to a line, returning an ID which can be used to find or delete the marker.
- MarkerAddSet(*args, **kwargs)
- MarkerAddSet(self, int line, int set)
Add a set of markers to a line.
- MarkerDefine(*args, **kwargs)
- MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour,
Colour background=wxNullColour)
Set the symbol used for a particular marker number,
and optionally the fore and background colours.
- MarkerDefineBitmap(*args, **kwargs)
- MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)
Define a marker from a bitmap
- MarkerDelete(*args, **kwargs)
- MarkerDelete(self, int line, int markerNumber)
Delete a marker from a line.
- MarkerDeleteAll(*args, **kwargs)
- MarkerDeleteAll(self, int markerNumber)
Delete all markers with a particular number from all lines.
- MarkerDeleteHandle(*args, **kwargs)
- MarkerDeleteHandle(self, int handle)
Delete a marker.
- MarkerGet(*args, **kwargs)
- MarkerGet(self, int line) -> int
Get a bit mask of all the markers set on a line.
- MarkerLineFromHandle(*args, **kwargs)
- MarkerLineFromHandle(self, int handle) -> int
Retrieve the line number at which a particular marker is located.
- MarkerNext(*args, **kwargs)
- MarkerNext(self, int lineStart, int markerMask) -> int
Find the next line after lineStart that includes a marker in mask.
- MarkerPrevious(*args, **kwargs)
- MarkerPrevious(self, int lineStart, int markerMask) -> int
Find the previous line before lineStart that includes a marker in mask.
- MarkerSetAlpha(*args, **kwargs)
- MarkerSetAlpha(self, int markerNumber, int alpha)
Set the alpha used for a marker that is drawn in the text area, not the margin.
- MarkerSetBackground(*args, **kwargs)
- MarkerSetBackground(self, int markerNumber, Colour back)
Set the background colour used for a particular marker number.
- MarkerSetForeground(*args, **kwargs)
- MarkerSetForeground(self, int markerNumber, Colour fore)
Set the foreground colour used for a particular marker number.
- MoveCaretInsideView(*args, **kwargs)
- MoveCaretInsideView(self)
Move the caret inside current view if it's not there already.
- NewLine(*args, **kwargs)
- NewLine(self)
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
- PageDown(*args, **kwargs)
- PageDown(self)
Move caret one page down.
- PageDownExtend(*args, **kwargs)
- PageDownExtend(self)
Move caret one page down extending selection to new caret position.
- PageDownRectExtend(*args, **kwargs)
- PageDownRectExtend(self)
Move caret one page down, extending rectangular selection to new caret position.
- PageUp(*args, **kwargs)
- PageUp(self)
Move caret one page up.
- PageUpExtend(*args, **kwargs)
- PageUpExtend(self)
Move caret one page up extending selection to new caret position.
- PageUpRectExtend(*args, **kwargs)
- PageUpRectExtend(self)
Move caret one page up, extending rectangular selection to new caret position.
- ParaDown(*args, **kwargs)
- ParaDown(self)
Move caret between paragraphs (delimited by empty lines).
- ParaDownExtend(*args, **kwargs)
- ParaDownExtend(self)
- ParaUp(*args, **kwargs)
- ParaUp(self)
- ParaUpExtend(*args, **kwargs)
- ParaUpExtend(self)
- PointFromPosition(*args, **kwargs)
- PointFromPosition(self, int pos) -> Point
Retrieve the point in the window where a position is displayed.
- PositionAfter(*args, **kwargs)
- PositionAfter(self, int pos) -> int
Given a valid document position, return the next position taking code
page into account. Maximum value returned is the last position in the document.
- PositionBefore(*args, **kwargs)
- PositionBefore(self, int pos) -> int
Given a valid document position, return the previous position taking code
page into account. Returns 0 if passed 0.
- PositionFromLine(*args, **kwargs)
- PositionFromLine(self, int line) -> int
Retrieve the position at the start of a line.
- PositionFromPoint(*args, **kwargs)
- PositionFromPoint(self, Point pt) -> int
Find the position from a point within the window.
- PositionFromPointClose(*args, **kwargs)
- PositionFromPointClose(self, int x, int y) -> int
Find the position from a point within the window but return
INVALID_POSITION if not close to text.
- Redo(*args, **kwargs)
- Redo(self)
Redoes the next action on the undo history.
- RegisterImage(*args, **kwargs)
- RegisterImage(self, int type, Bitmap bmp)
Register an image for use in autocompletion lists.
- ReleaseDocument(*args, **kwargs)
- ReleaseDocument(self, void docPointer)
Release a reference to the document, deleting document if it fades to black.
- ReplaceSelection(*args, **kwargs)
- ReplaceSelection(self, String text)
Replace the selected text with the argument text.
- ReplaceTarget(*args, **kwargs)
- ReplaceTarget(self, String text) -> int
Replace the target text with the argument text.
Text is counted so it can contain NULs.
Returns the length of the replacement text.
- ReplaceTargetRE(*args, **kwargs)
- ReplaceTargetRE(self, String text) -> int
Replace the target text with the argument text after \d processing.
Text is counted so it can contain NULs.
Looks for \d where d is between 1 and 9 and replaces these with the strings
matched in the last search operation which were surrounded by \( and \).
Returns the length of the replacement text including any change
caused by processing the \d patterns.
- SaveFile(*args, **kwargs)
- SaveFile(self, String filename) -> bool
Write the contents of the editor to filename
- ScrollToColumn(*args, **kwargs)
- ScrollToColumn(self, int column)
Scroll enough to make the given column visible
- ScrollToLine(*args, **kwargs)
- ScrollToLine(self, int line)
Scroll enough to make the given line visible.
- SearchAnchor(*args, **kwargs)
- SearchAnchor(self)
Sets the current caret position to be the search anchor.
- SearchInTarget(*args, **kwargs)
- SearchInTarget(self, String text) -> int
Search for a counted string in the target and set the target to the found
range. Text is counted so it can contain NULs.
Returns length of range or -1 for failure in which case target is not moved.
- SearchNext(*args, **kwargs)
- SearchNext(self, int flags, String text) -> int
Find some text starting at the search anchor.
Does not ensure the selection is visible.
- SearchPrev(*args, **kwargs)
- SearchPrev(self, int flags, String text) -> int
Find some text starting at the search anchor and moving backwards.
Does not ensure the selection is visible.
- SelectAll(*args, **kwargs)
- SelectAll(self)
Select all the text in the document.
- SelectionDuplicate(*args, **kwargs)
- SelectionDuplicate(self)
Duplicate the selection. If selection empty duplicate the line containing the caret.
- SelectionIsRectangle(*args, **kwargs)
- SelectionIsRectangle(self) -> bool
Is the selection rectangular? The alternative is the more common stream selection.
- SendMsg(*args, **kwargs)
- SendMsg(self, int msg, UIntPtr wp=0, wxIntPtr lp=0) -> wxIntPtr
Send a message to Scintilla.
- SetAnchor(*args, **kwargs)
- SetAnchor(self, int posAnchor)
Set the selection anchor to a position. The anchor is the opposite
end of the selection from the caret.
- SetBackSpaceUnIndents(*args, **kwargs)
- SetBackSpaceUnIndents(self, bool bsUnIndents)
Sets whether a backspace pressed when caret is within indentation unindents.
- SetBufferedDraw(*args, **kwargs)
- SetBufferedDraw(self, bool buffered)
If drawing is buffered then each line of text is drawn into a bitmap buffer
before drawing it to the screen to avoid flicker.
- SetCaretForeground(*args, **kwargs)
- SetCaretForeground(self, Colour fore)
Set the foreground colour of the caret.
- SetCaretLineBack = SetCaretLineBackground(*args, **kwargs)
- SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
- SetCaretLineBackAlpha(*args, **kwargs)
- SetCaretLineBackAlpha(self, int alpha)
Set background alpha of the caret line.
- SetCaretLineBackground(*args, **kwargs)
- SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
- SetCaretLineVisible(*args, **kwargs)
- SetCaretLineVisible(self, bool show)
Display the background of the line containing the caret in a different colour.
- SetCaretPeriod(*args, **kwargs)
- SetCaretPeriod(self, int periodMilliseconds)
Get the time in milliseconds that the caret is on and off. 0 = steady on.
- SetCaretSticky(*args, **kwargs)
- SetCaretSticky(self, bool useCaretStickyBehaviour)
Stop the caret preferred x position changing when the user types.
- SetCaretWidth(*args, **kwargs)
- SetCaretWidth(self, int pixelWidth)
Set the width of the insert mode caret.
- SetCharsDefault(*args, **kwargs)
- SetCharsDefault(self)
Reset the set of characters for whitespace and word characters to the defaults.
- SetCodePage(*args, **kwargs)
- SetCodePage(self, int codePage)
Set the code page used to interpret the bytes of the document as characters.
- SetControlCharSymbol(*args, **kwargs)
- SetControlCharSymbol(self, int symbol)
Change the way control characters are displayed:
If symbol is < 32, keep the drawn way, else, use the given character.
- SetCurrentPos(*args, **kwargs)
- SetCurrentPos(self, int pos)
Sets the position of the caret.
- SetDocPointer(*args, **kwargs)
- SetDocPointer(self, void docPointer)
Change the document object used.
- SetEOLMode(*args, **kwargs)
- SetEOLMode(self, int eolMode)
Set the current end of line mode.
- SetEdgeColour(*args, **kwargs)
- SetEdgeColour(self, Colour edgeColour)
Change the colour used in edge indication.
- SetEdgeColumn(*args, **kwargs)
- SetEdgeColumn(self, int column)
Set the column number of the edge.
If text goes past the edge then it is highlighted.
- SetEdgeMode(*args, **kwargs)
- SetEdgeMode(self, int mode)
The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
- SetEndAtLastLine(*args, **kwargs)
- SetEndAtLastLine(self, bool endAtLastLine)
Sets the scroll range so that maximum scroll position has
the last line at the bottom of the view (default).
Setting this to false allows scrolling one page below the last line.
- SetFoldExpanded(*args, **kwargs)
- SetFoldExpanded(self, int line, bool expanded)
Show the children of a header line.
- SetFoldFlags(*args, **kwargs)
- SetFoldFlags(self, int flags)
Set some style options for folding.
- SetFoldLevel(*args, **kwargs)
- SetFoldLevel(self, int line, int level)
Set the fold level of a line.
This encodes an integer level along with flags indicating whether the
line is a header and whether it is effectively white space.
- SetFoldMarginColour(*args, **kwargs)
- SetFoldMarginColour(self, bool useSetting, Colour back)
Set the colours used as a chequerboard pattern in the fold margin
- SetFoldMarginHiColour(*args, **kwargs)
- SetFoldMarginHiColour(self, bool useSetting, Colour fore)
- SetHScrollBar(*args, **kwargs)
- SetHScrollBar(self, wxScrollBar bar)
Set the horizontal scrollbar to use instead of the ont that's built-in.
- SetHighlightGuide(*args, **kwargs)
- SetHighlightGuide(self, int column)
Set the highlighted indentation guide column.
0 = no highlighted guide.
- SetHotspotActiveBackground(*args, **kwargs)
- SetHotspotActiveBackground(self, bool useSetting, Colour back)
Set a back colour for active hotspots.
- SetHotspotActiveForeground(*args, **kwargs)
- SetHotspotActiveForeground(self, bool useSetting, Colour fore)
Set a fore colour for active hotspots.
- SetHotspotActiveUnderline(*args, **kwargs)
- SetHotspotActiveUnderline(self, bool underline)
Enable / Disable underlining active hotspots.
- SetHotspotSingleLine(*args, **kwargs)
- SetHotspotSingleLine(self, bool singleLine)
Limit hotspots to single line so hotspots on two lines don't merge.
- SetIndent(*args, **kwargs)
- SetIndent(self, int indentSize)
Set the number of spaces used for one level of indentation.
- SetIndentationGuides(*args, **kwargs)
- SetIndentationGuides(self, bool show)
Show or hide indentation guides.
- SetKeyWords(*args, **kwargs)
- SetKeyWords(self, int keywordSet, String keyWords)
Set up the key words used by the lexer.
- SetLastKeydownProcessed(*args, **kwargs)
- SetLastKeydownProcessed(self, bool val)
- SetLayoutCache(*args, **kwargs)
- SetLayoutCache(self, int mode)
Sets the degree of caching of layout information.
- SetLexer(*args, **kwargs)
- SetLexer(self, int lexer)
Set the lexing language of the document.
- SetLexerLanguage(*args, **kwargs)
- SetLexerLanguage(self, String language)
Set the lexing language of the document based on string name.
- SetLineIndentation(*args, **kwargs)
- SetLineIndentation(self, int line, int indentSize)
Change the indentation of a line to a number of columns.
- SetLineState(*args, **kwargs)
- SetLineState(self, int line, int state)
Used to hold extra styling information for each line.
- SetMarginLeft(*args, **kwargs)
- SetMarginLeft(self, int pixelWidth)
Sets the size in pixels of the left margin.
- SetMarginMask(*args, **kwargs)
- SetMarginMask(self, int margin, int mask)
Set a mask that determines which markers are displayed in a margin.
- SetMarginRight(*args, **kwargs)
- SetMarginRight(self, int pixelWidth)
Sets the size in pixels of the right margin.
- SetMarginSensitive(*args, **kwargs)
- SetMarginSensitive(self, int margin, bool sensitive)
Make a margin sensitive or insensitive to mouse clicks.
- SetMarginType(*args, **kwargs)
- SetMarginType(self, int margin, int marginType)
Set a margin to be either numeric or symbolic.
- SetMarginWidth(*args, **kwargs)
- SetMarginWidth(self, int margin, int pixelWidth)
Set the width of a margin to a width expressed in pixels.
- SetMargins(*args, **kwargs)
- SetMargins(self, int left, int right)
Set the left and right margin in the edit area, measured in pixels.
- SetModEventMask(*args, **kwargs)
- SetModEventMask(self, int mask)
Set which document modification events are sent to the container.
- SetMouseDownCaptures(*args, **kwargs)
- SetMouseDownCaptures(self, bool captures)
Set whether the mouse is captured when its button is pressed.
- SetMouseDwellTime(*args, **kwargs)
- SetMouseDwellTime(self, int periodMilliseconds)
Sets the time the mouse must sit still to generate a mouse dwell event.
- SetOvertype(*args, **kwargs)
- SetOvertype(self, bool overtype)
Set to overtype (true) or insert mode.
- SetPasteConvertEndings(*args, **kwargs)
- SetPasteConvertEndings(self, bool convert)
Enable/Disable convert-on-paste for line endings
- SetPrintColourMode(*args, **kwargs)
- SetPrintColourMode(self, int mode)
Modify colours when printing for clearer printed text.
- SetPrintMagnification(*args, **kwargs)
- SetPrintMagnification(self, int magnification)
Sets the print magnification added to the point size of each style for printing.
- SetPrintWrapMode(*args, **kwargs)
- SetPrintWrapMode(self, int mode)
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
- SetProperty(*args, **kwargs)
- SetProperty(self, String key, String value)
Set up a value that may be used by a lexer for some optional feature.
- SetReadOnly(*args, **kwargs)
- SetReadOnly(self, bool readOnly)
Set to read only or read write.
- SetSTCCursor(*args, **kwargs)
- SetSTCCursor(self, int cursorType)
Sets the cursor to one of the SC_CURSOR* values.
- SetSTCFocus(*args, **kwargs)
- SetSTCFocus(self, bool focus)
Change internal focus flag.
- SetSavePoint(*args, **kwargs)
- SetSavePoint(self)
Remember the current position in the undo history as the position
at which the document was saved.
- SetScrollWidth(*args, **kwargs)
- SetScrollWidth(self, int pixelWidth)
Sets the document width assumed for scrolling.
- SetSearchFlags(*args, **kwargs)
- SetSearchFlags(self, int flags)
Set the search flags used by SearchInTarget.
- SetSelAlpha(*args, **kwargs)
- SetSelAlpha(self, int alpha)
Set the alpha of the selection.
- SetSelBackground(*args, **kwargs)
- SetSelBackground(self, bool useSetting, Colour back)
Set the background colour of the selection and whether to use this setting.
- SetSelForeground(*args, **kwargs)
- SetSelForeground(self, bool useSetting, Colour fore)
Set the foreground colour of the selection and whether to use this setting.
- SetSelection(*args, **kwargs)
- SetSelection(self, int start, int end)
Select a range of text.
- SetSelectionEnd(*args, **kwargs)
- SetSelectionEnd(self, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
- SetSelectionMode(*args, **kwargs)
- SetSelectionMode(self, int mode)
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or
by lines (SC_SEL_LINES).
- SetSelectionStart(*args, **kwargs)
- SetSelectionStart(self, int pos)
Sets the position that starts the selection - this becomes the anchor.
- SetStatus(*args, **kwargs)
- SetStatus(self, int statusCode)
Change error status - 0 = OK.
- SetStyleBits(*args, **kwargs)
- SetStyleBits(self, int bits)
Divide each styling byte into lexical class bits (default: 5) and indicator
bits (default: 3). If a lexer requires more than 32 lexical states, then this
is used to expand the possible states.
- SetStyleBytes(*args, **kwargs)
- SetStyleBytes(self, int length, char styleBytes)
Set the styles for a segment of the document.
- SetStyling(*args, **kwargs)
- SetStyling(self, int length, int style)
Change style from current styling position for length characters to a style
and move the current styling position to after this newly styled segment.
- SetTabIndents(*args, **kwargs)
- SetTabIndents(self, bool tabIndents)
Sets whether a tab pressed when caret is within indentation indents.
- SetTabWidth(*args, **kwargs)
- SetTabWidth(self, int tabWidth)
Change the visible size of a tab to be a multiple of the width of a space character.
- SetTargetEnd(*args, **kwargs)
- SetTargetEnd(self, int pos)
Sets the position that ends the target which is used for updating the
document without affecting the scroll position.
- SetTargetStart(*args, **kwargs)
- SetTargetStart(self, int pos)
Sets the position that starts the target which is used for updating the
document without affecting the scroll position.
- SetText(*args, **kwargs)
- SetText(self, String text)
Replace the contents of the document with the argument text.
- SetTextRaw(*args, **kwargs)
- SetTextRaw(self, char text)
Replace the contents of the document with the argument text. The text
should be utf-8 encoded on unicode builds of wxPython, or can be any
8-bit text in ansi builds.
- SetTextUTF8(self, text)
- Replace the contents of the document with the UTF8 text given.
Works 'natively' in a unicode build of wxPython, and will also
work in an ansi build if the UTF8 text is compatible with the
current encoding.
- SetTwoPhaseDraw(*args, **kwargs)
- SetTwoPhaseDraw(self, bool twoPhase)
In twoPhaseDraw mode, drawing is performed in two phases, first the background
and then the foreground. This avoids chopping off characters that overlap the next run.
- SetUndoCollection(*args, **kwargs)
- SetUndoCollection(self, bool collectUndo)
Choose between collecting actions into the undo
history and discarding them.
- SetUseAntiAliasing(*args, **kwargs)
- SetUseAntiAliasing(self, bool useAA)
Specify whether anti-aliased fonts should be used. Will have no
effect on some platforms, but on some (wxMac for example) can greatly
improve performance.
- SetUseHorizontalScrollBar(*args, **kwargs)
- SetUseHorizontalScrollBar(self, bool show)
Show or hide the horizontal scroll bar.
- SetUseTabs(*args, **kwargs)
- SetUseTabs(self, bool useTabs)
Indentation will only use space characters if useTabs is false, otherwise
it will use a combination of tabs and spaces.
- SetUseVerticalScrollBar(*args, **kwargs)
- SetUseVerticalScrollBar(self, bool show)
Show or hide the vertical scroll bar.
- SetVScrollBar(*args, **kwargs)
- SetVScrollBar(self, wxScrollBar bar)
Set the vertical scrollbar to use instead of the one that's built-in.
- SetViewEOL(*args, **kwargs)
- SetViewEOL(self, bool visible)
Make the end of line characters visible or invisible.
- SetViewWhiteSpace(*args, **kwargs)
- SetViewWhiteSpace(self, int viewWS)
Make white space characters invisible, always visible or visible outside indentation.
- SetVisiblePolicy(*args, **kwargs)
- SetVisiblePolicy(self, int visiblePolicy, int visibleSlop)
Set the way the display area is determined when a particular line
is to be moved to by Find, FindNext, GotoLine, etc.
- SetWhitespaceBackground(*args, **kwargs)
- SetWhitespaceBackground(self, bool useSetting, Colour back)
Set the background colour of all whitespace and whether to use this setting.
- SetWhitespaceChars(*args, **kwargs)
- SetWhitespaceChars(self, String characters)
Set the set of characters making up whitespace for when moving or selecting by word.
Should be called after SetWordChars.
- SetWhitespaceForeground(*args, **kwargs)
- SetWhitespaceForeground(self, bool useSetting, Colour fore)
Set the foreground colour of all whitespace and whether to use this setting.
- SetWordChars(*args, **kwargs)
- SetWordChars(self, String characters)
Set the set of characters making up words for when moving or selecting by word.
First sets deaults like SetCharsDefault.
- SetWrapMode(*args, **kwargs)
- SetWrapMode(self, int mode)
Sets whether text is word wrapped.
- SetWrapStartIndent(*args, **kwargs)
- SetWrapStartIndent(self, int indent)
Set the start indent for wrapped lines.
- SetWrapVisualFlags(*args, **kwargs)
- SetWrapVisualFlags(self, int wrapVisualFlags)
Set the display mode of visual flags for wrapped lines.
- SetWrapVisualFlagsLocation(*args, **kwargs)
- SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation)
Set the location of visual flags for wrapped lines.
- SetXCaretPolicy(*args, **kwargs)
- SetXCaretPolicy(self, int caretPolicy, int caretSlop)
Set the way the caret is kept visible when going sideway.
The exclusion zone is given in pixels.
- SetXOffset(*args, **kwargs)
- SetXOffset(self, int newOffset)
Get and Set the xOffset (ie, horizonal scroll position).
- SetYCaretPolicy(*args, **kwargs)
- SetYCaretPolicy(self, int caretPolicy, int caretSlop)
Set the way the line the caret is on is kept visible.
The exclusion zone is given in lines.
- SetZoom(*args, **kwargs)
- SetZoom(self, int zoom)
Set the zoom level. This number of points is added to the size of all fonts.
It may be positive to magnify or negative to reduce.
- ShowLines(*args, **kwargs)
- ShowLines(self, int lineStart, int lineEnd)
Make a range of lines visible.
- StartRecord(*args, **kwargs)
- StartRecord(self)
Start notifying the container of all key presses and commands.
- StartStyling(*args, **kwargs)
- StartStyling(self, int pos, int mask)
Set the current styling position to pos and the styling mask to mask.
The styling mask can be used to protect some bits in each styling byte from modification.
- StopRecord(*args, **kwargs)
- StopRecord(self)
Stop notifying the container of all key presses and commands.
- StutteredPageDown(*args, **kwargs)
- StutteredPageDown(self)
Move caret to bottom of page, or one page down if already at bottom of page.
- StutteredPageDownExtend(*args, **kwargs)
- StutteredPageDownExtend(self)
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
- StutteredPageUp(*args, **kwargs)
- StutteredPageUp(self)
Move caret to top of page, or one page up if already at top of page.
- StutteredPageUpExtend(*args, **kwargs)
- StutteredPageUpExtend(self)
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
- StyleClearAll(*args, **kwargs)
- StyleClearAll(self)
Clear all the styles and make equivalent to the global default style.
- StyleResetDefault(*args, **kwargs)
- StyleResetDefault(self)
Reset the default style to its state at startup
- StyleSetBackground(*args, **kwargs)
- StyleSetBackground(self, int style, Colour back)
Set the background colour of a style.
- StyleSetBold(*args, **kwargs)
- StyleSetBold(self, int style, bool bold)
Set a style to be bold or not.
- StyleSetCase(*args, **kwargs)
- StyleSetCase(self, int style, int caseForce)
Set a style to be mixed case, or to force upper or lower case.
- StyleSetChangeable(*args, **kwargs)
- StyleSetChangeable(self, int style, bool changeable)
Set a style to be changeable or not (read only).
Experimental feature, currently buggy.
- StyleSetCharacterSet(*args, **kwargs)
- StyleSetCharacterSet(self, int style, int characterSet)
Set the character set of the font in a style. Converts the Scintilla
wx.stc.STC_CHARSET_* set values to a wxFontEncoding.
- StyleSetEOLFilled(*args, **kwargs)
- StyleSetEOLFilled(self, int style, bool filled)
Set a style to have its end of line filled or not.
- StyleSetFaceName(*args, **kwargs)
- StyleSetFaceName(self, int style, String fontName)
Set the font of a style.
- StyleSetFont(*args, **kwargs)
- StyleSetFont(self, int styleNum, Font font)
Set style size, face, bold, italic, and underline attributes from the
attributes of a `wx.Font`.
- StyleSetFontAttr(*args, **kwargs)
- StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold,
bool italic, bool underline, int encoding=wxFONTENCODING_DEFAULT)
Set all font style attributes at once.
- StyleSetFontEncoding(*args, **kwargs)
- StyleSetFontEncoding(self, int style, int encoding)
Set the font encoding to be used by a style.
- StyleSetForeground(*args, **kwargs)
- StyleSetForeground(self, int style, Colour fore)
Set the foreground colour of a style.
- StyleSetHotSpot(*args, **kwargs)
- StyleSetHotSpot(self, int style, bool hotspot)
Set a style to be a hotspot or not.
- StyleSetItalic(*args, **kwargs)
- StyleSetItalic(self, int style, bool italic)
Set a style to be italic or not.
- StyleSetSize(*args, **kwargs)
- StyleSetSize(self, int style, int sizePoints)
Set the size of characters of a style.
- StyleSetSpec(*args, **kwargs)
- StyleSetSpec(self, int styleNum, String spec)
Extract style settings from a spec-string which is composed of one or
more of the following comma separated elements::
bold turns on bold
italic turns on italics
fore:[name or #RRGGBB] sets the foreground colour
back:[name or #RRGGBB] sets the background colour
face:[facename] sets the font face name to use
size:[num] sets the font size in points
eol turns on eol filling
underline turns on underlining
- StyleSetUnderline(*args, **kwargs)
- StyleSetUnderline(self, int style, bool underline)
Set a style to be underlined or not.
- StyleSetVisible(*args, **kwargs)
- StyleSetVisible(self, int style, bool visible)
Set a style to be visible or not.
- Tab(*args, **kwargs)
- Tab(self)
If selection is empty or all on one line replace the selection with a tab character.
If more than one line selected, indent the lines.
- TargetFromSelection(*args, **kwargs)
- TargetFromSelection(self)
Make the target range start and end be the same as the selection range start and end.
- TextHeight(*args, **kwargs)
- TextHeight(self, int line) -> int
Retrieve the height of a particular line of text in pixels.
- TextWidth(*args, **kwargs)
- TextWidth(self, int style, String text) -> int
Measure the pixel width of some text in a particular style.
NUL terminated text argument.
Does not handle tab or control characters.
- ToggleCaretSticky(*args, **kwargs)
- ToggleCaretSticky(self)
Switch between sticky and non-sticky: meant to be bound to a key.
- ToggleFold(*args, **kwargs)
- ToggleFold(self, int line)
Switch a header line between expanded and contracted.
- Undo(*args, **kwargs)
- Undo(self)
Undo one action in the undo history.
- UpperCase(*args, **kwargs)
- UpperCase(self)
Transform the selection to upper case.
- UsePopUp(*args, **kwargs)
- UsePopUp(self, bool allowPopUp)
Set whether a pop up menu is displayed automatically when the user presses
the wrong mouse button.
- UserListShow(*args, **kwargs)
- UserListShow(self, int listType, String itemList)
Display a list of strings and send notification when user chooses one.
- VCHome(*args, **kwargs)
- VCHome(self)
Move caret to before first visible character on line.
If already there move to first character on line.
- VCHomeExtend(*args, **kwargs)
- VCHomeExtend(self)
Like VCHome but extending selection to new caret position.
- VCHomeRectExtend(*args, **kwargs)
- VCHomeRectExtend(self)
Move caret to before first visible character on line.
If already there move to first character on line.
In either case, extend rectangular selection to new caret position.
- VCHomeWrap(*args, **kwargs)
- VCHomeWrap(self)
- VCHomeWrapExtend(*args, **kwargs)
- VCHomeWrapExtend(self)
- VisibleFromDocLine(*args, **kwargs)
- VisibleFromDocLine(self, int line) -> int
Find the display line of a document line taking hidden lines into account.
- WordEndPosition(*args, **kwargs)
- WordEndPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of end of word.
- WordLeft(*args, **kwargs)
- WordLeft(self)
Move caret left one word.
- WordLeftEnd(*args, **kwargs)
- WordLeftEnd(self)
Move caret left one word, position cursor at end of word.
- WordLeftEndExtend(*args, **kwargs)
- WordLeftEndExtend(self)
Move caret left one word, position cursor at end of word, extending selection to new caret position.
- WordLeftExtend(*args, **kwargs)
- WordLeftExtend(self)
Move caret left one word extending selection to new caret position.
- WordPartLeft(*args, **kwargs)
- WordPartLeft(self)
Move to the previous change in capitalisation.
- WordPartLeftExtend(*args, **kwargs)
- WordPartLeftExtend(self)
Move to the previous change in capitalisation extending selection
to new caret position.
- WordPartRight(*args, **kwargs)
- WordPartRight(self)
Move to the change next in capitalisation.
- WordPartRightExtend(*args, **kwargs)
- WordPartRightExtend(self)
Move to the next change in capitalisation extending selection
to new caret position.
- WordRight(*args, **kwargs)
- WordRight(self)
Move caret right one word.
- WordRightEnd(*args, **kwargs)
- WordRightEnd(self)
Move caret right one word, position cursor at end of word.
- WordRightEndExtend(*args, **kwargs)
- WordRightEndExtend(self)
Move caret right one word, position cursor at end of word, extending selection to new caret position.
- WordRightExtend(*args, **kwargs)
- WordRightExtend(self)
Move caret right one word extending selection to new caret position.
- WordStartPosition(*args, **kwargs)
- WordStartPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of start of word.
- WrapCount(*args, **kwargs)
- WrapCount(self, int line) -> int
The number of display lines needed to wrap a document line
- ZoomIn(*args, **kwargs)
- ZoomIn(self)
Magnify the displayed text by increasing the sizes by 1 point.
- ZoomOut(*args, **kwargs)
- ZoomOut(self)
Make the displayed text smaller by decreasing the sizes by 1 point.
- __repr__ = _swig_repr(self)
Data descriptors inherited from StyledTextCtrl:
- Anchor
- See `GetAnchor` and `SetAnchor`
- BackSpaceUnIndents
- See `GetBackSpaceUnIndents` and `SetBackSpaceUnIndents`
- BufferedDraw
- See `GetBufferedDraw` and `SetBufferedDraw`
- CaretForeground
- See `GetCaretForeground` and `SetCaretForeground`
- CaretLineBack
- See `GetCaretLineBack` and `SetCaretLineBack`
- CaretLineBackAlpha
- See `GetCaretLineBackAlpha` and `SetCaretLineBackAlpha`
- CaretLineBackground
- See `GetCaretLineBackground` and `SetCaretLineBackground`
- CaretLineVisible
- See `GetCaretLineVisible` and `SetCaretLineVisible`
- CaretPeriod
- See `GetCaretPeriod` and `SetCaretPeriod`
- CaretSticky
- See `GetCaretSticky` and `SetCaretSticky`
- CaretWidth
- See `GetCaretWidth` and `SetCaretWidth`
- CodePage
- See `GetCodePage` and `SetCodePage`
- ControlCharSymbol
- See `GetControlCharSymbol` and `SetControlCharSymbol`
- CurLine
- See `GetCurLine`
- CurLineRaw
- See `GetCurLineRaw`
- CurLineUTF8
- See `GetCurLineUTF8`
- CurrentLine
- See `GetCurrentLine`
- CurrentPos
- See `GetCurrentPos` and `SetCurrentPos`
- DocPointer
- See `GetDocPointer` and `SetDocPointer`
- EOLMode
- See `GetEOLMode` and `SetEOLMode`
- EdgeColour
- See `GetEdgeColour` and `SetEdgeColour`
- EdgeColumn
- See `GetEdgeColumn` and `SetEdgeColumn`
- EdgeMode
- See `GetEdgeMode` and `SetEdgeMode`
- EndAtLastLine
- See `GetEndAtLastLine` and `SetEndAtLastLine`
- EndStyled
- See `GetEndStyled`
- FirstVisibleLine
- See `GetFirstVisibleLine`
- HighlightGuide
- See `GetHighlightGuide` and `SetHighlightGuide`
- Indent
- See `GetIndent` and `SetIndent`
- IndentationGuides
- See `GetIndentationGuides` and `SetIndentationGuides`
- LastKeydownProcessed
- See `GetLastKeydownProcessed` and `SetLastKeydownProcessed`
- LayoutCache
- See `GetLayoutCache` and `SetLayoutCache`
- Length
- See `GetLength`
- Lexer
- See `GetLexer` and `SetLexer`
- LineCount
- See `GetLineCount`
- MarginLeft
- See `GetMarginLeft` and `SetMarginLeft`
- MarginRight
- See `GetMarginRight` and `SetMarginRight`
- MaxLineState
- See `GetMaxLineState`
- ModEventMask
- See `GetModEventMask` and `SetModEventMask`
- Modify
- See `GetModify`
- MouseDownCaptures
- See `GetMouseDownCaptures` and `SetMouseDownCaptures`
- MouseDwellTime
- See `GetMouseDwellTime` and `SetMouseDwellTime`
- Overtype
- See `GetOvertype` and `SetOvertype`
- PasteConvertEndings
- See `GetPasteConvertEndings` and `SetPasteConvertEndings`
- PrintColourMode
- See `GetPrintColourMode` and `SetPrintColourMode`
- PrintMagnification
- See `GetPrintMagnification` and `SetPrintMagnification`
- PrintWrapMode
- See `GetPrintWrapMode` and `SetPrintWrapMode`
- ReadOnly
- See `GetReadOnly` and `SetReadOnly`
- STCCursor
- See `GetSTCCursor` and `SetSTCCursor`
- STCFocus
- See `GetSTCFocus` and `SetSTCFocus`
- ScrollWidth
- See `GetScrollWidth` and `SetScrollWidth`
- SearchFlags
- See `GetSearchFlags` and `SetSearchFlags`
- SelAlpha
- See `GetSelAlpha` and `SetSelAlpha`
- SelectedText
- See `GetSelectedText`
- SelectedTextRaw
- See `GetSelectedTextRaw`
- SelectedTextUTF8
- See `GetSelectedTextUTF8`
- Selection
- See `GetSelection`
- SelectionEnd
- See `GetSelectionEnd` and `SetSelectionEnd`
- SelectionMode
- See `GetSelectionMode` and `SetSelectionMode`
- SelectionStart
- See `GetSelectionStart` and `SetSelectionStart`
- Status
- See `GetStatus` and `SetStatus`
- StyleBits
- See `GetStyleBits` and `SetStyleBits`
- StyleBitsNeeded
- See `GetStyleBitsNeeded`
- TabIndents
- See `GetTabIndents` and `SetTabIndents`
- TabWidth
- See `GetTabWidth` and `SetTabWidth`
- TargetEnd
- See `GetTargetEnd` and `SetTargetEnd`
- TargetStart
- See `GetTargetStart` and `SetTargetStart`
- Text
- See `GetText` and `SetText`
- TextLength
- See `GetTextLength`
- TextRaw
- See `GetTextRaw` and `SetTextRaw`
- TextUTF8
- See `GetTextUTF8` and `SetTextUTF8`
- TwoPhaseDraw
- See `GetTwoPhaseDraw` and `SetTwoPhaseDraw`
- UndoCollection
- See `GetUndoCollection` and `SetUndoCollection`
- UseAntiAliasing
- See `GetUseAntiAliasing` and `SetUseAntiAliasing`
- UseHorizontalScrollBar
- See `GetUseHorizontalScrollBar` and `SetUseHorizontalScrollBar`
- UseTabs
- See `GetUseTabs` and `SetUseTabs`
- UseVerticalScrollBar
- See `GetUseVerticalScrollBar` and `SetUseVerticalScrollBar`
- ViewEOL
- See `GetViewEOL` and `SetViewEOL`
- ViewWhiteSpace
- See `GetViewWhiteSpace` and `SetViewWhiteSpace`
- WrapMode
- See `GetWrapMode` and `SetWrapMode`
- WrapStartIndent
- See `GetWrapStartIndent` and `SetWrapStartIndent`
- WrapVisualFlags
- See `GetWrapVisualFlags` and `SetWrapVisualFlags`
- WrapVisualFlagsLocation
- See `GetWrapVisualFlagsLocation` and `SetWrapVisualFlagsLocation`
- XOffset
- See `GetXOffset` and `SetXOffset`
- Zoom
- See `GetZoom` and `SetZoom`
- thisown
- The membership flag
Methods inherited from Control:
- Command(*args, **kwargs)
- Command(self, CommandEvent event)
Simulates the effect of the user issuing a command to the item.
:see: `wx.CommandEvent`
- GetAlignment(*args, **kwargs)
- GetAlignment(self) -> int
Get the control alignment (left/right/centre, top/bottom/centre)
- GetLabelText(*args, **kwargs)
- GetLabelText(self) -> String
Get just the text of the label, without mnemonic characters ('&')
Static methods inherited from Control:
- GetClassDefaultAttributes(*args, **kwargs)
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want
to use the same font or colour in your own control as in a standard
control -- which is a much better idea than hard coding specific
colours or fonts which might look completely out of place on the
user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See `wx.Window.SetWindowVariant` for more about
this.
Data descriptors inherited from Control:
- Alignment
- See `GetAlignment`
- LabelText
- See `GetLabelText`
Methods inherited from Window:
- AcceptsFocus(*args, **kwargs)
- AcceptsFocus(self) -> bool
Can this window have focus?
- AcceptsFocusFromKeyboard(*args, **kwargs)
- AcceptsFocusFromKeyboard(self) -> bool
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.
- AddChild(*args, **kwargs)
- AddChild(self, Window child)
Adds a child window. This is called automatically by window creation
functions so should not be required by the application programmer.
- AdjustForLayoutDirection(*args, **kwargs)
- AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
Mirror coordinates for RTL layout if this window uses it and if the
mirroring is not done automatically like Win32.
- AssociateHandle(*args, **kwargs)
- AssociateHandle(self, long handle)
Associate the window with a new native handle
- CacheBestSize(*args, **kwargs)
- CacheBestSize(self, Size size)
Cache the best size so it doesn't need to be calculated again, (at least until
some properties of the window change.)
- CanSetTransparent(*args, **kwargs)
- CanSetTransparent(self) -> bool
Returns ``True`` if the platform supports setting the transparency for
this window. Note that this method will err on the side of caution,
so it is possible that this will return ``False`` when it is in fact
possible to set the transparency.
NOTE: On X-windows systems the X server must have the composite
extension loaded, and there must be a composite manager program (such
as xcompmgr) running.
- CaptureMouse(*args, **kwargs)
- CaptureMouse(self)
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, unless the window
receives the `wx.MouseCaptureLostEvent` event.
Any application which captures the mouse in the beginning of some
operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
operation when it receives the event. The event handler must not
recapture mouse.
- Center(*args, **kwargs)
- Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for
centering, 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.
- CenterOnParent(*args, **kwargs)
- CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
- Centre = Center(*args, **kwargs)
- Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for
centering, 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.
- CentreOnParent = CenterOnParent(*args, **kwargs)
- CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
- ClearBackground(*args, **kwargs)
- ClearBackground(self)
Clears the window by filling it with the current background
colour. Does not cause an erase background event to be generated.
- ClientToScreen(*args, **kwargs)
- ClientToScreen(self, Point pt) -> Point
Converts to screen coordinates from coordinates relative to this window.
- ClientToScreenXY(*args, **kwargs)
- ClientToScreenXY(int x, int y) -> (x,y)
Converts to screen coordinates from coordinates relative to this window.
- ClientToWindowSize(*args, **kwargs)
- ClientToWindowSize(self, Size size) -> Size
- Close(*args, **kwargs)
- Close(self, bool force=False) -> bool
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.
- ConvertDialogPointToPixels(*args, **kwargs)
- ConvertDialogPointToPixels(self, Point pt) -> Point
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.
- ConvertDialogSizeToPixels(*args, **kwargs)
- ConvertDialogSizeToPixels(self, Size sz) -> Size
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.
- ConvertPixelPointToDialog(*args, **kwargs)
- ConvertPixelPointToDialog(self, Point pt) -> Point
- ConvertPixelSizeToDialog(*args, **kwargs)
- ConvertPixelSizeToDialog(self, Size sz) -> Size
- DLG_PNT(*args, **kwargs)
- DLG_PNT(self, Point pt) -> Point
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.
- DLG_SZE(*args, **kwargs)
- DLG_SZE(self, Size sz) -> Size
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.
- Destroy(*args, **kwargs)
- Destroy(self) -> bool
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.
- DestroyChildren(*args, **kwargs)
- DestroyChildren(self) -> bool
Destroys all children of a window. Called automatically by the
destructor.
- Disable(*args, **kwargs)
- Disable(self) -> bool
Disables the window, same as Enable(false).
- DissociateHandle(*args, **kwargs)
- DissociateHandle(self)
Dissociate the current native handle from the window
- DragAcceptFiles(*args, **kwargs)
- DragAcceptFiles(self, bool accept)
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
- Enable(*args, **kwargs)
- Enable(self, bool enable=True) -> bool
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.
- FindWindowById(*args, **kwargs)
- FindWindowById(self, long winid) -> Window
Find a child of this window by window ID
- FindWindowByLabel(*args, **kwargs)
- FindWindowByLabel(self, String label) -> Window
Find a child of this window by label
- FindWindowByName(*args, **kwargs)
- FindWindowByName(self, String name) -> Window
Find a child of this window by name
- Fit(*args, **kwargs)
- Fit(self)
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.
- FitInside(*args, **kwargs)
- FitInside(self)
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.
- Freeze(*args, **kwargs)
- Freeze(self)
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
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.
- GetAcceleratorTable(*args, **kwargs)
- GetAcceleratorTable(self) -> AcceleratorTable
Gets the accelerator table for this window.
- GetAdjustedBestSize = deprecatedWrapper(*args, **kwargs)
- Use `GetEffectiveMinSize` instead.
- GetAutoLayout(*args, **kwargs)
- GetAutoLayout(self) -> bool
Returns the current autoLayout setting
- GetBackgroundColour(*args, **kwargs)
- GetBackgroundColour(self) -> Colour
Returns the background colour of the window.
- GetBackgroundStyle(*args, **kwargs)
- GetBackgroundStyle(self) -> int
Returns the background style of the window.
:see: `SetBackgroundStyle`
- GetBestFittingSize = deprecatedWrapper(*args, **kwargs)
- Use `GetEffectiveMinSize` instead.
- GetBestSize(*args, **kwargs)
- GetBestSize(self) -> Size
This function 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 (such as wx.Panel), the size returned by
this function will be the same as the size the window would have had
after calling Fit.
- GetBestSizeTuple(*args, **kwargs)
- GetBestSizeTuple() -> (width, height)
This function 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 (such as wx.Panel), the size returned by
this function will be the same as the size the window would have had
after calling Fit.
- GetBestVirtualSize(*args, **kwargs)
- GetBestVirtualSize(self) -> Size
Return the largest of ClientSize and BestSize (as determined by a
sizer, interior children, or other means)
- GetBorder(*args)
- GetBorder(self, long flags) -> int
GetBorder(self) -> int
Get border for the flags of this window
- GetCaret(*args, **kwargs)
- GetCaret(self) -> Caret
Returns the caret associated with the window.
- GetCharHeight(*args, **kwargs)
- GetCharHeight(self) -> int
Get the (average) character size for the current font.
- GetCharWidth(*args, **kwargs)
- GetCharWidth(self) -> int
Get the (average) character size for the current font.
- GetChildren(*args, **kwargs)
- GetChildren(self) -> WindowList
Returns an object containing a list of the window's children. The
object provides a Python sequence-like interface over the internal
list maintained by the window..
- GetClientAreaOrigin(*args, **kwargs)
- GetClientAreaOrigin(self) -> Point
Get the origin of the client area of the window relative to the
window's top left corner (the client area may be shifted because of
the borders, scrollbars, other decorations...)
- GetClientRect(*args, **kwargs)
- GetClientRect(self) -> Rect
Get the client area position and size as a `wx.Rect` object.
- GetClientSize(*args, **kwargs)
- GetClientSize(self) -> Size
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.
- GetClientSizeTuple(*args, **kwargs)
- GetClientSizeTuple() -> (width, height)
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.
- GetConstraints(*args, **kwargs)
- GetConstraints(self) -> LayoutConstraints
Returns a pointer to the window's layout constraints, or None if there
are none.
- GetContainingSizer(*args, **kwargs)
- GetContainingSizer(self) -> Sizer
Return the sizer that this window is a member of, if any, otherwise None.
- GetCursor(*args, **kwargs)
- GetCursor(self) -> Cursor
Return the cursor associated with this window.
- GetDefaultAttributes(*args, **kwargs)
- GetDefaultAttributes(self) -> VisualAttributes
Get the default attributes for an instance of this class. This is
useful if you want to use the same font or colour in your own control
as in a standard control -- which is a much better idea than hard
coding specific colours or fonts which might look completely out of
place on the user's system, especially if it uses themes.
- GetDropTarget(*args, **kwargs)
- GetDropTarget(self) -> DropTarget
Returns the associated drop target, which may be None.
- GetEffectiveMinSize(*args, **kwargs)
- GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's
minimum size, giving priority to the min size components, and returns
the results.
- GetEventHandler(*args, **kwargs)
- GetEventHandler(self) -> EvtHandler
Returns the event handler for this window. By default, the window is
its own event handler.
- GetExtraStyle(*args, **kwargs)
- GetExtraStyle(self) -> long
Returns the extra style bits for the window.
- GetFont(*args, **kwargs)
- GetFont(self) -> Font
Returns the default font used for this window.
- GetForegroundColour(*args, **kwargs)
- GetForegroundColour(self) -> Colour
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.
- GetFullTextExtent(*args, **kwargs)
- GetFullTextExtent(String string, Font font=None) ->
(width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the
current or specified font.
- GetGrandParent(*args, **kwargs)
- GetGrandParent(self) -> Window
Returns the parent of the parent of this window, or None if there
isn't one.
- GetGtkWidget(*args, **kwargs)
- GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long
integer. On the other platforms this method returns zero.
- GetHandle(*args, **kwargs)
- GetHandle(self) -> long
Returns the platform-specific handle (as a long integer) of the
physical window. On wxMSW this is the win32 window handle, on wxGTK
it is the XWindow ID, and on wxMac it is the ControlRef.
- GetHelpText(*args, **kwargs)
- GetHelpText(self) -> String
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
`wx.HelpProvider` implementation, and not in the window object itself.
- GetHelpTextAtPoint(*args, **kwargs)
- GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown
and this method should return the global window help text then
- GetId(*args, **kwargs)
- GetId(self) -> int
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.
- GetLabel(*args, **kwargs)
- GetLabel(self) -> String
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.
- GetLayoutDirection(*args, **kwargs)
- GetLayoutDirection(self) -> int
Get the layout direction (LTR or RTL) for this window. Returns
``wx.Layout_Default`` if layout direction is not supported.
- GetMaxHeight(*args, **kwargs)
- GetMaxHeight(self) -> int
- GetMaxSize(*args, **kwargs)
- GetMaxSize(self) -> Size
- GetMaxWidth(*args, **kwargs)
- GetMaxWidth(self) -> int
- GetMinHeight(*args, **kwargs)
- GetMinHeight(self) -> int
- GetMinSize(*args, **kwargs)
- GetMinSize(self) -> Size
- GetMinWidth(*args, **kwargs)
- GetMinWidth(self) -> int
- GetName(*args, **kwargs)
- GetName(self) -> String
Returns the windows 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.
- GetParent(*args, **kwargs)
- GetParent(self) -> Window
Returns the parent window of this window, or None if there isn't one.
- GetPosition(*args, **kwargs)
- GetPosition(self) -> Point
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use `GetScreenPosition` if you need screen coordinates for all
kinds of windows.
- GetPositionTuple(*args, **kwargs)
- GetPositionTuple() -> (x,y)
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use `GetScreenPosition` if you need screen coordinates for all
kinds of windows.
- GetRect(*args, **kwargs)
- GetRect(self) -> Rect
Returns the size and position of the window as a `wx.Rect` object.
- GetScreenPosition(*args, **kwargs)
- GetScreenPosition(self) -> Point
Get the position of the window in screen coordinantes.
- GetScreenPositionTuple(*args, **kwargs)
- GetScreenPositionTuple() -> (x,y)
Get the position of the window in screen coordinantes.
- GetScreenRect(*args, **kwargs)
- GetScreenRect(self) -> Rect
Returns the size and position of the window in screen coordinantes as
a `wx.Rect` object.
- GetScrollPos(*args, **kwargs)
- GetScrollPos(self, int orientation) -> int
Returns the built-in scrollbar position.
- GetScrollRange(*args, **kwargs)
- GetScrollRange(self, int orientation) -> int
Returns the built-in scrollbar range.
- GetScrollThumb(*args, **kwargs)
- GetScrollThumb(self, int orientation) -> int
Returns the built-in scrollbar thumb size.
- GetSize(*args, **kwargs)
- GetSize(self) -> Size
Get the window size.
- GetSizeTuple(*args, **kwargs)
- GetSizeTuple() -> (width, height)
Get the window size.
- GetSizer(*args, **kwargs)
- GetSizer(self) -> Sizer
Return the sizer associated with the window by a previous call to
SetSizer or None if there isn't one.
- GetTextExtent(*args, **kwargs)
- GetTextExtent(String string) -> (width, height)
Get the width and height of the text using the current font.
- GetThemeEnabled(*args, **kwargs)
- GetThemeEnabled(self) -> bool
Return the themeEnabled flag.
- GetToolTip(*args, **kwargs)
- GetToolTip(self) -> ToolTip
get the associated tooltip or None if none
- GetToolTipString(self)
- GetTopLevelParent(*args, **kwargs)
- GetTopLevelParent(self) -> Window
Returns the first frame or dialog in this window's parental hierarchy.
- GetUpdateClientRect(*args, **kwargs)
- GetUpdateClientRect(self) -> Rect
Get the update rectangle region bounding box in client coords.
- GetUpdateRegion(*args, **kwargs)
- GetUpdateRegion(self) -> Region
Returns the region specifying which parts of the window have been
damaged. Should only be called within an EVT_PAINT handler.
- GetValidator(*args, **kwargs)
- GetValidator(self) -> Validator
Returns a pointer to the current validator for the window, or None if
there is none.
- GetVirtualSize(*args, **kwargs)
- GetVirtualSize(self) -> Size
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.
- GetVirtualSizeTuple(*args, **kwargs)
- GetVirtualSizeTuple() -> (width, height)
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.
- GetWindowBorderSize(*args, **kwargs)
- GetWindowBorderSize(self) -> Size
Return the size of the left/right and top/bottom borders.
- GetWindowStyle = GetWindowStyleFlag(*args, **kwargs)
- GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create
method.
- GetWindowStyleFlag(*args, **kwargs)
- GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create
method.
- GetWindowVariant(*args, **kwargs)
- GetWindowVariant(self) -> int
- HasCapture(*args, **kwargs)
- HasCapture(self) -> bool
Returns true if this window has the current mouse capture.
- HasFlag(*args, **kwargs)
- HasFlag(self, int flag) -> bool
Test if the given style is set for this window.
- HasMultiplePages(*args, **kwargs)
- HasMultiplePages(self) -> bool
- HasScrollbar(*args, **kwargs)
- HasScrollbar(self, int orient) -> bool
Does the window have the scrollbar for this orientation?
- HasTransparentBackground(*args, **kwargs)
- HasTransparentBackground(self) -> bool
Returns True if this window's background is transparent (as, for
example, for `wx.StaticText`) and should show the parent window's
background.
This method is mostly used internally by the library itself and you
normally shouldn't have to call it. You may, however, have to override
it in your custom control classes to ensure that background is painted
correctly.
- Hide(*args, **kwargs)
- Hide(self) -> bool
Equivalent to calling Show(False).
- HitTest(*args, **kwargs)
- HitTest(self, Point pt) -> int
Test where the given (in client coords) point lies
- HitTestXY(*args, **kwargs)
- HitTestXY(self, int x, int y) -> int
Test where the given (in client coords) point lies
- InheritAttributes(*args, **kwargs)
- InheritAttributes(self)
This function is (or should be, in case of custom controls) called
during window creation to intelligently set up the window visual
attributes, that is the font and the foreground and background
colours.
By 'intelligently' the following is meant: by default, all windows use
their own default attributes. However if some of the parent's
attributes are explicitly changed (that is, using SetFont and not
SetOwnFont) and if the corresponding attribute hadn't been
explicitly set for this window itself, then this window takes the same
value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might.
This rather complicated logic is necessary in order to accommodate the
different usage scenarios. The most common one is when all default
attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours)
than their siblings so they can't inherit the same value from the
parent. However it was also deemed desirable to allow to simply change
the attributes of all children at once by just changing the font or
colour of their common parent, hence in this case we do inherit the
parents attributes.
- InheritsBackgroundColour(*args, **kwargs)
- InheritsBackgroundColour(self) -> bool
- InitDialog(*args, **kwargs)
- InitDialog(self)
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
to the dialog via validators.
- InvalidateBestSize(*args, **kwargs)
- InvalidateBestSize(self)
Reset the cached best size value so it will be recalculated the next
time it is needed.
- IsBeingDeleted(*args, **kwargs)
- IsBeingDeleted(self) -> bool
Is the window in the process of being deleted?
- IsDoubleBuffered(*args, **kwargs)
- IsDoubleBuffered(self) -> bool
Returns ``True`` if the window contents is double-buffered by the
system, i.e. if any drawing done on the window is really done on a
temporary backing surface and transferred to the screen all at once
later.
- IsEnabled(*args, **kwargs)
- IsEnabled(self) -> bool
Returns true if the window is enabled for input, false otherwise.
- IsExposed(*args, **kwargs)
- IsExposed(self, int x, int y, int w=1, int h=1) -> bool
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.
- IsExposedPoint(*args, **kwargs)
- IsExposedPoint(self, Point pt) -> bool
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.
- IsExposedRect(*args, **kwargs)
- IsExposedRect(self, Rect rect) -> bool
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.
- IsFrozen(*args, **kwargs)
- IsFrozen(self) -> bool
Returns ``True`` if the window has been frozen and not thawed yet.
:see: `Freeze` and `Thaw`
- IsRetained(*args, **kwargs)
- IsRetained(self) -> bool
Returns true if the window is retained, false otherwise. Retained
windows are only available on X platforms.
- IsShown(*args, **kwargs)
- IsShown(self) -> bool
Returns true if the window is shown, false if it has been hidden.
- IsShownOnScreen(*args, **kwargs)
- IsShownOnScreen(self) -> bool
Returns ``True`` if the window is physically visible on the screen,
i.e. it is shown and all its parents up to the toplevel window are
shown as well.
- IsTopLevel(*args, **kwargs)
- IsTopLevel(self) -> bool
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).
- Layout(*args, **kwargs)
- Layout(self) -> bool
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.
- Lower(*args, **kwargs)
- Lower(self)
Lowers the window to the bottom of the window hierarchy. In current
version of wxWidgets this works both for managed and child windows.
- MakeModal(*args, **kwargs)
- MakeModal(self, bool modal=True)
Disables all other windows in the application so that the user can
only interact with this window. Passing False will reverse this
effect.
- Move(*args, **kwargs)
- Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- MoveAfterInTabOrder(*args, **kwargs)
- MoveAfterInTabOrder(self, Window win)
Moves this window in the tab navigation order after the specified
sibling window. This means that when the user presses the TAB key on
that other window, the focus switches to this window.
The default tab order is the same as creation order. This function
and `MoveBeforeInTabOrder` allow to change it after creating all the
windows.
- MoveBeforeInTabOrder(*args, **kwargs)
- MoveBeforeInTabOrder(self, Window win)
Same as `MoveAfterInTabOrder` except that it inserts this window just
before win instead of putting it right after it.
- MoveXY(*args, **kwargs)
- MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- Navigate(*args, **kwargs)
- Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
Does keyboard navigation from this window to another, by sending a
`wx.NavigationKeyEvent`.
- PopEventHandler(*args, **kwargs)
- PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
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, and ``None`` will be returned instead.
- PopupMenu(*args, **kwargs)
- PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
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. If the default position is given then the current position of the
mouse cursor will be used.
- PopupMenuXY(*args, **kwargs)
- PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
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. If the default position is given then the current position of the
mouse cursor will be used.
- PostCreate(self, pre)
- Phase 3 of the 2-phase create <wink!>
Call this method after precreating the window with the 2-phase create method.
- PrepareDC(*args, **kwargs)
- PrepareDC(self, DC dc)
Call this function to prepare the device context for drawing a
scrolled image. It sets the device origin according to the current
scroll position.
- PushEventHandler(*args, **kwargs)
- PushEventHandler(self, EvtHandler handler)
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. (In other words, is able to dispatch the events to a
handler function.) 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. Ownership of the handler is *not* given
to the window, so you should be sure to pop the handler before the
window is destroyed and either let PopEventHandler destroy it, or call
its Destroy method yourself.
- Raise(*args, **kwargs)
- Raise(self)
Raises the window to the top of the window hierarchy. In current
version of wxWidgets this works both for managed and child windows.
- Refresh(*args, **kwargs)
- Refresh(self, bool eraseBackground=True, Rect rect=None)
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.
- RefreshRect(*args, **kwargs)
- RefreshRect(self, Rect rect, bool eraseBackground=True)
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.
- RegisterHotKey(*args, **kwargs)
- RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
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.
- ReleaseMouse(*args, **kwargs)
- ReleaseMouse(self)
Releases mouse input captured with wx.Window.CaptureMouse.
- RemoveChild(*args, **kwargs)
- RemoveChild(self, Window child)
Removes a child window. This is called automatically by window
deletion functions so should not be required by the application
programmer.
- RemoveEventHandler(*args, **kwargs)
- RemoveEventHandler(self, EvtHandler handler) -> bool
Find the given handler in the event handler chain and remove (but not
delete) it from the event handler chain, returns 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.)
- Reparent(*args, **kwargs)
- Reparent(self, Window newParent) -> bool
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)
- ScreenToClient(*args, **kwargs)
- ScreenToClient(self, Point pt) -> Point
Converts from screen to client window coordinates.
- ScreenToClientXY(*args, **kwargs)
- ScreenToClientXY(int x, int y) -> (x,y)
Converts from screen to client window coordinates.
- ScrollLines(*args, **kwargs)
- ScrollLines(self, int lines) -> bool
If the platform and window class supports it, scrolls the window by
the given number of lines down, if lines is positive, or up if lines
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.
- ScrollPages(*args, **kwargs)
- ScrollPages(self, int pages) -> bool
If the platform and window class supports it, scrolls the window by
the given number of pages down, if pages is positive, or up if pages
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.
- ScrollWindow(*args, **kwargs)
- ScrollWindow(self, int dx, int dy, Rect rect=None)
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.
- SendSizeEvent(self)
- SetAcceleratorTable(*args, **kwargs)
- SetAcceleratorTable(self, AcceleratorTable accel)
Sets the accelerator table for this window.
- SetAutoLayout(*args, **kwargs)
- SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
when the window is resized. lease note that this only happens for the
windows usually used to contain children, namely `wx.Panel` and
`wx.TopLevelWindow` (and the classes deriving from them).
This method 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.
- SetBackgroundColour(*args, **kwargs)
- SetBackgroundColour(self, Colour colour) -> bool
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. Using `wx.NullColour` will reset the window
to the default background colour.
Note that setting the background colour may not cause an immediate
refresh, so you may wish to call `ClearBackground` or `Refresh` after
calling this function.
Using this function will disable attempts to use themes for this
window, if the system supports them. Use with care since usually the
themes represent the appearance chosen by the user to be used for all
applications on the system.
- SetBackgroundStyle(*args, **kwargs)
- SetBackgroundStyle(self, int style) -> bool
Returns the background style of the window. The background style
indicates how the background of the window is drawn.
====================== ========================================
wx.BG_STYLE_SYSTEM The background colour or pattern should
be determined by the system
wx.BG_STYLE_COLOUR The background should be a solid colour
wx.BG_STYLE_CUSTOM The background will be implemented by the
application.
====================== ========================================
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
a custom background, such as a tiled bitmap. Currently the style has
no effect on other platforms.
:see: `GetBackgroundStyle`, `SetBackgroundColour`
- SetBestFittingSize = deprecatedWrapper(*args, **kwargs)
- Use `SetInitialSize`
- SetCaret(*args, **kwargs)
- SetCaret(self, Caret caret)
Sets the caret associated with the window.
- SetClientRect(*args, **kwargs)
- SetClientRect(self, Rect rect)
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.
- SetClientSize(*args, **kwargs)
- SetClientSize(self, Size size)
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.
- SetClientSizeWH(*args, **kwargs)
- SetClientSizeWH(self, int width, int height)
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.
- SetConstraints(*args, **kwargs)
- SetConstraints(self, LayoutConstraints constraints)
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.
- SetContainingSizer(*args, **kwargs)
- SetContainingSizer(self, Sizer sizer)
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.
- SetCursor(*args, **kwargs)
- SetCursor(self, Cursor cursor) -> bool
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.
- SetDimensions(*args, **kwargs)
- SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels. The sizeFlags
parameter indicates the interpretation of the other params if they are
equal to -1.
======================== ======================================
wx.SIZE_AUTO A -1 indicates that a class-specific
default should 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.
======================== ======================================
- SetDoubleBuffered(*args, **kwargs)
- SetDoubleBuffered(self, bool on)
Put the native window into double buffered or composited mode.
- SetDropTarget(*args, **kwargs)
- SetDropTarget(self, DropTarget dropTarget)
Associates a drop target with this window. If the window already has
a drop target, it is deleted.
- SetEventHandler(*args, **kwargs)
- SetEventHandler(self, EvtHandler handler)
Sets the event handler for this window. An event handler is an object
that is capable of processing the events sent to a window. (In other
words, is able to dispatch the events to handler function.) 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 off to the next one in the chain.
- SetExtraStyle(*args, **kwargs)
- SetExtraStyle(self, long exStyle)
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()
- SetFocus(*args, **kwargs)
- SetFocus(self)
Set's the focus to this window, allowing it to receive keyboard input.
- SetFocusFromKbd(*args, **kwargs)
- SetFocusFromKbd(self)
Set focus to this window as the result of a keyboard action. Normally
only called internally.
- SetFont(*args, **kwargs)
- SetFont(self, Font font) -> bool
Sets the font for this window.
- SetForegroundColour(*args, **kwargs)
- SetForegroundColour(self, Colour colour) -> bool
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.
- SetHelpText(*args, **kwargs)
- SetHelpText(self, String text)
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
`wx.HelpProvider` implementation, and not in the window object itself.
- SetHelpTextForId(*args, **kwargs)
- SetHelpTextForId(self, String text)
Associate this help text with all windows with the same id as this
one.
- SetId(*args, **kwargs)
- SetId(self, int winid)
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.
- SetInitialSize(*args, **kwargs)
- SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the
window's *best size* values. Also set's the minsize for use with sizers.
- SetLabel(*args, **kwargs)
- SetLabel(self, String label)
Set the text which the window shows in its label if applicable.
- SetLayoutDirection(*args, **kwargs)
- SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
- SetMaxSize(*args, **kwargs)
- SetMaxSize(self, Size maxSize)
A more convenient method than `SetSizeHints` for setting just the
max size.
- SetMinSize(*args, **kwargs)
- SetMinSize(self, Size minSize)
A more convenient method than `SetSizeHints` for setting just the
min size.
- SetName(*args, **kwargs)
- SetName(self, String name)
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
- SetOwnBackgroundColour(*args, **kwargs)
- SetOwnBackgroundColour(self, Colour colour)
- SetOwnFont(*args, **kwargs)
- SetOwnFont(self, Font font)
- SetOwnForegroundColour(*args, **kwargs)
- SetOwnForegroundColour(self, Colour colour)
- SetPosition = Move(*args, **kwargs)
- Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
- SetRect(*args, **kwargs)
- SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels using a wx.Rect.
- SetScrollPos(*args, **kwargs)
- SetScrollPos(self, int orientation, int pos, bool refresh=True)
Sets the position of one of the built-in scrollbars.
- SetScrollbar(*args, **kwargs)
- SetScrollbar(self, int orientation, int position, int thumbSize, int range,
bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
- SetSize(*args, **kwargs)
- SetSize(self, Size size)
Sets the size of the window in pixels.
- SetSizeHints(*args, **kwargs)
- SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
int incH=-1)
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 (if it is
a top-level window.) Sizers will also inspect the minimum window size
and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
- SetSizeHintsSz(*args, **kwargs)
- SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
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 (if it is
a top-level window.) Sizers will also inspect the minimum window size
and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
- SetSizeWH(*args, **kwargs)
- SetSizeWH(self, int width, int height)
Sets the size of the window in pixels.
- SetSizer(*args, **kwargs)
- SetSizer(self, Sizer sizer, bool deleteOld=True)
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-None, and False otherwise.
- SetSizerAndFit(*args, **kwargs)
- SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
The same as SetSizer, except it also sets the size hints for the
window based on the sizer's minimum size.
- SetThemeEnabled(*args, **kwargs)
- SetThemeEnabled(self, bool enableTheme)
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.
- SetToolTip(*args, **kwargs)
- SetToolTip(self, ToolTip tip)
Attach a tooltip to the window.
- SetToolTipString(*args, **kwargs)
- SetToolTipString(self, String tip)
Attach a tooltip to the window.
- SetTransparent(*args, **kwargs)
- SetTransparent(self, byte alpha) -> bool
Attempt to set the transparency of this window to the ``alpha`` value,
returns True on success. The ``alpha`` value is an integer in the
range of 0 to 255, where 0 is fully transparent and 255 is fully
opaque.
- SetValidator(*args, **kwargs)
- SetValidator(self, Validator validator)
Deletes the current validator (if any) and sets the window validator,
having called wx.Validator.Clone to create a new validator of this
type.
- SetVirtualSize(*args, **kwargs)
- SetVirtualSize(self, Size size)
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.
- SetVirtualSizeHints(*args, **kwargs)
- SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
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.
- SetVirtualSizeHintsSz(*args, **kwargs)
- SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
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.
- SetVirtualSizeWH(*args, **kwargs)
- SetVirtualSizeWH(self, int w, int h)
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.
- SetWindowStyle = SetWindowStyleFlag(*args, **kwargs)
- SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be
changed after the window creation and that Refresh() might need to be
called after changing the others for the change to take place
immediately.
- SetWindowStyleFlag(*args, **kwargs)
- SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be
changed after the window creation and that Refresh() might need to be
called after changing the others for the change to take place
immediately.
- SetWindowVariant(*args, **kwargs)
- SetWindowVariant(self, int variant)
Sets the variant of the window/font size to use for this window, if
the platform supports variants, for example, wxMac.
- ShouldInheritColours(*args, **kwargs)
- ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be
changed by InheritAttributes, returning false forbids inheriting them
from the parent window.
The base class version returns false, but this method is overridden in
wxControl where it returns true.
- Show(*args, **kwargs)
- Show(self, bool show=True) -> bool
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.
- Thaw(*args, **kwargs)
- Thaw(self)
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.
- ToggleWindowStyle(*args, **kwargs)
- ToggleWindowStyle(self, int flag) -> bool
Turn the flag on if it had been turned off before and vice versa,
returns True if the flag is turned on by this function call.
- TransferDataFromWindow(*args, **kwargs)
- TransferDataFromWindow(self) -> bool
Transfers values from child controls to data areas specified by their
validators. Returns false if a transfer failed. If the window has
wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
also call TransferDataFromWindow() of all child windows.
- TransferDataToWindow(*args, **kwargs)
- TransferDataToWindow(self) -> bool
Transfers values to child controls from data areas specified by their
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
style flag set, the method will also call TransferDataToWindow() of
all child windows.
- UnregisterHotKey(*args, **kwargs)
- UnregisterHotKey(self, int hotkeyId) -> bool
Unregisters a system wide hotkey.
- Update(*args, **kwargs)
- Update(self)
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.
- UpdateWindowUI(*args, **kwargs)
- UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
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.
- UseBgCol(*args, **kwargs)
- UseBgCol(self) -> bool
- Validate(*args, **kwargs)
- Validate(self) -> bool
Validates the current values of the child controls using their
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
style flag set, the method will also call Validate() of all child
windows. Returns false if any of the validations failed.
- WarpPointer(*args, **kwargs)
- WarpPointer(self, int x, int y)
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.
- WindowToClientSize(*args, **kwargs)
- WindowToClientSize(self, Size size) -> Size
Static methods inherited from Window:
- FindFocus(*args, **kwargs)
- FindFocus() -> Window
Returns the window or control that currently has the keyboard focus,
or None.
- GetCapture(*args, **kwargs)
- GetCapture() -> Window
Returns the window which currently captures the mouse or None
- NewControlId(*args, **kwargs)
- NewControlId() -> int
Generate a control id for the controls which were not given one.
- NextControlId(*args, **kwargs)
- NextControlId(int winid) -> int
Get the id of the control following the one with the given
autogenerated) id
- PrevControlId(*args, **kwargs)
- PrevControlId(int winid) -> int
Get the id of the control preceding the one with the given
autogenerated) id
Data descriptors inherited from Window:
- AcceleratorTable
- See `GetAcceleratorTable` and `SetAcceleratorTable`
- AutoLayout
- See `GetAutoLayout` and `SetAutoLayout`
- BackgroundColour
- See `GetBackgroundColour` and `SetBackgroundColour`
- BackgroundStyle
- See `GetBackgroundStyle` and `SetBackgroundStyle`
- BestSize
- See `GetBestSize`
- BestVirtualSize
- See `GetBestVirtualSize`
- Border
- See `GetBorder`
- Caret
- See `GetCaret` and `SetCaret`
- CharHeight
- See `GetCharHeight`
- CharWidth
- See `GetCharWidth`
- Children
- See `GetChildren`
- ClientAreaOrigin
- See `GetClientAreaOrigin`
- ClientRect
- See `GetClientRect` and `SetClientRect`
- ClientSize
- See `GetClientSize` and `SetClientSize`
- Constraints
- See `GetConstraints` and `SetConstraints`
- ContainingSizer
- See `GetContainingSizer` and `SetContainingSizer`
- Cursor
- See `GetCursor` and `SetCursor`
- DefaultAttributes
- See `GetDefaultAttributes`
- DropTarget
- See `GetDropTarget` and `SetDropTarget`
- EffectiveMinSize
- See `GetEffectiveMinSize`
- Enabled
- See `IsEnabled` and `Enable`
- EventHandler
- See `GetEventHandler` and `SetEventHandler`
- ExtraStyle
- See `GetExtraStyle` and `SetExtraStyle`
- Font
- See `GetFont` and `SetFont`
- ForegroundColour
- See `GetForegroundColour` and `SetForegroundColour`
- GrandParent
- See `GetGrandParent`
- GtkWidget
- GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long
integer. On the other platforms this method returns zero.
- Handle
- See `GetHandle`
- HelpText
- See `GetHelpText` and `SetHelpText`
- Id
- See `GetId` and `SetId`
- Label
- See `GetLabel` and `SetLabel`
- LayoutDirection
- See `GetLayoutDirection` and `SetLayoutDirection`
- MaxHeight
- See `GetMaxHeight`
- MaxSize
- See `GetMaxSize` and `SetMaxSize`
- MaxWidth
- See `GetMaxWidth`
- MinHeight
- See `GetMinHeight`
- MinSize
- See `GetMinSize` and `SetMinSize`
- MinWidth
- See `GetMinWidth`
- Name
- See `GetName` and `SetName`
- Parent
- See `GetParent`
- Position
- See `GetPosition` and `SetPosition`
- Rect
- See `GetRect` and `SetRect`
- ScreenPosition
- See `GetScreenPosition`
- ScreenRect
- See `GetScreenRect`
- Shown
- See `IsShown` and `Show`
- Size
- See `GetSize` and `SetSize`
- Sizer
- See `GetSizer` and `SetSizer`
- ThemeEnabled
- See `GetThemeEnabled` and `SetThemeEnabled`
- ToolTip
- See `GetToolTip` and `SetToolTip`
- ToolTipString
- TopLevel
- See `IsTopLevel`
- TopLevelParent
- See `GetTopLevelParent`
- UpdateClientRect
- See `GetUpdateClientRect`
- UpdateRegion
- See `GetUpdateRegion`
- Validator
- See `GetValidator` and `SetValidator`
- VirtualSize
- See `GetVirtualSize` and `SetVirtualSize`
- WindowStyle
- See `GetWindowStyle` and `SetWindowStyle`
- WindowStyleFlag
- See `GetWindowStyleFlag` and `SetWindowStyleFlag`
- WindowVariant
- See `GetWindowVariant` and `SetWindowVariant`
Methods inherited from EvtHandler:
- AddPendingEvent(*args, **kwargs)
- AddPendingEvent(self, Event event)
- Bind(self, event, handler, source=None, id=-1, id2=-1)
- Bind an event to an event handler.
:param event: One of the EVT_* objects that specifies the
type of event to bind,
:param handler: A callable object to be invoked when the
event is delivered to self. Pass None to
disconnect an event handler.
:param source: Sometimes the event originates from a
different window than self, but you still
want to catch it in self. (For example, a
button event delivered to a frame.) By
passing the source of the event, the event
handling system is able to differentiate
between the same event type from different
controls.
:param id: Used to spcify the event source by ID instead
of instance.
:param id2: Used when it is desirable to bind a handler
to a range of IDs, such as with EVT_MENU_RANGE.
- Connect(*args, **kwargs)
- Connect(self, int id, int lastId, int eventType, PyObject func)
- Disconnect(*args, **kwargs)
- Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL,
PyObject func=None) -> bool
- GetEvtHandlerEnabled(*args, **kwargs)
- GetEvtHandlerEnabled(self) -> bool
- GetNextHandler(*args, **kwargs)
- GetNextHandler(self) -> EvtHandler
- GetPreviousHandler(*args, **kwargs)
- GetPreviousHandler(self) -> EvtHandler
- ProcessEvent(*args, **kwargs)
- ProcessEvent(self, Event event) -> bool
- ProcessPendingEvents(*args, **kwargs)
- ProcessPendingEvents(self)
- SetEvtHandlerEnabled(*args, **kwargs)
- SetEvtHandlerEnabled(self, bool enabled)
- SetNextHandler(*args, **kwargs)
- SetNextHandler(self, EvtHandler handler)
- SetPreviousHandler(*args, **kwargs)
- SetPreviousHandler(self, EvtHandler handler)
- Unbind(self, event, source=None, id=-1, id2=-1, handler=None)
- Disconnects the event handler binding for event from self.
Returns True if successful.
Data descriptors inherited from EvtHandler:
- EvtHandlerEnabled
- See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`
- NextHandler
- See `GetNextHandler` and `SetNextHandler`
- PreviousHandler
- See `GetPreviousHandler` and `SetPreviousHandler`
Methods inherited from Object:
- GetClassName(*args, **kwargs)
- GetClassName(self) -> String
Returns the class name of the C++ class using wxRTTI.
- IsSameAs(*args, **kwargs)
- IsSameAs(self, Object p) -> bool
For wx.Objects that use C++ reference counting internally, this method
can be used to determine if two objects are referencing the same data
object.
Data descriptors inherited from Object:
- ClassName
- See `GetClassName`
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |