Additional WxPython widgets

The classes in this module are based on internal classes that where originally designed to help the creation of graphical tools for the control and the visualization of audio signals. WxPython must be installed under the current Python distribution to access these classes.

PyoGuiControlSlider

class PyoGuiControlSlider(parent, minvalue, maxvalue, init=None, pos=(0, 0), size=(200, 16), log=False, integer=False, powoftwo=False, orient=4)[source]

Floating-point control slider.

Parent

wx.Panel

Events
EVT_PYO_GUI_CONTROL_SLIDER

Sent after any change of the slider position. The current value of the slider can be retrieve with the value attribute of the generated event. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

Args
parent: wx.Window

The parent window.

minvalue: float

The minimum value of the slider.

maxvalue: float

The maximum value of the slider.

init: float, optional

The initial value of the slider. If None, the slider inits to the minimum value. Defaults to None.

pos: tuple, optional

The slider’s position in pixel (x, y). Defaults to (0, 0).

size: tuple, optional

The slider’s size in pixel (x, y). Defaults to (200, 16).

log: boolean, optional

If True, creates a logarithmic slider (minvalue must be greater than 0). Defaults to False.

integer: boolean, optional

If True, creates an integer slider. Defaults to False.

powoftwo: boolean, optional

If True, creates a power-of-two slider (log is automatically False and integer is True). If True, minvalue and maxvalue must be exponents to base 2 but init is a real power-of-two value. Defaults to False.

orient: {wx.HORIZONTAL or wx.VERTICAL}, optional

The slider’s orientation. Defaults to wx.HORIZONTAL.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent, minvalue, maxvalue[, init, ...])

enable()

Enable the slider for user input.

disable()

Disable the slider for user input.

setValue(x[, propagate])

Sets a new value to the slider.

setMidiCtl(x[, propagate])

Sets the midi controller number to show on the slider.

setRange(minvalue, maxvalue)

Sets new minimum and maximum values.

getValue()

Returns the current value of the slider.

getMidiCtl()

Returns the midi controller number, if any, assigned to the slider.

getMinValue()

Returns the current minimum value.

getMaxValue()

Returns the current maximum value.

getInit()

Returns the initial value.

getRange()

Returns minimum and maximum values as a list.

isInteger()

Returns True if the slider manage only integer, False otherwise.

isLog()

Returns True if the slider is logarithmic, False otherwise.

isPowOfTwo()

Returns True if the slider manage only power-of-two values, False otherwise.

Inherited from ControlSlider

__init__(parent, minvalue, maxvalue[, init, ...])

getCtrlLabel()

setMidiCtl(x[, propagate])

Sets the midi controller number to show on the slider.

getMidiCtl()

Returns the midi controller number, if any, assigned to the slider.

getMinValue()

Returns the current minimum value.

getMaxValue()

Returns the current maximum value.

Enable([enable])

Enable or disable the window for user input.

Disable()

Disables the window.

setSliderHeight(height)

setSliderWidth(width)

getInit()

Returns the initial value.

SetRange(minvalue, maxvalue)

getRange()

Returns minimum and maximum values as a list.

scale()

SetValue(value[, propagate])

GetValue()

LooseFocus(event)

onChar(event)

MouseDown(evt)

MouseUp(evt)

DoubleClick(event)

MouseMotion(evt)

OnResize(evt)

clampPos()

setBackgroundColour(colour)

OnPaint(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent, minvalue, maxvalue[, init, ...])

Private Methods:

_outFunction(value)


enable()[source]

Enable the slider for user input.

disable()[source]

Disable the slider for user input.

setValue(x, propagate=True)[source]

Sets a new value to the slider.

Args
x: int or float

The controller number.

propagate: boolean, optional

If True, an event will be sent after the call.

setMidiCtl(x, propagate=True)[source]

Sets the midi controller number to show on the slider.

Args
x: int

The controller number.

propagate: boolean, optional

If True, an event will be sent after the call.

setRange(minvalue, maxvalue)[source]

Sets new minimum and maximum values.

Args
minvalue: int or float

The new minimum value.

maxvalue: int or float

The new maximum value.

getValue()[source]

Returns the current value of the slider.

getMidiCtl()[source]

Returns the midi controller number, if any, assigned to the slider.

getMinValue()[source]

Returns the current minimum value.

getMaxValue()[source]

Returns the current maximum value.

getInit()[source]

Returns the initial value.

getRange()[source]

Returns minimum and maximum values as a list.

isInteger()[source]

Returns True if the slider manage only integer, False otherwise.

isLog()[source]

Returns True if the slider is logarithmic, False otherwise.

isPowOfTwo()[source]

Returns True if the slider manage only power-of-two values, False otherwise.

PyoGuiVuMeter

class PyoGuiVuMeter(parent, nchnls=2, pos=(0, 0), size=(200, 11), orient=4, style=0)[source]

Multi-channels Vu Meter.

When registered as the Server’s meter, its internal method setRms will be called each buffer size with a list of normalized amplitudes as argument. The setRms method can also be registered as the function callback of a PeakAmp object.

Parent

wx.Panel

Args
parent: wx.Window

The parent window.

nchnls: int, optional

The initial number of channels of the meter. Defaults to 2.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: tuple, optional

The meter’s size in pixels (x, y). Defaults to (200, 11).

orient: {wx.HORIZONTAL or wx.VERTICAL}, optional

The meter’s orientation. Defaults to wx.HORIZONTAL.

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, nchnls, pos, size, ...])

setNchnls(nchnls)

Sets the number of channels of the meter.

Inherited from VuMeter

__init__(parent[, nchnls, pos, size, ...])

OnSize(evt)

createBitmaps()

setNumSliders(numSliders)

