Package wx :: Module _core :: Class Window
[show private | hide private]
[frames | no frames]

Type Window

object --+        
         |        
    Object --+    
             |    
    EvtHandler --+
                 |
                Window

Known Subclasses:
Control, Panel, TopLevelWindow

wx.Window is the base class for all windows and represents any visible object on the screen. All controls, top level windows and so on are wx.Windows. Sizers and device contexts are not however, as they don't appear on screen themselves.
Method Summary
  __init__(self, *args, **kwargs)
__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window Construct and show a generic Window.
  __repr__(self)
  AcceptsFocus(*args, **kwargs)
AcceptsFocus(self) -> bool
  AcceptsFocusFromKeyboard(*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
  AddChild(*args, **kwargs)
AddChild(self, Window child)
  AssociateHandle(*args, **kwargs)
AssociateHandle(self, long handle)
  CaptureMouse(*args, **kwargs)
CaptureMouse(self)
  Center(*args, **kwargs)
Center(self, int direction=BOTH)
  CenterOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  CenterOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  Centre(*args, **kwargs)
Center(self, int direction=BOTH)
  CentreOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  CentreOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  ClearBackground(*args, **kwargs)
ClearBackground(self)
  ClientToScreen(*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
  ClientToScreenXY(*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
  Close(*args, **kwargs)
Close(self, bool force=False) -> bool
  ConvertDialogPointToPixels(*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
  ConvertDialogSizeToPixels(*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
  ConvertPixelPointToDialog(*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
  ConvertPixelSizeToDialog(*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
  Create(*args, **kwargs)
Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode.
  Destroy(*args, **kwargs)
Destroy(self) -> bool
  DestroyChildren(*args, **kwargs)
DestroyChildren(self) -> bool
  Disable(*args, **kwargs)
Disable(self) -> bool
  DissociateHandle(*args, **kwargs)
DissociateHandle(self)
  DLG_PNT(*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
  DLG_SZE(*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
  Enable(*args, **kwargs)
Enable(self, bool enable=True) -> bool
  FindFocus(*args, **kwargs)
FindFocus() -> Window (Static method)
  FindWindowById(*args, **kwargs)
FindWindowById(self, long winid) -> Window
  FindWindowByName(*args, **kwargs)
FindWindowByName(self, String name) -> Window
  Fit(*args, **kwargs)
Fit(self)
  FitInside(*args, **kwargs)
FitInside(self)
  Freeze(*args, **kwargs)
Freeze(self)
  GetAcceleratorTable(*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
  GetAdjustedBestSize(*args, **kwargs)
GetAdjustedBestSize(self) -> Size
  GetAutoLayout(*args, **kwargs)
GetAutoLayout(self) -> bool
  GetBackgroundColour(*args, **kwargs)
GetBackgroundColour(self) -> Colour
  GetBackgroundStyle(*args, **kwargs)
GetBackgroundStyle(self) -> int
  GetBestFittingSize(*args, **kwargs)
GetBestFittingSize(self) -> Size
  GetBestSize(*args, **kwargs)
GetBestSize(self) -> Size
  GetBestSizeTuple(*args, **kwargs)
GetBestSizeTuple() -> (width, height)
  GetBestVirtualSize(*args, **kwargs)
GetBestVirtualSize(self) -> Size
  GetBorder(*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
  GetCapture(*args, **kwargs)
GetCapture() -> Window (Static method)
  GetCaret(*args, **kwargs)
GetCaret(self) -> Caret
  GetCharHeight(*args, **kwargs)
GetCharHeight(self) -> int
  GetCharWidth(*args, **kwargs)
GetCharWidth(self) -> int
  GetChildren(*args, **kwargs)
GetChildren(self) -> PyObject
  GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes (Static method)
  GetClientAreaOrigin(*args, **kwargs)
GetClientAreaOrigin(self) -> Point
  GetClientRect(*args, **kwargs)
GetClientRect(self) -> Rect
  GetClientSize(*args, **kwargs)
GetClientSize(self) -> Size
  GetClientSizeTuple(*args, **kwargs)
GetClientSizeTuple() -> (width, height)
  GetConstraints(*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
  GetContainingSizer(*args, **kwargs)
GetContainingSizer(self) -> Sizer
  GetCursor(*args, **kwargs)
GetCursor(self) -> Cursor
  GetDefaultAttributes(*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
  GetDefaultItem(*args, **kwargs)
GetDefaultItem(self) -> Window
  GetDropTarget(*args, **kwargs)
GetDropTarget(self) -> DropTarget
  GetEventHandler(*args, **kwargs)
GetEventHandler(self) -> EvtHandler
  GetExtraStyle(*args, **kwargs)
GetExtraStyle(self) -> long
  GetFont(*args, **kwargs)
GetFont(self) -> Font
  GetForegroundColour(*args, **kwargs)
GetForegroundColour(self) -> Colour
  GetFullTextExtent(*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font.
  GetGrandParent(*args, **kwargs)
GetGrandParent(self) -> Window
  GetHandle(*args, **kwargs)
GetHandle(self) -> long
  GetHelpText(*args, **kwargs)
GetHelpText(self) -> String
  GetId(*args, **kwargs)
GetId(self) -> int
  GetLabel(*args, **kwargs)
GetLabel(self) -> String
  GetMaxHeight(*args, **kwargs)
GetMaxHeight(self) -> int
  GetMaxSize(*args, **kwargs)
GetMaxSize(self) -> Size
  GetMaxWidth(*args, **kwargs)
GetMaxWidth(self) -> int
  GetMinHeight(*args, **kwargs)
GetMinHeight(self) -> int
  GetMinSize(*args, **kwargs)
GetMinSize(self) -> Size
  GetMinWidth(*args, **kwargs)
GetMinWidth(self) -> int
  GetName(*args, **kwargs)
GetName(self) -> String
  GetParent(*args, **kwargs)
GetParent(self) -> Window
  GetPosition(*args, **kwargs)
GetPosition(self) -> Point
  GetPositionTuple(*args, **kwargs)
GetPositionTuple() -> (x,y)
  GetRect(*args, **kwargs)
GetRect(self) -> Rect
  GetScrollPos(*args, **kwargs)
GetScrollPos(self, int orientation) -> int
  GetScrollRange(*args, **kwargs)
GetScrollRange(self, int orientation) -> int
  GetScrollThumb(*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
  GetSize(*args, **kwargs)
GetSize(self) -> Size
  GetSizer(*args, **kwargs)
GetSizer(self) -> Sizer
  GetSizeTuple(*args, **kwargs)
GetSizeTuple() -> (width, height)
  GetTextExtent(*args, **kwargs)
GetTextExtent(String string) -> (width, height)
  GetThemeEnabled(*args, **kwargs)
GetThemeEnabled(self) -> bool
  GetTitle(*args, **kwargs)
GetTitle(self) -> String
  GetToolTip(*args, **kwargs)
GetToolTip(self) -> ToolTip
  GetUpdateClientRect(*args, **kwargs)
GetUpdateClientRect(self) -> Rect
  GetUpdateRegion(*args, **kwargs)
GetUpdateRegion(self) -> Region
  GetValidator(*args, **kwargs)
GetValidator(self) -> Validator
  GetVirtualSize(*args, **kwargs)
GetVirtualSize(self) -> Size
  GetVirtualSizeTuple(*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
  GetWindowStyle(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowStyleFlag(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowVariant(*args, **kwargs)
GetWindowVariant(self) -> int
  HasCapture(*args, **kwargs)
HasCapture(self) -> bool
  HasFlag(*args, **kwargs)
HasFlag(self, int flag) -> bool
  HasScrollbar(*args, **kwargs)
HasScrollbar(self, int orient) -> bool
  Hide(*args, **kwargs)
Hide(self) -> bool
  HitTest(*args, **kwargs)
HitTest(self, Point pt) -> int
  HitTestXY(*args, **kwargs)
HitTestXY(self, int x, int y) -> int
  InheritAttributes(*args, **kwargs)
InheritAttributes(self)
  InitDialog(*args, **kwargs)
InitDialog(self)
  InvalidateBestSize(*args, **kwargs)
InvalidateBestSize(self)
  IsBeingDeleted(*args, **kwargs)
IsBeingDeleted(self) -> bool
  IsEnabled(*args, **kwargs)
IsEnabled(self) -> bool
  IsExposed(*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
  IsExposedPoint(*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
  IsExposedRect(*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
  IsRetained(*args, **kwargs)
IsRetained(self) -> bool
  IsShown(*args, **kwargs)
IsShown(self) -> bool
  IsTopLevel(*args, **kwargs)
IsTopLevel(self) -> bool
  Layout(*args, **kwargs)
Layout(self) -> bool
  LineDown(*args, **kwargs)
LineDown(self) -> bool
  LineUp(*args, **kwargs)
LineUp(self) -> bool
  Lower(*args, **kwargs)
Lower(self)
  MakeModal(*args, **kwargs)
MakeModal(self, bool modal=True)
  Move(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  MoveAfterInTabOrder(*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
  MoveBeforeInTabOrder(*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
  MoveXY(*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
  Navigate(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
  NewControlId(*args, **kwargs)
NewControlId() -> int (Static method)
  NextControlId(*args, **kwargs)
NextControlId(int winid) -> int (Static method)
  PageDown(*args, **kwargs)
PageDown(self) -> bool
  PageUp(*args, **kwargs)
PageUp(self) -> bool
  PopEventHandler(*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
  PopupMenu(*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
  PopupMenuXY(*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
  PostCreate(self, pre)
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
  PrepareDC(*args, **kwargs)
PrepareDC(self, DC dc)
  PrevControlId(*args, **kwargs)
PrevControlId(int winid) -> int (Static method)
  PushEventHandler(*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
  Raise(*args, **kwargs)
Raise(self)
  Refresh(*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
  RefreshRect(*args, **kwargs)
RefreshRect(self, Rect rect)
  RegisterHotKey(*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
  ReleaseMouse(*args, **kwargs)
ReleaseMouse(self)
  RemoveChild(*args, **kwargs)
RemoveChild(self, Window child)
  RemoveEventHandler(*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
  Reparent(*args, **kwargs)
Reparent(self, Window newParent) -> bool
  ScreenToClient(*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
  ScreenToClientXY(*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
  ScrollLines(*args, **kwargs)
ScrollLines(self, int lines) -> bool
  ScrollPages(*args, **kwargs)
ScrollPages(self, int pages) -> bool
  ScrollWindow(*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
  SetAcceleratorTable(*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
  SetAutoLayout(*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
  SetBackgroundColour(*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
  SetBackgroundStyle(*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool Returns the background style of the window.
  SetBestFittingSize(*args, **kwargs)
SetBestFittingSize(self, Size size=DefaultSize)
  SetCaret(*args, **kwargs)
SetCaret(self, Caret caret)
  SetClientRect(*args, **kwargs)
SetClientRect(self, Rect rect)
  SetClientSize(*args, **kwargs)
SetClientSize(self, Size size)
  SetClientSizeWH(*args, **kwargs)
SetClientSizeWH(self, int width, int height)
  SetConstraints(*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
  SetContainingSizer(*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
  SetCursor(*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
  SetDefaultItem(*args, **kwargs)
SetDefaultItem(self, Window child) -> Window
  SetDimensions(*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
  SetDropTarget(*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
  SetEventHandler(*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
  SetExtraStyle(*args, **kwargs)
SetExtraStyle(self, long exStyle)
  SetFocus(*args, **kwargs)
SetFocus(self)
  SetFocusFromKbd(*args, **kwargs)
SetFocusFromKbd(self)
  SetFont(*args, **kwargs)
SetFont(self, Font font) -> bool
  SetForegroundColour(*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
  SetHelpText(*args, **kwargs)
SetHelpText(self, String text)
  SetHelpTextForId(*args, **kwargs)
SetHelpTextForId(self, String text)
  SetId(*args, **kwargs)
SetId(self, int winid)
  SetLabel(*args, **kwargs)
SetLabel(self, String label)
  SetMaxSize(*args, **kwargs)
SetMaxSize(self, Size maxSize)
  SetMinSize(*args, **kwargs)
SetMinSize(self, Size minSize)
  SetName(*args, **kwargs)
SetName(self, String name)
  SetOwnBackgroundColour(*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
  SetOwnFont(*args, **kwargs)
SetOwnFont(self, Font font)
  SetOwnForegroundColour(*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
  SetPosition(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  SetRect(*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
  SetScrollbar(*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar.
  SetScrollPos(*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
  SetSize(*args, **kwargs)
SetSize(self, Size size)
  SetSizeHints(*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments.
  SetSizeHintsSz(*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
  SetSizer(*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
  SetSizerAndFit(*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
  SetSizeWH(*args, **kwargs)
SetSizeWH(self, int width, int height)
  SetThemeEnabled(*args, **kwargs)
SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code.
  SetTitle(*args, **kwargs)
SetTitle(self, String title)
  SetTmpDefaultItem(*args, **kwargs)
SetTmpDefaultItem(self, Window win)
  SetToolTip(*args, **kwargs)
SetToolTip(self, ToolTip tip)
  SetToolTipString(*args, **kwargs)
SetToolTipString(self, String tip)
  SetValidator(*args, **kwargs)
SetValidator(self, Validator validator)
  SetVirtualSize(*args, **kwargs)
SetVirtualSize(self, Size size)
  SetVirtualSizeHints(*args, **kwargs)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
  SetVirtualSizeHintsSz(*args, **kwargs)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
  SetVirtualSizeWH(*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
  SetWindowStyle(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowStyleFlag(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowVariant(*args, **kwargs)
SetWindowVariant(self, int variant)
  ShouldInheritColours(*args, **kwargs)
ShouldInheritColours(self) -> bool
  Show(*args, **kwargs)
Show(self, bool show=True) -> bool
  Thaw(*args, **kwargs)
Thaw(self)
  TransferDataFromWindow(*args, **kwargs)
TransferDataFromWindow(self) -> bool
  TransferDataToWindow(*args, **kwargs)
TransferDataToWindow(self) -> bool
  UnregisterHotKey(*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
  Update(*args, **kwargs)
Update(self)
  UpdateWindowUI(*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
  Validate(*args, **kwargs)
Validate(self) -> bool
  WarpPointer(*args, **kwargs)
WarpPointer(self, int x, int y)
    Inherited from EvtHandler
  _setOORInfo(*args, **kwargs)
_setOORInfo(self, PyObject _self)
  AddPendingEvent(*args, **kwargs)
AddPendingEvent(self, Event event)
  Bind(self, event, handler, source, id, id2)
Bind an event to an event handler.
  Connect(*args, **kwargs)
Connect(self, int id, int lastId, int eventType, PyObject func)
  Disconnect(*args, **kwargs)
Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool
  GetEvtHandlerEnabled(*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
  GetNextHandler(*args, **kwargs)
GetNextHandler(self) -> EvtHandler
  GetPreviousHandler(*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
  ProcessEvent(*args, **kwargs)
ProcessEvent(self, Event event) -> bool
  ProcessPendingEvents(*args, **kwargs)
ProcessPendingEvents(self)
  SetEvtHandlerEnabled(*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
  SetNextHandler(*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
  SetPreviousHandler(*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
  Unbind(self, event, source, id, id2)
Disconencts the event handler binding for event from self.
    Inherited from Object
  GetClassName(*args, **kwargs)
GetClassName(self) -> String
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
Implements __implemented__ = <implementedBy wx._core.Window>
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
    Inherited from Object
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...

Instance Method Details

__init__(self, *args, **kwargs)
(Constructor)

__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, 
    Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window

Construct and show a generic Window.
Overrides:
wx._core.EvtHandler.__init__

AcceptsFocus(*args, **kwargs)

AcceptsFocus(self) -> bool

Can this window have focus?

AcceptsFocusFromKeyboard(*args, **kwargs)

AcceptsFocusFromKeyboard(self) -> bool

Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.

AddChild(*args, **kwargs)

AddChild(self, Window child)

Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.

AssociateHandle(*args, **kwargs)

AssociateHandle(self, long handle)

Associate the window with a new native handle

CaptureMouse(*args, **kwargs)

CaptureMouse(self)

Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.

Note that wxWindows maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it.

Center(*args, **kwargs)

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.

CenterOnParent(*args, **kwargs)

CenterOnParent(self, int dir=BOTH)

Center with respect to the the parent window

CenterOnScreen(*args, **kwargs)

CenterOnScreen(self, int dir=BOTH)

Center on screen (only works for top level windows)

Centre(*args, **kwargs)

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.

CentreOnParent(*args, **kwargs)

CenterOnParent(self, int dir=BOTH)

Center with respect to the the parent window

CentreOnScreen(*args, **kwargs)

CenterOnScreen(self, int dir=BOTH)

Center on screen (only works for top level windows)

ClearBackground(*args, **kwargs)

ClearBackground(self)

Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.

ClientToScreen(*args, **kwargs)

ClientToScreen(self, Point pt) -> Point

Converts to screen coordinates from coordinates relative to this window.

ClientToScreenXY(*args, **kwargs)

ClientToScreenXY(int x, int y) -> (x,y)

Converts to screen coordinates from coordinates relative to this window.

Close(*args, **kwargs)

Close(self, bool force=False) -> bool

This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window.

ConvertDialogPointToPixels(*args, **kwargs)

ConvertDialogPointToPixels(self, Point pt) -> Point

Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

ConvertDialogSizeToPixels(*args, **kwargs)

ConvertDialogSizeToPixels(self, Size sz) -> Size

Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

ConvertPixelPointToDialog(*args, **kwargs)

ConvertPixelPointToDialog(self, Point pt) -> Point

ConvertPixelSizeToDialog(*args, **kwargs)

ConvertPixelSizeToDialog(self, Size sz) -> Size

Create(*args, **kwargs)

Create(self, Window parent, int id=-1, Point pos=DefaultPosition, 
    Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool

Create the GUI part of the Window for 2-phase creation mode.

Destroy(*args, **kwargs)

Destroy(self) -> bool

Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.

Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
Overrides:
wx._core.Object.Destroy

DestroyChildren(*args, **kwargs)

DestroyChildren(self) -> bool

Destroys all children of a window. Called automatically by the destructor.

Disable(*args, **kwargs)

Disable(self) -> bool

Disables the window, same as Enable(false).

DissociateHandle(*args, **kwargs)

DissociateHandle(self)

Dissociate the current native handle from the window

DLG_PNT(*args, **kwargs)

DLG_PNT(self, Point pt) -> Point

Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

DLG_SZE(*args, **kwargs)

DLG_SZE(self, Size sz) -> Size

Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Enable(*args, **kwargs)

Enable(self, bool enable=True) -> bool

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

FindWindowById(*args, **kwargs)

FindWindowById(self, long winid) -> Window

Find a chld of this window by window ID

FindWindowByName(*args, **kwargs)

FindWindowByName(self, String name) -> Window

Find a child of this window by name

Fit(*args, **kwargs)

Fit(self)

Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.

FitInside(*args, **kwargs)

FitInside(self)

Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.

Freeze(*args, **kwargs)

Freeze(self)

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.

This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive.

GetAcceleratorTable(*args, **kwargs)

GetAcceleratorTable(self) -> AcceleratorTable

Gets the accelerator table for this window.

GetAdjustedBestSize(*args, **kwargs)

GetAdjustedBestSize(self) -> Size

This method is similar to GetBestSize, except in one thing. GetBestSize should return the minimum untruncated size of the window, while this method will return the largest of BestSize and any user specified minimum size. ie. it is the minimum size the window should currently be drawn at, not the minimal size it can possibly tolerate.

GetAutoLayout(*args, **kwargs)

GetAutoLayout(self) -> bool

Returns the current autoLayout setting

GetBackgroundColour(*args, **kwargs)

GetBackgroundColour(self) -> Colour

Returns the background colour of the window.

GetBackgroundStyle(*args, **kwargs)

GetBackgroundStyle(self) -> int

Returns the background style of the window.

:see: `SetBackgroundStyle`

GetBestFittingSize(*args, **kwargs)

GetBestFittingSize(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.

GetBestSize(*args, **kwargs)

GetBestSize(self) -> Size

This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (suzh aswx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.

GetBestSizeTuple(*args, **kwargs)

GetBestSizeTuple() -> (width, height)

This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (suzh aswx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.

GetBestVirtualSize(*args, **kwargs)

GetBestVirtualSize(self) -> Size

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

GetBorder(*args)

GetBorder(self, long flags) -> int GetBorder(self) -> int

Get border for the flags of this window

GetCaret(*args, **kwargs)

GetCaret(self) -> Caret

Returns the caret associated with the window.

GetCharHeight(*args, **kwargs)

GetCharHeight(self) -> int

Get the (average) character size for the current font.

GetCharWidth(*args, **kwargs)

GetCharWidth(self) -> int

Get the (average) character size for the current font.

GetChildren(*args, **kwargs)

GetChildren(self) -> 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.

GetClientAreaOrigin(*args, **kwargs)

GetClientAreaOrigin(self) -> Point

Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)

GetClientRect(*args, **kwargs)

GetClientRect(self) -> Rect

Get the client area position and size as a `wx.Rect` object.

GetClientSize(*args, **kwargs)

GetClientSize(self) -> Size

This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.

GetClientSizeTuple(*args, **kwargs)

GetClientSizeTuple() -> (width, height)

This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.

GetConstraints(*args, **kwargs)

GetConstraints(self) -> LayoutConstraints

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

GetContainingSizer(*args, **kwargs)

GetContainingSizer(self) -> Sizer

Return the sizer that this window is a member of, if any, otherwise None.

GetCursor(*args, **kwargs)

GetCursor(self) -> Cursor

Return the cursor associated with this window.

GetDefaultAttributes(*args, **kwargs)

GetDefaultAttributes(self) -> VisualAttributes

Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.

GetDefaultItem(*args, **kwargs)

GetDefaultItem(self) -> Window

Get the default child of this parent, i.e. the one which is activated by pressing <Enter> such as the OK button on a wx.Dialog.

GetDropTarget(*args, **kwargs)

GetDropTarget(self) -> DropTarget

Returns the associated drop target, which may be None.

GetEventHandler(*args, **kwargs)

GetEventHandler(self) -> EvtHandler

Returns the event handler for this window. By default, the window is its own event handler.

GetExtraStyle(*args, **kwargs)

GetExtraStyle(self) -> long

Returns the extra style bits for the window.

GetFont(*args, **kwargs)

GetFont(self) -> Font

Returns the default font used for this window.

GetForegroundColour(*args, **kwargs)

GetForegroundColour(self) -> Colour

Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.

GetFullTextExtent(*args, **kwargs)

GetFullTextExtent(String string, Font font=None) ->
   (width, height, descent, externalLeading)

Get the width, height, decent and leading of the text using the
current or specified font.

GetGrandParent(*args, **kwargs)

GetGrandParent(self) -> Window

Returns the parent of the parent of this window, or None if there isn't one.

GetHandle(*args, **kwargs)

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.

GetHelpText(*args, **kwargs)

GetHelpText(self) -> String

Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wxHelpProvider implementation, and not in the window object itself.

GetId(*args, **kwargs)

GetId(self) -> int

Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.

GetLabel(*args, **kwargs)

GetLabel(self) -> String

Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.

GetMaxHeight(*args, **kwargs)

GetMaxHeight(self) -> int

GetMaxSize(*args, **kwargs)

GetMaxSize(self) -> Size

GetMaxWidth(*args, **kwargs)

GetMaxWidth(self) -> int

GetMinHeight(*args, **kwargs)

GetMinHeight(self) -> int

GetMinSize(*args, **kwargs)

GetMinSize(self) -> Size

GetMinWidth(*args, **kwargs)

GetMinWidth(self) -> int

GetName(*args, **kwargs)

GetName(self) -> String

Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.

GetParent(*args, **kwargs)

GetParent(self) -> Window

Returns the parent window of this window, or None if there isn't one.

GetPosition(*args, **kwargs)

GetPosition(self) -> Point

Get the window's position.

GetPositionTuple(*args, **kwargs)

GetPositionTuple() -> (x,y)

Get the window's position.

GetRect(*args, **kwargs)

GetRect(self) -> Rect

Returns the size and position of the window as a wx.Rect object.

GetScrollPos(*args, **kwargs)

GetScrollPos(self, int orientation) -> int

Returns the built-in scrollbar position.

GetScrollRange(*args, **kwargs)

GetScrollRange(self, int orientation) -> int

Returns the built-in scrollbar range.

GetScrollThumb(*args, **kwargs)

GetScrollThumb(self, int orientation) -> int

Returns the built-in scrollbar thumb size.

GetSize(*args, **kwargs)

GetSize(self) -> Size

Get the window size.

GetSizer(*args, **kwargs)

GetSizer(self) -> Sizer

Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one.

GetSizeTuple(*args, **kwargs)

GetSizeTuple() -> (width, height)

Get the window size.

GetTextExtent(*args, **kwargs)

GetTextExtent(String string) -> (width, height)

Get the width and height of the text using the current font.

GetThemeEnabled(*args, **kwargs)

GetThemeEnabled(self) -> bool

Return the themeEnabled flag.

GetTitle(*args, **kwargs)

GetTitle(self) -> String

Gets the window's title. Applicable only to frames and dialogs.

GetToolTip(*args, **kwargs)

GetToolTip(self) -> ToolTip

get the associated tooltip or None if none

GetUpdateClientRect(*args, **kwargs)

GetUpdateClientRect(self) -> Rect

Get the update rectangle region bounding box in client coords.

GetUpdateRegion(*args, **kwargs)

GetUpdateRegion(self) -> Region

Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.

GetValidator(*args, **kwargs)

GetValidator(self) -> Validator

Returns a pointer to the current validator for the window, or None if there is none.

GetVirtualSize(*args, **kwargs)

GetVirtualSize(self) -> Size

Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.

GetVirtualSizeTuple(*args, **kwargs)

GetVirtualSizeTuple() -> (width, height)

Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.

GetWindowStyle(*args, **kwargs)

GetWindowStyleFlag(self) -> long

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

GetWindowStyleFlag(*args, **kwargs)

GetWindowStyleFlag(self) -> long

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

GetWindowVariant(*args, **kwargs)

GetWindowVariant(self) -> int

HasCapture(*args, **kwargs)

HasCapture(self) -> bool

Returns true if this window has the current mouse capture.

HasFlag(*args, **kwargs)

HasFlag(self, int flag) -> bool

Test if the given style is set for this window.

HasScrollbar(*args, **kwargs)

HasScrollbar(self, int orient) -> bool

Does the window have the scrollbar for this orientation?

Hide(*args, **kwargs)

Hide(self) -> bool

Equivalent to calling Show(False).

HitTest(*args, **kwargs)

HitTest(self, Point pt) -> int

Test where the given (in client coords) point lies

HitTestXY(*args, **kwargs)

HitTestXY(self, int x, int y) -> int

Test where the given (in client coords) point lies

InheritAttributes(*args, **kwargs)

InheritAttributes(self)

This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.

By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might.

This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.

InitDialog(*args, **kwargs)

InitDialog(self)

Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.

InvalidateBestSize(*args, **kwargs)

InvalidateBestSize(self)

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

IsBeingDeleted(*args, **kwargs)

IsBeingDeleted(self) -> bool

Is the window in the process of being deleted?

IsEnabled(*args, **kwargs)

IsEnabled(self) -> bool

Returns true if the window is enabled for input, false otherwise.

IsExposed(*args, **kwargs)

IsExposed(self, int x, int y, int w=1, int h=1) -> bool

Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.

IsExposedPoint(*args, **kwargs)

IsExposedPoint(self, Point pt) -> bool

Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.

IsExposedRect(*args, **kwargs)

IsExposedRect(self, Rect rect) -> bool

Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.

IsRetained(*args, **kwargs)

IsRetained(self) -> bool

Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.

IsShown(*args, **kwargs)

IsShown(self) -> bool

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

IsTopLevel(*args, **kwargs)

IsTopLevel(self) -> bool

Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).

Layout(*args, **kwargs)

Layout(self) -> bool

Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.

LineDown(*args, **kwargs)

LineDown(self) -> bool

This is just a wrapper for ScrollLines(1).

LineUp(*args, **kwargs)

LineUp(self) -> bool

This is just a wrapper for ScrollLines(-1).

Lower(*args, **kwargs)

Lower(self)

Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog or frame).

MakeModal(*args, **kwargs)

MakeModal(self, bool modal=True)

Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.

Move(*args, **kwargs)

Move(self, Point pt, int flags=SIZE_USE_EXISTING)

Moves the window to the given position.

MoveAfterInTabOrder(*args, **kwargs)

MoveAfterInTabOrder(self, Window win)

Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window.

The default tab order is the same as creation order. This function and `MoveBeforeInTabOrder` allow to change it after creating all the windows.

MoveBeforeInTabOrder(*args, **kwargs)

MoveBeforeInTabOrder(self, Window win)

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

MoveXY(*args, **kwargs)

MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)

Moves the window to the given position.

Navigate(*args, **kwargs)

Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool

Does keyboard navigation from this window to another, by sending a `wx.NavigationKeyEvent`.

PageDown(*args, **kwargs)

PageDown(self) -> bool

This is just a wrapper for ScrollPages(1).

PageUp(*args, **kwargs)

PageUp(self) -> bool

This is just a wrapper for ScrollPages(-1).

PopEventHandler(*args, **kwargs)

PopEventHandler(self, bool deleteHandler=False) -> EvtHandler

Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped.

PopupMenu(*args, **kwargs)

PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.

PopupMenuXY(*args, **kwargs)

PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.

PostCreate(self, pre)

Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.

PrepareDC(*args, **kwargs)

PrepareDC(self, DC dc)

Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position.

PushEventHandler(*args, **kwargs)

PushEventHandler(self, EvtHandler handler)

Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. 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.

Raise(*args, **kwargs)

Raise(self)

Raises the window to the top of the window hierarchy if it is a managed window (dialog or frame).

Refresh(*args, **kwargs)

Refresh(self, bool eraseBackground=True, Rect rect=None)

Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window.

RefreshRect(*args, **kwargs)

RefreshRect(self, Rect rect)

Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax.

RegisterHotKey(*args, **kwargs)

RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool

Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.

ReleaseMouse(*args, **kwargs)

ReleaseMouse(self)

Releases mouse input captured with wx.Window.CaptureMouse.

RemoveChild(*args, **kwargs)

RemoveChild(self, Window child)

Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.

RemoveEventHandler(*args, **kwargs)

RemoveEventHandler(self, EvtHandler handler) -> bool

Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, return True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.)

Reparent(*args, **kwargs)

Reparent(self, Window newParent) -> bool

Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)

ScreenToClient(*args, **kwargs)

ScreenToClient(self, Point pt) -> Point

Converts from screen to client window coordinates.

ScreenToClientXY(*args, **kwargs)

ScreenToClientXY(int x, int y) -> (x,y)

Converts from screen to client window coordinates.

ScrollLines(*args, **kwargs)

ScrollLines(self, int lines) -> bool

If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.

ScrollPages(*args, **kwargs)

ScrollPages(self, int pages) -> bool

If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.

ScrollWindow(*args, **kwargs)

ScrollWindow(self, int dx, int dy, Rect rect=None)

Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program.

SetAcceleratorTable(*args, **kwargs)

SetAcceleratorTable(self, AcceleratorTable accel)

Sets the accelerator table for this window.

SetAutoLayout(*args, **kwargs)

SetAutoLayout(self, bool autoLayout)

Determines whether the Layout function will be called automatically when the window is resized. It is called implicitly by SetSizer but if you use SetConstraints you should call it manually or otherwise the window layout won't be correctly updated when its size changes.

SetBackgroundColour(*args, **kwargs)

SetBackgroundColour(self, Colour colour) -> bool

Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. Using `wx.NullColour` will reset the window to the default background colour.

Note that setting the background colour may not cause an immediate refresh, so you may wish to call `ClearBackground` or `Refresh` after calling this function.

Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.

SetBackgroundStyle(*args, **kwargs)

SetBackgroundStyle(self, int style) -> bool

Returns the background style of the window. The background style
indicates how the background of the window is drawn.

    ======================  ========================================
    wx.BG_STYLE_SYSTEM      The background colour or pattern should
                            be determined by the system
    wx.BG_STYLE_COLOUR      The background should be a solid colour
    wx.BG_STYLE_CUSTOM      The background will be implemented by the
                            application.
    ======================  ========================================

On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
a custom background, such as a tiled bitmap. Currently the style has
no effect on other platforms.

:see: `GetBackgroundStyle`, `SetBackgroundColour`

SetBestFittingSize(*args, **kwargs)

SetBestFittingSize(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.

SetCaret(*args, **kwargs)

SetCaret(self, Caret caret)

Sets the caret associated with the window.

SetClientRect(*args, **kwargs)

SetClientRect(self, Rect rect)

This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.

SetClientSize(*args, **kwargs)

SetClientSize(self, Size size)

This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.

SetClientSizeWH(*args, **kwargs)

SetClientSizeWH(self, int width, int height)

This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.

SetConstraints(*args, **kwargs)

SetConstraints(self, LayoutConstraints constraints)

Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints.

You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.

SetContainingSizer(*args, **kwargs)

SetContainingSizer(self, Sizer sizer)

This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.

SetCursor(*args, **kwargs)

SetCursor(self, Cursor cursor) -> bool

Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly.

The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.

SetDefaultItem(*args, **kwargs)

SetDefaultItem(self, Window child) -> Window

Set this child as default, return the old default.

SetDimensions(*args, **kwargs)

SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)

Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow dimensions of -1 and less to be interpreted as real dimensions, not default values.

SetDropTarget(*args, **kwargs)

SetDropTarget(self, DropTarget dropTarget)

Associates a drop target with this window. If the window already has a drop target, it is deleted.

SetEventHandler(*args, **kwargs)

SetEventHandler(self, EvtHandler handler)

Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.

It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event handler is handed to the next one in the chain.

SetExtraStyle(*args, **kwargs)

SetExtraStyle(self, long exStyle)

Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag()

SetFocus(*args, **kwargs)

SetFocus(self)

Set's the focus to this window, allowing it to receive keyboard input.

SetFocusFromKbd(*args, **kwargs)

SetFocusFromKbd(self)

Set focus to this window as the result of a keyboard action. Normally only called internally.

SetFont(*args, **kwargs)

SetFont(self, Font font) -> bool

Sets the font for this window.

SetForegroundColour(*args, **kwargs)

SetForegroundColour(self, Colour colour) -> bool

Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.

SetHelpText(*args, **kwargs)

SetHelpText(self, String text)

Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wxHelpProvider implementation, and not in the window object itself.

SetHelpTextForId(*args, **kwargs)

SetHelpTextForId(self, String text)

Associate this help text with all windows with the same id as this one.

SetId(*args, **kwargs)

SetId(self, int winid)

Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.

SetLabel(*args, **kwargs)

SetLabel(self, String label)

Set the text which the window shows in its label if applicable.

SetMaxSize(*args, **kwargs)

SetMaxSize(self, Size maxSize)

A more convenient method than `SetSizeHints` for setting just the max size.

SetMinSize(*args, **kwargs)

SetMinSize(self, Size minSize)

A more convenient method than `SetSizeHints` for setting just the min size.

SetName(*args, **kwargs)

SetName(self, String name)

Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label

SetOwnBackgroundColour(*args, **kwargs)

SetOwnBackgroundColour(self, Colour colour)

SetOwnFont(*args, **kwargs)

SetOwnFont(self, Font font)

SetOwnForegroundColour(*args, **kwargs)

SetOwnForegroundColour(self, Colour colour)

SetPosition(*args, **kwargs)

Move(self, Point pt, int flags=SIZE_USE_EXISTING)

Moves the window to the given position.

SetRect(*args, **kwargs)

SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)

Sets the position and size of the window in pixels using a wx.Rect.

SetScrollbar(*args, **kwargs)

SetScrollbar(self, int orientation, int position, int thumbSize, int range, 
    bool refresh=True)

Sets the scrollbar properties of a built-in scrollbar.

SetScrollPos(*args, **kwargs)

SetScrollPos(self, int orientation, int pos, bool refresh=True)

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

SetSize(*args, **kwargs)

SetSize(self, Size size)

Sets the size of the window in pixels.

SetSizeHints(*args, **kwargs)

SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, 
    int incH=-1)

Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), the
default values will be used.  If this function is called, the user
will not be able to size the window outside the given bounds (if it is
a top-level window.)  Sizers will also inspect the minimum window size
and will use that value if set when calculating layout.

The resizing increments are only significant under Motif or Xt.

SetSizeHintsSz(*args, **kwargs)

SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)

Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.

The resizing increments are only significant under Motif or Xt.

SetSizer(*args, **kwargs)

SetSizer(self, Sizer sizer, bool deleteOld=True)

Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise.

SetSizerAndFit(*args, **kwargs)

SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)

The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size.

SetSizeWH(*args, **kwargs)

SetSizeWH(self, int width, int height)

Sets the size of the window in pixels.

SetThemeEnabled(*args, **kwargs)

SetThemeEnabled(self, bool enableTheme)

This function tells a window if it should use the system's "theme"
 code to draw the windows' background instead if its own background
 drawing code. This will only have an effect on platforms that support
 the notion of themes in user defined windows. One such platform is
 GTK+ where windows can have (very colourful) backgrounds defined by a
 user's selected theme.

Dialogs, notebook pages and the status bar have this flag set to true
by default so that the default look and feel is simulated best.

SetTitle(*args, **kwargs)

SetTitle(self, String title)

Sets the window's title. Applicable only to frames and dialogs.

SetTmpDefaultItem(*args, **kwargs)

SetTmpDefaultItem(self, Window win)

Set this child as temporary default

SetToolTip(*args, **kwargs)

SetToolTip(self, ToolTip tip)

Attach a tooltip to the window.

SetToolTipString(*args, **kwargs)

SetToolTipString(self, String tip)

Attach a tooltip to the window.

SetValidator(*args, **kwargs)

SetValidator(self, Validator validator)

Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.

SetVirtualSize(*args, **kwargs)

SetVirtualSize(self, Size size)

Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.

SetVirtualSizeHints(*args, **kwargs)

SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)

Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the virtual area of the window outside the given bounds.

SetVirtualSizeHintsSz(*args, **kwargs)

SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)

Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the virtual area of the window outside the given bounds.

SetVirtualSizeWH(*args, **kwargs)

SetVirtualSizeWH(self, int w, int h)

Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.

SetWindowStyle(*args, **kwargs)

SetWindowStyleFlag(self, long style)

Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.

SetWindowStyleFlag(*args, **kwargs)

SetWindowStyleFlag(self, long style)

Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.

SetWindowVariant(*args, **kwargs)

SetWindowVariant(self, int variant)

Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.

ShouldInheritColours(*args, **kwargs)

ShouldInheritColours(self) -> bool

Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.

The base class version returns false, but this method is overridden in wxControl where it returns true.

Show(*args, **kwargs)

Show(self, bool show=True) -> bool

Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.

Thaw(*args, **kwargs)

Thaw(self)

Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.

TransferDataFromWindow(*args, **kwargs)

TransferDataFromWindow(self) -> bool

Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.

TransferDataToWindow(*args, **kwargs)

TransferDataToWindow(self) -> bool

Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.

UnregisterHotKey(*args, **kwargs)

UnregisterHotKey(self, int hotkeyId) -> bool

Unregisters a system wide hotkey.

Update(*args, **kwargs)

Update(self)

Calling this method immediately repaints the invalidated area of the window instead of waiting for the EVT_PAINT event to happen, (normally this would usually only happen when the flow of control returns to the event loop.) Notice that this function doesn't refresh the window and does nothing if the window has been already repainted. Use Refresh first if you want to immediately redraw the window (or some portion of it) unconditionally.

UpdateWindowUI(*args, **kwargs)

UpdateWindowUI(self, long flags=UPDATE_UI_NONE)

This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at a particular point in time (as far as your EVT_UPDATE_UI handlers are concerned). This may be necessary if you have called wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to limit the overhead that wxWindows incurs by sending update UI events in idle time.

Validate(*args, **kwargs)

Validate(self) -> bool

Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.

WarpPointer(*args, **kwargs)

WarpPointer(self, int x, int y)

Moves the pointer to the given position on the window.

NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.

Static Method Details

FindFocus(*args, **kwargs)

FindFocus() -> Window

Returns the window or control that currently has the keyboard focus, or None.

GetCapture(*args, **kwargs)

GetCapture() -> Window

Returns the window which currently captures the mouse or None

GetClassDefaultAttributes(*args, **kwargs)

GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes

Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.

The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See `wx.Window.SetWindowVariant` for more about this.

NewControlId(*args, **kwargs)

NewControlId() -> int

Generate a control id for the controls which were not given one.

NextControlId(*args, **kwargs)

NextControlId(int winid) -> int

Get the id of the control following the one with the given autogenerated) id

PrevControlId(*args, **kwargs)

PrevControlId(int winid) -> int

Get the id of the control preceding the one with the given autogenerated) id

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy wx._core.Window>                                        

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0xb6476d4c>       

Generated by Epydoc 2.1 on Fri Jun 24 12:01:19 2005 http://epydoc.sf.net