This class implements the Progress Dialog for Waveform Creation. This dialog works two ways. The old way is that it is used to display progress from an EXTERNAL process. It needs to be non-Modal. To use it this way, you create it, call Show(), periodically update it using the Update() method, and then Destroy() it. The new way is that it is used to actually handle the audio extraction. In this case it is modal. To use it this way, you create it, then call the Extract() method, which will show it modally and handle updating itself. Then Destroy() it.

WaveformProgress contains the following public methods:

MethodDescription
Update() This method allows the contents of this form to be "updated" in the Wave Extraction Callback process
Extract() No description
OnIdle() No description
OnEndProcess() No description
MoveAfterInTabOrder() MoveAfterInTabOrder(self, Window win) Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window. The default tab order is the same as creation order. This function and `MoveBeforeInTabOrder` allow to change it after creating all the windows.
Fit() Fit(self) Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
InitDialog() InitDialog(self) Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
GetWindowBorderSize() GetWindowBorderSize(self) -> Size Return the size of the left/right and top/bottom borders.
ScreenToClient() ScreenToClient(self, Point pt) -> Point Converts from screen to client window coordinates.
SetTitle() SetTitle(self, String title)
EnableCloseButton() EnableCloseButton(self, bool enable) -> bool
Refresh() Refresh(self, bool eraseBackground=True, Rect rect=None) Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window.
GetClientRect() GetClientRect(self) -> Rect Get the client area position and size as a `wx.Rect` object.
HasFlag() HasFlag(self, int flag) -> bool Test if the given style is set for this window.
ConvertPixelSizeToDialog() ConvertPixelSizeToDialog(self, Size sz) -> Size
IsExposed() IsExposed(self, int x, int y, int w=1, int h=1) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
SetHelpTextForId() SetHelpTextForId(self, String text) Associate this help text with all windows with the same id as this one.
SetHelpText() SetHelpText(self, String text) Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself.
ShowFullScreen() ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool
Disconnect() Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool
HitTest() HitTest(self, Point pt) -> int Test where the given (in client coords) point lies
SetSizeWH() SetSizeWH(self, int width, int height) Sets the size of the window in pixels.
GetClientSizeTuple() GetClientSizeTuple() -> (width, height) This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
GetAcceleratorTable() GetAcceleratorTable(self) -> AcceleratorTable Gets the accelerator table for this window.
TransferDataToWindow() TransferDataToWindow(self) -> bool Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
IsDoubleBuffered() IsDoubleBuffered(self) -> bool Returns ``True`` if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.
IsIconized() IsIconized(self) -> bool
IsFullScreen() IsFullScreen(self) -> bool
GetClientSize() GetClientSize(self) -> Size This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
SetWindowVariant() SetWindowVariant(self, int variant) Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
SetTmpDefaultItem() SetTmpDefaultItem(self, Window win) Set this child as temporary default
CreateStdDialogButtonSizer() CreateStdDialogButtonSizer(self, long flags) -> StdDialogButtonSizer
GetThemeEnabled() GetThemeEnabled(self) -> bool Return the themeEnabled flag.
Freeze() Freeze(self) Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone. This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive.
SetValidator() SetValidator(self, Validator validator) Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
IsMaximized() IsMaximized(self) -> bool
GetAffirmativeId() GetAffirmativeId(self) -> int
SetFocus() SetFocus(self) Set's the focus to this window, allowing it to receive keyboard input.
SetWindowStyleFlag() SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
IsBeingDeleted() IsBeingDeleted(self) -> bool Is the window in the process of being deleted?
GetNextHandler() GetNextHandler(self) -> EvtHandler
GetTextExtent() GetTextExtent(String string) -> (width, height) Get the width and height of the text using the current font.
SetMaxSize() SetMaxSize(self, Size maxSize) A more convenient method than `SetSizeHints` for setting just the max size.
CreateSeparatedButtonSizer() CreateSeparatedButtonSizer(self, long flags) -> Sizer
GetScrollRange() GetScrollRange(self, int orientation) -> int Returns the built-in scrollbar range.
SetDoubleBuffered() SetDoubleBuffered(self, bool on) Currently wxGTK2 only.
SetSizeHints() SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt.
HasMultiplePages() HasMultiplePages(self) -> bool
SetOwnForegroundColour() SetOwnForegroundColour(self, Colour colour)
MoveBeforeInTabOrder() MoveBeforeInTabOrder(self, Window win) Same as `MoveAfterInTabOrder` except that it inserts this window just before win instead of putting it right after it.
MacGetMetalAppearance() MacGetMetalAppearance(self) -> bool
InheritAttributes() InheritAttributes(self) This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might. This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
DestroyChildren() DestroyChildren(self) -> bool Destroys all children of a window. Called automatically by the destructor.
IsModal() IsModal(self) -> bool
Validate() Validate(self) -> bool Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
HasScrollbar() HasScrollbar(self, int orient) -> bool Does the window have the scrollbar for this orientation?
MacSetMetalAppearance() MacSetMetalAppearance(self, bool on)
SetName() SetName(self, String name) Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label
SetBackgroundStyle() SetBackgroundStyle(self, int style) -> bool Returns the background style of the window. The background style indicates how the background of the window is drawn. ====================== ======================================== wx.BG_STYLE_SYSTEM The background colour or pattern should be determined by the system wx.BG_STYLE_COLOUR The background should be a solid colour wx.BG_STYLE_CUSTOM The background will be implemented by the application. ====================== ======================================== On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. :see: `GetBackgroundStyle`, `SetBackgroundColour`
GetVirtualSizeTuple() GetVirtualSizeTuple() -> (width, height) Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
HasTransparentBackground() HasTransparentBackground(self) -> bool Returns True if this window's background is transparent (as, for example, for `wx.StaticText`) and should show the parent window's background. This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly.
GetConstraints() GetConstraints(self) -> LayoutConstraints Returns a pointer to the window's layout constraints, or None if there are none.
GetVirtualSize() GetVirtualSize(self) -> Size Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
ScrollLines() ScrollLines(self, int lines) -> bool If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
IsEnabled() IsEnabled(self) -> bool Returns true if the window is enabled for input, false otherwise.
IsExposedRect() IsExposedRect(self, Rect rect) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
PushEventHandler() PushEventHandler(self, EvtHandler handler) Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is handed to the next one in the chain. Use `wx.Window.PopEventHandler` to remove the event handler. Ownership of the handler is *not* given to the window, so you should be sure to pop the handler before the window is destroyed and either let PopEventHandler destroy it, or call its Destroy method yourself.
Lower() Lower(self) Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
SetOwnFont() SetOwnFont(self, Font font)
GetScreenRect() GetScreenRect(self) -> Rect Returns the size and position of the window in screen coordinantes as a `wx.Rect` object.
Hide() Hide(self) -> bool Equivalent to calling Show(False).
Raise() Raise(self) Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
AdjustForLayoutDirection() AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
GetMaxWidth() GetMaxWidth(self) -> int
SetToolTipString() SetToolTipString(self, String tip) Attach a tooltip to the window.
SetVirtualSizeWH() SetVirtualSizeWH(self, int w, int h) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
PageUp() PageUp(self) -> bool This is just a wrapper for ScrollPages(-1).
GetChildren() GetChildren(self) -> PyObject Returns a list of the window's children. NOTE: Currently this is a copy of the child window list maintained by the window, so the return value of this function is only valid as long as the window's children do not change.
AssociateHandle() AssociateHandle(self, long handle) Associate the window with a new native handle
SetScrollPos() SetScrollPos(self, int orientation, int pos, bool refresh=True) Sets the position of one of the built-in scrollbars.
GetMinSize() GetMinSize(self) -> Size
SetReturnCode() SetReturnCode(self, int returnCode)
GetScreenPositionTuple() GetScreenPositionTuple() -> (x,y) Get the position of the window in screen coordinantes.
PostCreate() Phase 3 of the 2-phase create Call this method after precreating the window with the 2-phase create method.
RefreshRect() RefreshRect(self, Rect rect, bool eraseBackground=True) Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax.
SetThemeEnabled() SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme. Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
MakeModal() MakeModal(self, bool modal=True) Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
IsActive() IsActive(self) -> bool
SetBestFittingSize() Use `SetInitialSize`
HitTestXY() HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies
GetIcon() GetIcon(self) -> Icon
ScrollPages() ScrollPages(self, int pages) -> bool If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
GetMaxSize() GetMaxSize(self) -> Size
CenterOnScreen() CenterOnScreen(self, int dir=BOTH) Center the window on screen
SetNextHandler() SetNextHandler(self, EvtHandler handler)
WarpPointer() WarpPointer(self, int x, int y) Moves the pointer to the given position on the window. NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
SetDimensions() SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1. ======================== ====================================== wx.SIZE_AUTO A -1 indicates that a class-specific default should be used. wx.SIZE_USE_EXISTING Axisting dimensions should be used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be interpreted as real dimensions, not default values. ======================== ======================================
Enable() Enable(self, bool enable=True) -> bool Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
CaptureMouse() CaptureMouse(self) Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture. Note that wxWindows maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the `wx.MouseCaptureLostEvent` event. Any application which captures the mouse in the beginning of some operation *must* handle `wx.MouseCaptureLostEvent` and cancel this operation when it receives the event. The event handler must not recapture mouse.
SetCaret() SetCaret(self, Caret caret) Sets the caret associated with the window.
FindWindowById() FindWindowById(self, long winid) -> Window Find a chld of this window by window ID
CentreOnParent() CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window
SetBackgroundColour() SetBackgroundColour(self, Colour colour) -> bool Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. Using `wx.NullColour` will reset the window to the default background colour. Note that setting the background colour may not cause an immediate refresh, so you may wish to call `ClearBackground` or `Refresh` after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
InheritsBackgroundColour() InheritsBackgroundColour(self) -> bool
Navigate() Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool Does keyboard navigation from this window to another, by sending a `wx.NavigationKeyEvent`.
GetWindowStyle() GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method.
GetExtraStyle() GetExtraStyle(self) -> long Returns the extra style bits for the window.
UseBgCol() UseBgCol(self) -> bool
GetScrollPos() GetScrollPos(self, int orientation) -> int Returns the built-in scrollbar position.
RemoveChild() RemoveChild(self, Window child) Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
DissociateHandle() DissociateHandle(self) Dissociate the current native handle from the window
SetId() SetId(self, int winid) Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
SetEventHandler() SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event handler is handed off to the next one in the chain.
GetTmpDefaultItem() GetTmpDefaultItem(self) -> Window Return the temporary default item, which can be None.
Centre() Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
GetMinWidth() GetMinWidth(self) -> int
GetSize() GetSize(self) -> Size Get the window size.
SetEscapeId() SetEscapeId(self, int escapeId)
SetDefaultItem() SetDefaultItem(self, Window child) -> Window Set this child as default, return the old default.
Bind() Bind an event to an event handler. :param event: One of the EVT_* objects that specifies the type of event to bind, :param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler. :param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls. :param id: Used to spcify the event source by ID instead of instance. :param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE.
GetSizeTuple() GetSizeTuple() -> (width, height) Get the window size.
ClientToScreen() ClientToScreen(self, Point pt) -> Point Converts to screen coordinates from coordinates relative to this window.
GetForegroundColour() GetForegroundColour(self) -> Colour Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
SetSizerAndFit() SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size.
SetConstraints() SetConstraints(self, LayoutConstraints constraints) Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints. You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
Connect() Connect(self, int id, int lastId, int eventType, PyObject func)
GetPosition() GetPosition(self) -> Point Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows.
GetWindowVariant() GetWindowVariant(self) -> int
SetShape() SetShape(self, Region region) -> bool
AddChild() AddChild(self, Window child) Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
RequestUserAttention() RequestUserAttention(self, int flags=USER_ATTENTION_INFO)
PrepareDC() PrepareDC(self, DC dc) Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position.
SendSizeEvent() No description
SetExtraStyle() SetExtraStyle(self, long exStyle) Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag()
DragAcceptFiles() DragAcceptFiles(self, bool accept) Enables or disables eligibility for drop file events, EVT_DROP_FILES. Only functional on Windows.
GetRect() GetRect(self) -> Rect Returns the size and position of the window as a `wx.Rect` object.
ProcessPendingEvents() ProcessPendingEvents(self)
GetId() GetId(self) -> int Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
CenterOnParent() CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window
UpdateWindowUI() UpdateWindowUI(self, long flags=UPDATE_UI_NONE) This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at a particular point in time (as far as your EVT_UPDATE_UI handlers are concerned). This may be necessary if you have called `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to limit the overhead that wxWindows incurs by sending update UI events in idle time.
SetAcceleratorTable() SetAcceleratorTable(self, AcceleratorTable accel) Sets the accelerator table for this window.
Restore() Restore(self)
AcceptsFocus() AcceptsFocus(self) -> bool Can this window have focus?
SetSizer() SetSizer(self, Sizer sizer, bool deleteOld=True) Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise.
SetPosition() Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position.
LineUp() LineUp(self) -> bool This is just a wrapper for ScrollLines(-1).
SetOwnBackgroundColour() SetOwnBackgroundColour(self, Colour colour)
SetClientSize() SetClientSize(self, Size size) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
SetEvtHandlerEnabled() SetEvtHandlerEnabled(self, bool enabled)
GetReturnCode() GetReturnCode(self) -> int
GetPreviousHandler() GetPreviousHandler(self) -> EvtHandler
GetHandle() GetHandle(self) -> long Returns the platform-specific handle (as a long integer) of the physical window. Currently on wxMac it returns the handle of the toplevel parent of the window.
GetClientAreaOrigin() GetClientAreaOrigin(self) -> Point Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
IsSameAs() IsSameAs(self, Object p) -> bool For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
FindWindowByName() FindWindowByName(self, String name) -> Window Find a child of this window by name
IsAlwaysMaximized() IsAlwaysMaximized(self) -> bool
SetMinSize() SetMinSize(self, Size minSize) A more convenient method than `SetSizeHints` for setting just the min size.
ScreenToClientXY() ScreenToClientXY(int x, int y) -> (x,y) Converts from screen to client window coordinates.
SetVirtualSizeHints() SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the virtual area of the window outside the given bounds.
IsFrozen() IsFrozen(self) -> bool Returns ``True`` if the window has been frozen and not thawed yet. :see: `Freeze` and `Thaw`
SetClientRect() SetClientRect(self, Rect rect) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
ClearBackground() ClearBackground(self) Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
GetBestSize() GetBestSize(self) -> Size This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (suzh aswx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
CacheBestSize() CacheBestSize(self, Size size) Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.)
GetToolTip() GetToolTip(self) -> ToolTip get the associated tooltip or None if none
Move() Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position.
GetEvtHandlerEnabled() GetEvtHandlerEnabled(self) -> bool
LineDown() LineDown(self) -> bool This is just a wrapper for ScrollLines(1).
Create() Create(self, Window parent, int id=-1, String title=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -> bool
GetCharWidth() GetCharWidth(self) -> int Get the (average) character size for the current font.
SetLabel() SetLabel(self, String label) Set the text which the window shows in its label if applicable.
Thaw() Thaw(self) Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
GetCaret() GetCaret(self) -> Caret Returns the caret associated with the window.
SetIcons() SetIcons(self, wxIconBundle icons)
CreateButtonSizer() No description
SetToolTip() SetToolTip(self, ToolTip tip) Attach a tooltip to the window.
GetBackgroundColour() GetBackgroundColour(self) -> Colour Returns the background colour of the window.
IsShownOnScreen() IsShownOnScreen(self) -> bool Returns ``True`` if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.
GetLayoutDirection() GetLayoutDirection(self) -> int Get the layout direction (LTR or RTL) for this window. Returns ``wx.Layout_Default`` if layout direction is not supported.
GetMaxHeight() GetMaxHeight(self) -> int
ShowModal() ShowModal(self) -> int
FitInside() FitInside(self) Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.
GetContainingSizer() GetContainingSizer(self) -> Sizer Return the sizer that this window is a member of, if any, otherwise None.
IsRetained() IsRetained(self) -> bool Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
GetSizer() GetSizer(self) -> Sizer Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one.
GetDefaultItem() GetDefaultItem(self) -> Window Get the default child of this parent, i.e. the one which is activated by pressing such as the OK button on a wx.Dialog.
SetDropTarget() SetDropTarget(self, DropTarget dropTarget) Associates a drop target with this window. If the window already has a drop target, it is deleted.
Center() Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
GetScreenPosition() GetScreenPosition(self) -> Point Get the position of the window in screen coordinantes.
SetIcon() SetIcon(self, Icon icon)
MoveXY() MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) Moves the window to the given position.
GetUpdateRegion() GetUpdateRegion(self) -> Region Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
OnPaint() OnPaint(self, PaintEvent event)
PageDown() PageDown(self) -> bool This is just a wrapper for ScrollPages(1).
ReleaseMouse() ReleaseMouse(self) Releases mouse input captured with wx.Window.CaptureMouse.
GetBorder() GetBorder(self, long flags) -> int GetBorder(self) -> int Get border for the flags of this window
SetInitialSize() SetInitialSize(self, Size size=DefaultSize) A 'Smart' SetSize that will fill in default size components with the window's *best size* values. Also set's the minsize for use with sizers.
IsTopLevel() IsTopLevel(self) -> bool Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
GetDefaultAttributes() GetDefaultAttributes(self) -> VisualAttributes Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
SetForegroundColour() SetForegroundColour(self, Colour colour) -> bool Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
GetBestFittingSize() Use `GetEffectiveMinSize` instead.
GetHelpTextAtPoint() GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String Get the help string associated with the given position in this window. Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then
IsExposedPoint() IsExposedPoint(self, Point pt) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
GetMinHeight() GetMinHeight(self) -> int
GetDropTarget() GetDropTarget(self) -> DropTarget Returns the associated drop target, which may be None.
CanSetTransparent() CanSetTransparent(self) -> bool Returns ``True`` if the platform supports setting the transparency for this window. Note that this method will err on the side of caution, so it is possible that this will return ``False`` when it is in fact possible to set the transparency. NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running.
GetName() GetName(self) -> String Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
GetBackgroundStyle() GetBackgroundStyle(self) -> int Returns the background style of the window. :see: `SetBackgroundStyle`
GetAdjustedBestSize() Use `GetEffectiveMinSize` instead.
SetCursor() SetCursor(self, Cursor cursor) -> bool Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
SetClientSizeWH() SetClientSizeWH(self, int width, int height) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
RemoveEventHandler() RemoveEventHandler(self, EvtHandler handler) -> bool Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.)
UnregisterHotKey() UnregisterHotKey(self, int hotkeyId) -> bool Unregisters a system wide hotkey.
SetContainingSizer() SetContainingSizer(self, Sizer sizer) This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
GetFullTextExtent() GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font.
GetGrandParent() GetGrandParent(self) -> Window Returns the parent of the parent of this window, or None if there isn't one.
ProcessEvent() ProcessEvent(self, Event event) -> bool
GetBestVirtualSize() GetBestVirtualSize(self) -> Size Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
CentreOnScreen() CenterOnScreen(self, int dir=BOTH) Center the window on screen
GetScrollThumb() GetScrollThumb(self, int orientation) -> int Returns the built-in scrollbar thumb size.
PopupMenuXY() PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
DLG_SZE() DLG_SZE(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
Unbind() Disconencts the event handler binding for event from self. Returns True if successful.
ClientToScreenXY() ClientToScreenXY(int x, int y) -> (x,y) Converts to screen coordinates from coordinates relative to this window.
GetTopLevelParent() GetTopLevelParent(self) -> Window Returns the first frame or dialog in this window's parental hierarchy.
SetTransparent() SetTransparent(self, byte alpha) -> bool Attempt to set the transparency of this window to the ``alpha`` value, returns True on success. The ``alpha`` value is an integer in the range of 0 to 255, where 0 is fully transparent and 255 is fully opaque.
GetFont() GetFont(self) -> Font Returns the default font used for this window.
AddPendingEvent() AddPendingEvent(self, Event event)
Show() Show(self, bool show=True) -> bool Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.
RegisterHotKey() RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
Maximize() Maximize(self, bool maximize=True)
ScrollWindow() ScrollWindow(self, int dx, int dy, Rect rect=None) Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program.
GetWindowStyleFlag() GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method.
GetParent() GetParent(self) -> Window Returns the parent window of this window, or None if there isn't one.
PopupMenu() PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
Destroy() Destroy(self) -> bool Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows. Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
SetVirtualSizeHintsSz() SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize) Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the virtual area of the window outside the given bounds.
SetPreviousHandler() SetPreviousHandler(self, EvtHandler handler)
Iconize() Iconize(self, bool iconize=True)
CreateTextSizer() CreateTextSizer(self, String message) -> Sizer
HasCapture() HasCapture(self) -> bool Returns true if this window has the current mouse capture.
GetClassName() GetClassName(self) -> String Returns the class name of the C++ class using wxRTTI.
GetCharHeight() GetCharHeight(self) -> int Get the (average) character size for the current font.
GetEscapeId() GetEscapeId(self) -> int
ConvertDialogPointToPixels() ConvertDialogPointToPixels(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
GetTitle() GetTitle(self) -> String
EndModal() EndModal(self, int retCode)
SetFont() SetFont(self, Font font) -> bool Sets the font for this window.
SetFocusFromKbd() SetFocusFromKbd(self) Set focus to this window as the result of a keyboard action. Normally only called internally.
TransferDataFromWindow() TransferDataFromWindow(self) -> bool Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
SetWindowStyle() SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
GetPositionTuple() GetPositionTuple() -> (x,y) Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows.
SetLayoutDirection() SetLayoutDirection(self, int dir) Set the layout direction (LTR or RTL) for this window.
PopEventHandler() PopEventHandler(self, bool deleteHandler=False) -> EvtHandler Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped, and ``None`` will be returned instead.
GetBestSizeTuple() GetBestSizeTuple() -> (width, height) This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (suzh aswx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
GetHelpText() GetHelpText(self) -> String Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself.
IsShown() IsShown(self) -> bool Returns true if the window is shown, false if it has been hidden.
InvalidateBestSize() InvalidateBestSize(self) Reset the cached best size value so it will be recalculated the next time it is needed.
SetSizeHintsSz() SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt.
SetVirtualSize() SetVirtualSize(self, Size size) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
SetAutoLayout() SetAutoLayout(self, bool autoLayout) Determines whether the Layout function will be called automatically when the window is resized. lease note that this only happens for the windows usually used to contain children, namely `wx.Panel` and `wx.TopLevelWindow` (and the classes deriving from them). This method is called implicitly by `SetSizer` but if you use `SetConstraints` you should call it manually or otherwise the window layout won't be correctly updated when its size changes.
Close() Close(self, bool force=False) -> bool This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window.
SetAffirmativeId() SetAffirmativeId(self, int affirmativeId)
Layout() Layout(self) -> bool Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
ConvertPixelPointToDialog() ConvertPixelPointToDialog(self, Point pt) -> Point
ConvertDialogSizeToPixels() ConvertDialogSizeToPixels(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
AcceptsFocusFromKeyboard() AcceptsFocusFromKeyboard(self) -> bool Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
SetSize() SetSize(self, Size size) Sets the size of the window in pixels.
GetValidator() GetValidator(self) -> Validator Returns a pointer to the current validator for the window, or None if there is none.
Disable() Disable(self) -> bool Disables the window, same as Enable(false).
GetEffectiveMinSize() GetEffectiveMinSize(self) -> Size This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
GetLabel() GetLabel(self) -> String Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
GetEventHandler() GetEventHandler(self) -> EvtHandler Returns the event handler for this window. By default, the window is its own event handler.
GetAutoLayout() GetAutoLayout(self) -> bool Returns the current autoLayout setting
Reparent() Reparent(self, Window newParent) -> bool Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
ToggleWindowStyle() ToggleWindowStyle(self, int flag) -> bool Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
ShouldInheritColours() ShouldInheritColours(self) -> bool Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window. The base class version returns false, but this method is overridden in wxControl where it returns true.
SetRect() SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels using a wx.Rect.
GetCursor() GetCursor(self) -> Cursor Return the cursor associated with this window.
SetScrollbar() SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar.
GetUpdateClientRect() GetUpdateClientRect(self) -> Rect Get the update rectangle region bounding box in client coords.
DLG_PNT() DLG_PNT(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

WaveformProgress contains the following public properties:

PropertyDescription
AcceleratorTable See `GetAcceleratorTable` and `SetAcceleratorTable`
AffirmativeId See `GetAffirmativeId` and `SetAffirmativeId`
AutoLayout See `GetAutoLayout` and `SetAutoLayout`
BackgroundColour See `GetBackgroundColour` and `SetBackgroundColour`
BackgroundStyle See `GetBackgroundStyle` and `SetBackgroundStyle`
BestSize See `GetBestSize`
BestVirtualSize See `GetBestVirtualSize`
Border See `GetBorder`
Caret See `GetCaret` and `SetCaret`
CharHeight See `GetCharHeight`
CharWidth See `GetCharWidth`
Children See `GetChildren`
ClassName See `GetClassName`
ClientAreaOrigin See `GetClientAreaOrigin`
ClientRect See `GetClientRect` and `SetClientRect`
ClientSize See `GetClientSize` and `SetClientSize`
Constraints See `GetConstraints` and `SetConstraints`
ContainingSizer See `GetContainingSizer` and `SetContainingSizer`
Cursor See `GetCursor` and `SetCursor`
DefaultAttributes See `GetDefaultAttributes`
DefaultItem See `GetDefaultItem` and `SetDefaultItem`
DropTarget See `GetDropTarget` and `SetDropTarget`
EffectiveMinSize See `GetEffectiveMinSize`
Enabled See `IsEnabled` and `Enable`
EscapeId See `GetEscapeId` and `SetEscapeId`
EventHandler See `GetEventHandler` and `SetEventHandler`
EvtHandlerEnabled See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`
ExtraStyle See `GetExtraStyle` and `SetExtraStyle`
Font See `GetFont` and `SetFont`
ForegroundColour See `GetForegroundColour` and `SetForegroundColour`
GrandParent See `GetGrandParent`
Handle See `GetHandle`
HelpText See `GetHelpText` and `SetHelpText`
Icon See `GetIcon` and `SetIcon`
Id See `GetId` and `SetId`
Label See `GetLabel` and `SetLabel`
LayoutDirection See `GetLayoutDirection` and `SetLayoutDirection`
MaxHeight See `GetMaxHeight`
MaxSize See `GetMaxSize` and `SetMaxSize`
MaxWidth See `GetMaxWidth`
MinHeight See `GetMinHeight`
MinSize See `GetMinSize` and `SetMinSize`
MinWidth See `GetMinWidth`
Name See `GetName` and `SetName`
NextHandler See `GetNextHandler` and `SetNextHandler`
Parent See `GetParent`
Position See `GetPosition` and `SetPosition`
PreviousHandler See `GetPreviousHandler` and `SetPreviousHandler`
Rect See `GetRect` and `SetRect`
ReturnCode See `GetReturnCode` and `SetReturnCode`
ScreenPosition See `GetScreenPosition`
ScreenRect See `GetScreenRect`
Shown See `IsShown` and `Show`
Size See `GetSize` and `SetSize`
Sizer See `GetSizer` and `SetSizer`
ThemeEnabled See `GetThemeEnabled` and `SetThemeEnabled`
Title See `GetTitle` and `SetTitle`
TmpDefaultItem See `GetTmpDefaultItem` and `SetTmpDefaultItem`
ToolTip See `GetToolTip` and `SetToolTip`
TopLevel See `IsTopLevel`
TopLevelParent See `GetTopLevelParent`
UpdateClientRect See `GetUpdateClientRect`
UpdateRegion See `GetUpdateRegion`
Validator See `GetValidator` and `SetValidator`
VirtualSize See `GetVirtualSize` and `SetVirtualSize`
WindowStyle See `GetWindowStyle` and `SetWindowStyle`
WindowStyleFlag See `GetWindowStyleFlag` and `SetWindowStyleFlag`
WindowVariant See `GetWindowVariant` and `SetWindowVariant`
thisown The membership flag