setRms(*args)

OnPaint(event)

OnClose(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, nchnls, pos, size, ...])


setNchnls(nchnls)[source]

Sets the number of channels of the meter.

Args
nchnls: int

The number of channels.

PyoGuiGrapher

class PyoGuiGrapher(parent, xlen=8192, yrange=(0, 1), init=[(0.0, 0.0), (1.0, 1.0)], mode=0, exp=10, inverse=True, tension=0, bias=0, pos=(0, 0), size=(300, 200), style=0)[source]

Multi-modes break-points function editor.

Parent

wx.Panel

Events
EVT_PYO_GUI_GRAPHER

Sent after any change of the grapher function. The current list of points of the grapher can be retrieve with the value attribute of the generated event. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

Args
parent: wx.Window

The parent window.

xlen: int, optional

The length, in samples, of the grapher. Defaults to 8192.

yrange: two-values tuple, optional

A tuple indicating the minimum and maximum values of the Y-axis. Defaults to (0, 1).

init: list of two-values tuples, optional

The initial break-points function set as normalized values. A point is defined with its X and Y positions as a tuple. Defaults to [(0.0, 0.0), (1.0, 1.0)].

mode: int, optional

The grapher mode definning how line segments will be draw. Possible modes are:

  1. linear (default)

  2. cosine

  3. exponential (uses exp and inverse arguments)

  4. curve (uses tension and bias arguments)

  5. logarithmic

  6. logarithmic cosine

exp: int or float, optional

The exponent factor for an exponential graph. Defaults to 10.0.

inverse: boolean, optional

If True, downward slope will be inversed. Useful to create biexponential curves. Defaults to True.

tension: int or float, optional

Curvature at the known points. 1 is high, 0 normal, -1 is low. Defaults to 0.

bias: int or float, optional

Curve attraction (for each segments) toward bundary points. 0 is even, positive is towards first point, negative is towards the second point. Defaults to 0.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, xlen, yrange, init, mode, ...])

reset()

Resets the points to the initial state.

getPoints()

Returns the current normalized points of the grapher.

getValues()

Returns the current points, according to Y-axis range, of the grapher.

setPoints(pts)

Sets a new group of normalized points in the grapher.

setValues(vals)

Sets a new group of points, according to Y-axis range, in the grapher.

setYrange(yrange)

Sets a new Y-axis range to the grapher.

setInitPoints(pts)

Sets a new initial normalized points list to the grapher.

setMode(x)

Changes the grapher's mode.

setExp(x)

Changes the grapher's exponent factor for exponential graph.

setInverse(x)

Changes the grapher's inverse boolean for exponential graph.

setTension(x)

Changes the grapher's tension factor for curved graph.

setBias(x)

Changes the grapher's bias factor for curved graph.

Inherited from Grapher

__init__(parent[, xlen, yrange, init, mode, ...])

setInitPoints(pts)

Sets a new initial normalized points list to the grapher.

pointToPixels(pt)

pixelsToPoint(pos)

pointToValues(pt)

valuesToPoint(val)

borderClip(pos)

pointClip(pos)

reset()

Resets the points to the initial state.

getPoints()

Returns the current normalized points of the grapher.

getValues()

Returns the current points, according to Y-axis range, of the grapher.

sendValues()

OnResize(evt)

OnLeave(evt)

OnKeyDown(evt)

MouseDown(evt)

MouseUp(evt)

MouseMotion(evt)

getLogPoints(pt1, pt2)

getCosLogPoints(pt1, pt2)

getCosPoints(pt1, pt2)

getExpPoints(pt1, pt2)

addImaginaryPoints(tmp)

getCurvePoints(pt0, pt1, pt2, pt3)

OnPaint(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, xlen, yrange, init, mode, ...])

Private Methods:

_outFunction(value)

_refresh()


reset()[source]

Resets the points to the initial state.

getPoints()[source]

Returns the current normalized points of the grapher.

getValues()[source]

Returns the current points, according to Y-axis range, of the grapher.

setPoints(pts)[source]

Sets a new group of normalized points in the grapher.

Args
pts: list of two-values tuples

New normalized (between 0 and 1) points.

setValues(vals)[source]

Sets a new group of points, according to Y-axis range, in the grapher.

Args
vals: list of two-values tuples

New real points.

setYrange(yrange)[source]

Sets a new Y-axis range to the grapher.

Args
yrange: two-values tuple

New Y-axis range.

setInitPoints(pts)[source]

Sets a new initial normalized points list to the grapher.

Args
pts: list of two-values tuples

New normalized (between 0 and 1) initial points.

setMode(x)[source]

Changes the grapher’s mode.

Args
x: int
New mode. Possible modes are:
  1. linear (default)

  2. cosine

  3. exponential (uses exp and inverse arguments)

  4. curve (uses tension and bias arguments)

  5. logarithmic

  6. logarithmic cosine

setExp(x)[source]

Changes the grapher’s exponent factor for exponential graph.

Args
x: float

New exponent factor.

setInverse(x)[source]

Changes the grapher’s inverse boolean for exponential graph.

Args
x: boolean

New inverse factor.

setTension(x)[source]

Changes the grapher’s tension factor for curved graph.

Args
x: float

New tension factor.

setBias(x)[source]

Changes the grapher’s bias factor for curved graph.

Args
x: float

New bias factor.

PyoGuiMultiSlider

class PyoGuiMultiSlider(parent, xlen=16, yrange=(0, 1), init=None, pos=(0, 0), size=(300, 200), style=0)[source]

Data multi-sliders editor.

Parent

wx.Panel

Events
EVT_PYO_GUI_MULTI_SLIDER

Sent after any change of the multi-sliders values. The current list of values of the multi-sliders can be retrieve with the value attribute of the generated event. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

Args
parent: wx.Window

The parent window.

xlen: int, optional

The number of sliders in the multi-sliders. Defaults to 16.

yrange: two-values tuple

A tuple indicating the minimum and maximum values of the Y-axis. Defaults to (0, 1).

init: list values, optional

The initial list of values of the multi-sliders. Defaults to None, meaning all sliders initialized to the minimum value.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, xlen, yrange, init, pos, ...])

reset()

Resets the sliders to their initial state.

getValues()

Returns the current values of the sliders.

setValues(vals)

Sets new values to the sliders.

setYrange(yrange)

Sets a new Y-axis range to the multi-sliders.

Inherited from DataMultiSlider

__init__(parent[, xlen, yrange, init, pos, ...])

OnResize(event)

update(points)

getValues()

Returns the current values of the sliders.

OnPaint(event)

MouseDown(evt)

MouseUp(evt)

MouseMotion(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, xlen, yrange, init, pos, ...])

Private Methods:

_outFunction(value)


reset()[source]

Resets the sliders to their initial state.

getValues()[source]

Returns the current values of the sliders.

setValues(vals)[source]

Sets new values to the sliders.

Args
vals: list of values

New values.

setYrange(yrange)[source]

Sets a new Y-axis range to the multi-sliders.

Args
yrange: two-values tuple

New Y-axis range.

PyoGuiSpectrum

class PyoGuiSpectrum(parent, lowfreq=0, highfreq=22050, fscaling=0, mscaling=0, pos=(0, 0), size=(300, 200), style=0)[source]

Frequency spectrum display.

This widget should be used with the Spectrum object, which measures the magnitude of an input signal versus frequency within a user defined range. It can show both magnitude and frequency on linear or logarithmic scale.

To create the bridge between the analyzer and the display, the Spectrum object must be registered in the PyoGuiSpectrum object with the setAnalyzer(obj) method. The Spectrum object will automatically call the update(points) method to refresh the display.

Parent

wx.Panel

Args
parent: wx.Window

The parent window.

lowfreq: int or float, optional

The lowest frequency, in Hz, to display on the X-axis. Defaults to 0.

highfreq: int or float, optional

The highest frequency, in Hz, to display on the X-axis. Defaults to 22050.

fscaling: int, optional

The frequency scaling on the X-axis. 0 means linear, 1 means logarithmic. Defaults to 0.

mscaling: int, optional

The magnitude scaling on the Y-axis. 0 means linear, 1 means logarithmic. Defaults to 0.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, lowfreq, highfreq, ...])

update(points)

Display updating method.

setAnalyzer(object)

Register an audio analyzer object (Spectrum).

setLowFreq(x)

Changes the lowest frequency of the display.

setHighFreq(x)

Changes the highest frequency of the display.

setFscaling(x)

Changes the frequency scaling (X-axis) of the display.

setMscaling(x)

Changes the magnitude scaling (Y-axis) of the display.

Inherited from SpectrumPanel

__init__(parent[, lowfreq, highfreq, ...])

OnSize(evt)

setImage(points)

setPens()

setChnls(x)

setFscaling(x)

Changes the frequency scaling (X-axis) of the display.

setMscaling(x)

Changes the magnitude scaling (Y-axis) of the display.

setLowFreq(x)

Changes the lowest frequency of the display.

setHighFreq(x)

Changes the highest frequency of the display.

showChannelNames(visible)

setChannelNames(names)

OnPaint(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, lowfreq, highfreq, ...])


update(points)[source]

Display updating method.

This method is automatically called by the audio analyzer object (Spectrum) with points to draw as arguments. The points are already formatted for the current drawing surface to save CPU cycles.

The method setAnalyzer(obj) must be used to register the audio analyzer object.

Args
points: list of list of tuples

A list containing n-channels list of tuples. A tuple is a point (X-Y coordinates) to draw.

setAnalyzer(object)[source]

Register an audio analyzer object (Spectrum).

Args
object: Spectrum object

The audio object performing the frequency analysis.

setLowFreq(x)[source]

Changes the lowest frequency of the display.

This method propagates the value to the audio analyzer.

Args
x: int or float

New lowest frequency.

setHighFreq(x)[source]

Changes the highest frequency of the display.

This method propagates the value to the audio analyzer.

Args
x: int or float

New highest frequency.

setFscaling(x)[source]

Changes the frequency scaling (X-axis) of the display.

This method propagates the value to the audio analyzer.

Args
x: int

0 means linear scaling, 1 means logarithmic scaling.

setMscaling(x)[source]

Changes the magnitude scaling (Y-axis) of the display.

This method propagates the value to the audio analyzer.

Args
x: int

0 means linear scaling, 1 means logarithmic scaling.

PyoGuiScope

class PyoGuiScope(parent, length=0.05, gain=0.67, pos=(0, 0), size=(300, 200), style=0)[source]

Oscilloscope display.

This widget should be used with the Scope object, which computes the waveform of an input signal to display on a GUI.

To create the bridge between the analyzer and the display, the Scope object must be registered in the PyoGuiScope object with the setAnalyzer(obj) method. The Scope object will automatically call the update(points) method to refresh the display.

Parent

wx.Panel

Args
parent: wx.Window

The parent window.

length: float, optional

Length, in seconds, of the waveform segment displayed on the window. Defaults to 0.05.

gain: float, optional

Linear gain applied to the signal to be displayed. Defaults to 0.67.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, length, gain, pos, size, ...])

update(points)

Display updating method.

setAnalyzer(object)

Register an audio analyzer object (Scope).

setLength(x)

Changes the length, in seconds, of the displayed audio segment.

setGain(x)

Changes the gain applied to the input signal.

Inherited from ScopePanel

__init__(parent[, length, gain, pos, size, ...])

OnSize(evt)

setChnls(x)

setPens()

setGain(x)

Changes the gain applied to the input signal.

setLength(x)

Changes the length, in seconds, of the displayed audio segment.

setImage(points)

showChannelNames([visible])

setChannelNames(names)

OnPaint(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, length, gain, pos, size, ...])


update(points)[source]

Display updating method.

This method is automatically called by the audio analyzer object (Scope) with points to draw as arguments. The points are already formatted for the current drawing surface to save CPU cycles.

The method setAnalyzer(obj) must be used to register the audio analyzer object.

Args
points: list of list of tuples

A list containing n-channels list of tuples. A tuple is a point (X-Y coordinates) to draw.

setAnalyzer(object)[source]

Register an audio analyzer object (Scope).

Args
object: Scope object

The audio object performing the waveform analysis.

setLength(x)[source]

Changes the length, in seconds, of the displayed audio segment.

This method propagates the value to the audio analyzer.

Args
x: float

New segment length in seconds.

setGain(x)[source]

Changes the gain applied to the input signal.

This method propagates the value to the audio analyzer.

Args
x: float

New linear gain.

PyoGuiSndView

class PyoGuiSndView(parent, pos=(0, 0), size=(300, 200), style=0)[source]

Soundfile display.

This widget should be used with the SndTable object, which keeps soundfile in memory and computes the waveform to display on the GUI.

To create the bridge between the audio memory and the display, the SndTable object must be registered in the PyoGuiSndView object with the setTable(object) method.

The SndTable object will automatically call the update() method to refresh the display when the table is modified.

Parent

wx.Panel

Events
EVT_PYO_GUI_SNDVIEW_MOUSE_POSITION

Sent when the mouse is moving on the panel with the left button pressed. The value attribute of the event will hold the normalized position of the mouse into the sound. For X-axis value, 0.0 is the beginning of the sound and 1.0 is the end of the sound. For the Y-axis, 0.0 is the bottom of the panel and 1.0 is the top. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

EVT_PYO_GUI_SNDVIEW_SELECTION

Sent when a new region is selected on the panel. A new selection is created with a Right-click and drag on the panel. The current selection can be moved with Shift+Right-click and drag. Ctrl+Right-click (Cmd on OSX) remove the selected region. The value attribute of the event will hold the normalized selection as a tuple (min, max). 0.0 means the beginning of the sound and 1.0 means the end of the sound. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

Args
parent: wx.Window

The parent window.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, pos, size, style])

__del__()

update()

Display updating method.

setTable(object)

Register an audio memory object (SndTable).

setSelection(start, stop)

Changes the selected region.

resetSelection()

Removes the selected region.

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, pos, size, style])

Private Methods:

_setZoom([values])

_position_callback(pos)

_select_callback(selection)


update()[source]

Display updating method.

This method is automatically called by the audio memory object (SndTable) when the table is modified.

The method setTable(obj) must be used to register the audio memory object.

setTable(object)[source]

Register an audio memory object (SndTable).

Args
object: SndTable object

The audio table keeping the sound in memory.

setSelection(start, stop)[source]

Changes the selected region.

This method will trigger a EVT_PYO_GUI_SNDVIEW_SELECTION event with a tuple (start, stop) as value.

Args
start: float

The starting point of the selected region. This value must be normalized between 0 and 1 (0 is the beginning of the sound, 1 is the end).

stop: float

The ending point of the selected region. This value must be normalized between 0 and 1 (0 is the beginning of the sound, 1 is the end).

resetSelection()[source]

Removes the selected region.

This method will trigger a EVT_PYO_GUI_SNDVIEW_SELECTION event with a tuple (0.0, 1.0) as value.

PyoGuiKeyboard

class PyoGuiKeyboard(parent, poly=64, pos=(0, 0), size=(600, 100), style=0)[source]

Virtual MIDI keyboard.

Parent

wx.Panel

Events
EVT_PYO_GUI_KEYBOARD

Sent whenever a note change on the keyboard. The value attribute of the event will hold a (pitch, velocity) tuple. The object itself can be retrieve with the object attribute of the event and the object’s id with the id attrbute.

Args
parent: wx.Window

The parent window.

poly: int, optional

Maximum number of notes that can be held at the same time. Defaults to 64.

pos: wx.Point, optional

Window position in pixels. Defaults to (0, 0).

size: wx.Size, optional

Window size in pixels. Defaults to (300, 200).

style: int, optional

Window style (see wx.Window documentation). Defaults to 0.

Public Data Attributes:

Inherited from Window

MaxClientSize

GetMaxClientSize() -> Size

MinClientSize

GetMinClientSize() -> Size

TopLevel

IsTopLevel() -> bool

Enabled

IsEnabled() -> bool

Shown

IsShown() -> bool

WindowVariant

GetWindowVariant() -> WindowVariant

WindowStyleFlag

GetWindowStyleFlag() -> long

WindowStyle

GetWindowStyle() -> long

VirtualSize

GetVirtualSize() -> Size

Validator

GetValidator() -> Validator

UpdateRegion

GetUpdateRegion() -> Region

UpdateClientRect

GetUpdateClientRect() -> Rect

ToolTip

GetToolTip() -> ToolTip

ThemeEnabled

GetThemeEnabled() -> bool

Sizer

GetSizer() -> Sizer

Size

GetSize() -> Size

ScreenRect

GetScreenRect() -> Rect

ScreenPosition

GetScreenPosition() -> Point

Position

GetPosition() -> Point

Parent

GetParent() -> Window

Name

GetName() -> String

MinWidth

GetMinWidth() -> int

MinSize

GetMinSize() -> Size

MinHeight

GetMinHeight() -> int

MaxWidth

GetMaxWidth() -> int

MaxSize

GetMaxSize() -> Size

MaxHeight

GetMaxHeight() -> int

LayoutDirection

GetLayoutDirection() -> LayoutDirection

Label

GetLabel() -> String

Id

GetId() -> WindowID

HelpText

GetHelpText() -> String

Handle

GetHandle() -> UIntPtr

TopLevelParent

GetTopLevelParent() -> Window

GrandParent

GetGrandParent() -> Window

ForegroundColour

GetForegroundColour() -> Colour

Font

GetFont() -> Font

ExtraStyle

GetExtraStyle() -> long

EventHandler

GetEventHandler() -> EvtHandler

DropTarget

GetDropTarget() -> DropTarget

DefaultAttributes

GetDefaultAttributes() -> VisualAttributes

Cursor

GetCursor() -> Cursor

ContainingSizer

GetContainingSizer() -> Sizer

Constraints

GetConstraints() -> LayoutConstraints

ClientSize

GetClientSize() -> Size

ClientAreaOrigin

GetClientAreaOrigin() -> Point

Children

GetChildren() -> WindowList

CharWidth

GetCharWidth() -> int

CharHeight

GetCharHeight() -> int

Caret

GetCaret() -> Caret

Border

GetBorder(flags) -> Border GetBorder() -> Border

BestVirtualSize

GetBestVirtualSize() -> Size

BestSize

GetBestSize() -> Size

EffectiveMinSize

GetEffectiveMinSize() -> Size

BackgroundStyle

GetBackgroundStyle() -> BackgroundStyle

BackgroundColour

GetBackgroundColour() -> Colour

AutoLayout

GetAutoLayout() -> bool

AcceleratorTable

GetAcceleratorTable() -> AcceleratorTable

Rect

GetRect() -> Rect

ClientRect

GetClientRect() -> Rect

Inherited from EvtHandler

PreviousHandler

GetPreviousHandler() -> EvtHandler

NextHandler

GetNextHandler() -> EvtHandler

EvtHandlerEnabled

GetEvtHandlerEnabled() -> bool

Inherited from Object

RefData

GetRefData() -> ObjectRefData

ClassName

GetClassName() -> Char

ClassInfo

GetClassInfo() -> ClassInfo

Public Methods:

__init__(parent[, poly, pos, size, style])

getCurrentNotes()

Returns a list of the current notes.

reset()

Resets the keyboard state.

setPoly(poly)

Sets the maximum number of notes that can be held at the same time.

Inherited from Keyboard

__init__(parent[, poly, pos, size, style])

getCurrentNotes()

Returns a list of the current notes.

reset()

Resets the keyboard state.

setPoly(poly)

Sets the maximum number of notes that can be held at the same time.

OnSize(evt)

OnKeyDown(evt)

OnKeyUp(evt)

MouseUp(evt)

MouseDown(evt)

OnPaint(evt)

Inherited from Panel

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

EnableVisibleFocus(self, enabled)

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetMainWindowOfCompositeControl(self)

GetValidator(self)

HasTransparentBackground(self)

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

OnInternalIdle(self)

ProcessEvent(self, event)

RemoveChild(self, child)

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SetCanFocus(self, canFocus)

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusIgnoringChildren()

In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel.

SetValidator(self, validator)

ShouldInheritColours(self)

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

Validate(self)

Inherited from Window

AcceptsFocus()

This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus.

AcceptsFocusFromKeyboard(self)

AcceptsFocusRecursively(self)

AddChild(self, child)

AdjustForLayoutDirection(x, width, widthTotal)

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

AlwaysShowScrollbars([hflag, vflag])

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

AssociateHandle(handle)

Associate the window with a new native handle

BeginRepositioningChildren()

Prepare for changing positions of multiple child windows.

CacheBestSize(size)

Sets the cached best size value.

CanAcceptFocus()

Can this window have focus right now?

CanAcceptFocusFromKeyboard()

Can this window be assigned focus from keyboard right now?

CanScroll(orient)

Returns true if this window can have a scroll bar in this orientation.

CanSetTransparent()

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

CaptureMouse()

Directs all mouse input to this window.

Center([dir])

A synonym for Centre().

CenterOnParent([dir])

A synonym for CentreOnParent().

Centre([direction])

Centres the window.

CentreOnParent([direction])

Centres the window on its parent.

ClearBackground()

Clears the window by filling it with the current background colour.

ClientToScreen(->)

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize(size)

Converts client area size size to corresponding window size.

Close([force])

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

ConvertDialogToPixels(-> Point)

Converts a point or size from dialog units to pixels.

ConvertPixelsToDialog(-> Point)

Converts a point or size from pixels to dialog units.

Create(parent[, id, pos, size, style, name])

Used for two-step panel construction.

Destroy(self)

DestroyChildren()

Destroys all children of a window.

Disable()

Disables the window.

DisableFocusFromKeyboard()

Disable giving focus to this window using the keyboard navigation keys.

DissociateHandle()

Dissociate the current native handle from the window

DoEnable(self, enable)

DoFreeze(self)

DoGetBestClientSize(self)

DoGetBestSize(self)

DoGetBorderSize(self)

DoGetClientSize(self)

DoGetPosition(self)

DoGetSize(self)

DoMoveWindow(self, x, y, width, height)

DoSetClientSize(self, width, height)

DoSetSize(self, x, y, width, height, sizeFlags)

DoSetSizeHints(self, minW, minH, maxW, maxH, ...)

DoSetWindowVariant(self, variant)

DoThaw(self)

DoUpdateWindowUI(event)

Does the window-specific updating after processing the update event.

DragAcceptFiles(accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Enable([enable])

Enable or disable the window for user input.

EnableTouchEvents(eventsMask)

Request generation of touch events for this window.

EnableVisibleFocus(self, enabled)

EndRepositioningChildren()

Fix child window positions after setting all of them at once.

FindFocus()

Finds the window or control which currently has the keyboard focus.

FindWindow(-> Window)

Find a child of this window, by id.

FindWindowById(id[, parent])

Find the first window with the given id.

FindWindowByLabel(label[, parent])

Find a window by its label.

FindWindowByName(name[, parent])

Find a window by its name (as given in a window constructor or Create() function call).

Fit()

Sizes the window to fit its best size.

FitInside()

Similar to Fit(), but sizes the interior (virtual) size of a window.

Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

FromDIP(...)

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

GetAcceleratorTable()

Gets the accelerator table for this window.

GetAccessible()

Returns the accessible object for this window, if any.

GetAutoLayout()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetBackgroundColour()

Returns the background colour of the window.

GetBackgroundStyle()

Returns the background style of the window.

GetBestHeight(width)

Returns the best height needed by this window if it had the given width.

GetBestSize()

This functions returns the best acceptable minimal size for the window.

GetBestVirtualSize()

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBestWidth(height)

Returns the best width needed by this window if it had the given height.

GetBorder(-> Border)

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

GetCapture()

Returns the currently captured window.

GetCaret()

Returns the caret() associated with the window.

GetCharHeight()

Returns the character height for this window.

GetCharWidth()

Returns the average character width for this window.

GetChildren()

Returns a reference to the list of the window's children.

GetClassDefaultAttributes([variant])

GetClientAreaOrigin(self)

GetClientRect()

Get the client rectangle in window (i.e.

GetClientSize()

Returns the size of the window 'client area' in pixels.

GetConstraints()

Returns a pointer to the window's layout constraints, or NULL if there are none.

GetContainingSizer()

Returns the sizer of which this window is a member, if any, otherwise NULL.

GetContentScaleFactor()

Returns the factor mapping logical pixels of this window to physical pixels.

GetCursor()

Return the cursor associated with this window.

GetDPI()

Return the DPI of the display used by this window.

GetDPIScaleFactor()

Returns the ratio of the DPI used by this window to the standard DPI.

GetDefaultAttributes()

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

GetDefaultBorder(self)

GetDefaultBorderForControl(self)

GetDropTarget()

Returns the associated drop target, which may be NULL.

GetEffectiveMinSize()

Merges the window's best size into the min size and returns the result.

GetEventHandler()

Returns the event handler for this window.

GetExtraStyle()

Returns the extra style bits for the window.

GetFont()

Returns the font for this window.

GetForegroundColour()

Returns the foreground colour of the window.

GetFullTextExtent(string[, font])

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetGrandParent()

Returns the grandparent of a window, or NULL if there isn't one.

GetGtkWidget()

GetHandle()

Returns the platform-specific handle of the physical window.

GetHelpText()

Gets the help text to be used as context-sensitive help for this window.

GetHelpTextAtPoint(point, origin)

Gets the help text to be used as context-sensitive help for this window.

GetId()

Returns the identifier of the window.

GetLabel()

Generic way of getting a label from any window, for identification purposes.

GetLayoutDirection()

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

GetMainWindowOfCompositeControl(self)

GetMaxClientSize()

Returns the maximum size of window's client area.

GetMaxHeight()

Returns the vertical component of window maximal size.

GetMaxSize()

Returns the maximum size of the window.

GetMaxWidth()

Returns the horizontal component of window maximal size.

GetMinClientSize()

Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

GetMinHeight()

Returns the vertical component of window minimal size.

GetMinSize()

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

GetMinWidth()

Returns the horizontal component of window minimal size.

GetName()

Returns the window's name.

GetNextSibling()

Returns the next window after this one among the parent's children or NULL if this window is the last child.

GetParent()

Returns the parent of the window, or NULL if there is no parent.

GetPopupMenuSelectionFromUser(-> int)

This function shows a popup menu at the given position in this window and returns the selected id.

GetPosition()

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

GetPrevSibling()

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

GetRect()

Returns the position and size of the window as a wxRect object.

GetScreenPosition()

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

GetScreenRect()

Returns the position and size of the window on the screen as a wxRect object.

GetScrollPos(orientation)

Returns the built-in scrollbar position.

GetScrollRange(orientation)

Returns the built-in scrollbar range.

GetScrollThumb(orientation)

Returns the built-in scrollbar thumb size.

GetSize()

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

GetSizer()

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

GetTextExtent(string)

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

GetThemeEnabled()

Returns true if the window uses the system theme for drawing its background.

GetToolTip()

Get the associated tooltip or NULL if none.

GetToolTipText()

Get the text of the associated tooltip or empty string if none.

GetTopLevelParent()

Returns the first ancestor of this window which is a top-level window.

GetUpdateClientRect()

Get the update rectangle bounding box in client coords.

GetUpdateRegion()

Returns the region specifying which parts of the window have been damaged.

GetValidator(self)

GetVirtualSize()

This gets the virtual size of the window in pixels.

GetWindowBorderSize()

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

GetWindowStyle()

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag()

Gets the window style that was passed to the constructor or Create() method.

GetWindowVariant()

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey(event)

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

HandleWindowEvent(event)

Shorthand for:

HasCapture()

Returns true if this window has the current mouse capture.

HasExtraStyle(exFlag)

Returns true if the window has the given exFlag bit set in its extra styles.

HasFlag(flag)

Returns true if the window has the given flag bit set.

HasFocus()

Returns true if the window (or in case of composite controls, its main child window) has focus.

HasMultiplePages()

This method should be overridden to return true if this window has multiple pages.

HasScrollbar(orient)

Returns true if this window currently has a scroll bar for this orientation.

HasTransparentBackground(self)

Hide()

Equivalent to calling wxWindow::Show(false).

HideWithEffect(effect[, timeout])

This function hides a window, like Hide(), but using a special visual effect if possible.

HitTest(-> HitTest)

Return where the given point lies, exactly.

InformFirstDirection(self, direction, size, ...)

InheritAttributes(self)

InheritsBackgroundColour()

Return true if this window inherits the background colour from its parent.

InheritsForegroundColour()

Return true if this window inherits the foreground colour from its parent.

InitDialog()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

InvalidateBestSize()

Resets the cached best size value so it will be recalculated the next time it is needed.

IsBeingDeleted()

Returns true if this window is in process of being destroyed.

IsDescendant(win)

Check if the specified window is a descendant of this one.

IsDoubleBuffered()

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()

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed(-> bool  -> bool  -> bool)

Returns true if the given point or rectangle area has been exposed since the last repaint.

IsFocusable()

Can this window itself have focus?

IsFrozen()

Returns true if the window is currently frozen by a call to Freeze().

IsRetained()

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown(orient)

Return whether a scrollbar is always shown.

IsShown()

Returns true if the window is shown, false if it has been hidden.

IsShownOnScreen()

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.

IsThisEnabled()

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel()

Returns true if the given window is a top-level one.

IsTransparentBackgroundSupported([reason])

Checks whether using transparent background might work.

Layout()

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

LineDown()

Same as ScrollLines (1).

LineUp()

Same as ScrollLines (-1).

Lower()

Lowers the window to the bottom of the window hierarchy (Z-order).

MacIsWindowScrollbar(sb)

Is the given widget one of this window's built-in scrollbars? Only applicable on Mac.

Move()

Moves the window to the given position.

MoveAfterInTabOrder(win)

Moves this window in the tab navigation order after the specified win.

MoveBeforeInTabOrder(win)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

Navigate([flags])

Performs a keyboard navigation action starting from this window.

NavigateIn([flags])

Performs a keyboard navigation action inside this window.

NewControlId([count])

Create a new ID or range of IDs that are not currently in use.

OnInternalIdle(self)

PageDown()

Same as ScrollPages (1).

PageUp()

Same as ScrollPages (-1).

PopEventHandler([deleteHandler])

Removes and returns the top-most event handler on the event handler stack.

PopupMenu(-> bool)

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

PostSizeEvent()

Posts a size event to the window.

PostSizeEventToParent()

Posts a size event to the parent of this window.

ProcessEvent(self, event)

ProcessWindowEvent(event)

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally(event)

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler(handler)

Pushes this event handler onto the event stack for the window.

Raise()

Raises the window to the top of the window hierarchy (Z-order).

Refresh([eraseBackground, rect])

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

RefreshRect(rect[, eraseBackground])

Redraws the contents of the given rectangle: only the area inside it will be repainted.

RegisterHotKey(hotkeyId, modifiers, ...)

Registers a system wide hotkey.

ReleaseMouse()

Releases mouse input captured with CaptureMouse().

RemoveChild(self, child)

RemoveEventHandler(handler)

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

Reparent(newParent)

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

ScreenToClient(->)

Converts from screen to client window coordinates.

ScrollLines(lines)

Scrolls the window by the given number of lines down (if lines is positive) or up.

ScrollPages(pages)

Scrolls the window by the given number of pages down (if pages is positive) or up.

ScrollWindow(dx, dy[, rect])

Physically scrolls the pixels in the window and move child windows accordingly.

SendDestroyEvent()

Generate wxWindowDestroyEvent for this window.

SendIdleEvents(event)

Send idle event to window and all subwindows.

SendSizeEvent([flags])

This function sends a dummy size event to the window allowing it to re-layout its children positions.

SendSizeEventToParent([flags])

Safe wrapper for GetParent()->SendSizeEvent().

SetAcceleratorTable(accel)

Sets the accelerator table for this window.

SetAccessible(accessible)

Sets the accessible for this window.

SetAutoLayout(autoLayout)

Determines whether the Layout() function will be called automatically when the window is resized.

SetBackgroundColour(colour)

Sets the background colour of the window.

SetBackgroundStyle(style)

Sets the background style of the window.

SetCanFocus(self, canFocus)

SetCaret(caret)

Sets the caret() associated with the window.

SetClientSize(-> None)

This sets the size of the window client area in pixels.

SetConstraints(constraints)

Sets the window to have the given layout constraints.

SetContainingSizer(sizer)

Used by wxSizer internally to notify the window about being managed by the given sizer.

SetCursor(cursor)

Sets the window's cursor.

SetDimensions(x, y, width, height[, sizeFlags])

SetDoubleBuffered(on)

Turn on or off double buffering of the window if the system supports it.

SetDropTarget(target)

Associates a drop target with this window.

SetEventHandler(handler)

Sets the event handler for this window.

SetExtraStyle(exStyle)

Sets the extra style bits for the window.

SetFocus()

Overrides wxWindow::SetFocus().

SetFocusFromKbd()

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

SetFont(font)

Sets the font for this window.

SetForegroundColour(colour)

Sets the foreground colour of the window.

SetHelpText(helpText)

Sets the help text to be used as context-sensitive help for this window.

SetId(winid)

Sets the identifier of the window.

SetInitialSize([size])

A smart SetSize that will fill in default size components with the window's best size values.

SetLabel(label)

Sets the window's label.

SetLayoutDirection(dir)

Sets the layout direction for this window.

SetMaxClientSize(size)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

SetMaxSize(size)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

SetMinClientSize(size)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

SetMinSize(size)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

SetName(name)

Sets the window's name.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetOwnBackgroundColour(colour)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

SetOwnFont(font)

Sets the font of the window but prevents it from being inherited by the children of this window.

SetOwnForegroundColour(colour)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

SetPalette(pal)

SetPosition(pt)

Moves the window to the specified position.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetScrollPos(orientation, pos[, refresh])

Sets the position of one of the built-in scrollbars.

SetScrollbar(orientation, position, ...[, ...])

Sets the scrollbar properties of a built-in scrollbar.

SetSize(-> None  -> None)

Sets the size of the window in pixels.

SetSizeHints()

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

SetSizer(sizer[, deleteOld])

Sets the window to have the given layout sizer.

SetSizerAndFit(sizer[, deleteOld])

Associate the sizer with the window and set the window size and minimal size accordingly.

SetThemeEnabled(enable)

This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

SetToolTip()

Attach a tooltip to the window.

SetTransparent(alpha)

Set the transparency of the window.

SetValidator(self, validator)

SetVirtualSize()

Sets the virtual size of the window in pixels.

SetWindowStyle(style)

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag(style)

Sets the style of the window.

SetWindowVariant(variant)

Chooses a different variant of the window display to use.

ShouldInheritColours(self)

Show([show])

Shows or hides the window.

ShowWithEffect(effect[, timeout])

This function shows a window, like Show(), but using a special visual effect if possible.

Thaw()

Re-enables window updating after a previous call to Freeze().

ToDIP(...)

Convert pixel values of the current toolkit to DPI-independent pixel values.

ToggleWindowStyle(flag)

Turns the given flag on if it's currently turned off and vice versa.

TransferDataFromWindow(self)

TransferDataToWindow(self)

TryAfter(self, event)

TryBefore(self, event)

UnregisterHotKey(hotkeyId)

Unregisters a system wide hotkey.

UnreserveControlId(id[, count])

Unreserve an ID or range of IDs that was reserved by NewControlId().

UnsetToolTip()

Unset any existing tooltip.

Update()

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

UpdateWindowUI([flags])

This function sends one or more wxUpdateUIEvent to the window.

UseBackgroundColour()

Return true if a background colour has been set for this window.

UseBgCol()

Return true if a background colour has been set for this window.

UseForegroundColour()

Return true if a foreground colour has been set for this window.

Validate(self)

WarpPointer(x, y)

Moves the pointer to the given position on the window.

WindowToClientSize(size)

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

SetRect(rect)

SetClientRect(rect)

__nonzero__()

Can be used to test if the C++ part of the window still exists, with code like this.

__bool__()

Can be used to test if the C++ part of the window still exists, with code like this.

DestroyLater()

Schedules the window to be destroyed in the near future.

DLG_UNIT(dlg_unit)

A convenience wrapper for ConvertDialogToPixels().

PostCreate(**kw)

GetPositionTuple(**kw)

GetSizeTuple(**kw)

MoveXY(**kw)

SetSizeWH(**kw)

SetVirtualSizeWH(**kw)

GetVirtualSizeTuple(**kw)

SetToolTipString(**kw)

ConvertDialogPointToPixels(**kw)

ConvertDialogSizeToPixels(**kw)

SetSizeHintsSz(**kw)

Inherited from WindowBase

AddChild(self, child)

RemoveChild(self, child)

Inherited from EvtHandler

AddFilter(filter)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

AddPendingEvent(event)

Post an event to be processed later.

Connect(id, lastId, eventType, func)

Make an entry in the dynamic event table for an event binding.

DeletePendingEvents()

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

Disconnect(id[, lastId, eventType, func])

Remove an event binding by removing its entry in the dynamic event table.

GetEvtHandlerEnabled()

Returns true if the event handler is enabled, false otherwise.

GetNextHandler()

Returns the pointer to the next handler in the chain.

GetPreviousHandler()

Returns the pointer to the previous handler in the chain.

IsUnlinked()

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

ProcessEvent(self, event)

ProcessEventLocally(event)

Try to process the event in this handler and all those chained to it.

ProcessPendingEvents()

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

QueueEvent(event)

Queue event for a later processing.

RemoveFilter(filter)

Remove a filter previously installed with AddFilter().

SafelyProcessEvent(event)

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

SetEvtHandlerEnabled(enabled)

Enables or disables the event handler.

SetNextHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

SetPreviousHandler(handler)

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

TryAfter(self, event)

TryBefore(self, event)

Unlink()

Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

Bind(event, handler[, source, id, id2])

Bind an event to an event handler.

Unbind(event[, source, id, id2, handler])

Disconnects the event handler binding for event from self.

Inherited from Object

Destroy(self)

GetClassInfo()

This virtual function is redefined for every class that requires run- time type information, when using the wxDECLARE_CLASS macro (or similar).

GetClassName()

Returns the class name of the C++ class using wxRTTI.

GetRefData()

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

IsSameAs(obj)

Returns true if this object has the same data pointer as obj.

Ref(clone)

Makes this object refer to the data in clone.

SetRefData(data)

Sets the wxObject::m_refData pointer.

UnRef()

Decrements the reference count in the associated data, and if it is zero, deletes the data.

UnShare()

This is the same of AllocExclusive() but this method is public.

Inherited from simplewrapper

__init__(parent[, poly, pos, size, style])

Private Methods:

_outFunction(value)

Inherited from Keyboard

_setRects()


getCurrentNotes()[source]

Returns a list of the current notes.

reset()[source]

Resets the keyboard state.

setPoly(poly)[source]

Sets the maximum number of notes that can be held at the same time.

Args
poly: int

New maximum number of notes held at once.