wx.Window Class Reference

Inheritance diagram for wx.Window:

wx.EvtHandler wx.Object wx.Control wx.Dialog wx.Frame wx.MDIClientWindow wx.Panel wx.SashWindow wx.SplashScreenWindow wx.SplitterWindow wx.StatusBar wx.TipWindow

List of all members.

Public Member Functions

virtual bool AcceptsFocus ()
virtual bool AcceptsFocusFromKeyboard ()
Border BorderByFlags (int flags)
void CacheBestSize (Size size)
virtual void CaptureMouse ()
void Center (Orientation direction)
void Center ()
void CenterOnParent (Orientation direction)
void CenterOnParent ()
void CenterOnScreen (Orientation direction)
void CenterOnScreen ()
void Centre (Orientation direction)
void Centre ()
void CentreOnParent (Orientation direction)
void CentreOnParent ()
void CentreOnScreen (Orientation direction)
void CentreOnScreen ()
virtual void ClearBackground ()
Point ClientToScreen (Point clientPoint)
void ClientToScreen (ref int x, ref int y)
bool Close (bool force)
bool Close ()
virtual Size ConvertDialogToPixels (Size sz)
virtual Point ConvertDialogToPixels (Point pt)
virtual Size ConvertPixelsToDialog (Size sz)
virtual Point ConvertPixelsToDialog (Point pt)
virtual bool Destroy ()
virtual bool DestroyChildren ()
virtual bool Disable ()
virtual Window FindWindow (wxString name)
virtual Window FindWindow (string name)
virtual Window FindWindow (int id, Type type)
virtual Window FindWindow (int id)
virtual void Fit ()
virtual void FitInside ()
virtual void Freeze ()
Window GetNextWindow ()
Window GetPreviousWindow ()
virtual int GetScrollPos (int orient)
virtual int GetScrollRange (int orient)
virtual int GetScrollThumb (int orient)
Size GetTextExtent (string str)
void GetTextExtent (string str, out int x, out int y, Font font)
void GetTextExtent (string str, out int x, out int y)
void GetTextExtent (wxString str, out int x, out int y, out int descent, out int externalLeading, Font font)
void GetTextExtent (string str, out int x, out int y, out int descent, out int externalLeading, Font font)
void GetTextExtent (string str, out int x, out int y, out int descent, out int externalLeading)
virtual bool HasCapture ()
virtual bool HasCustomPalette ()
virtual bool HasFlag (WindowStyles flag)
virtual bool HasScrollbar (int orient)
virtual bool Hide ()
virtual void InheritAttributes ()
void InvalidateBestSize ()
bool IsBeingDeleted ()
bool IsEnabled ()
virtual bool IsExposed (int x, int y, int w, int h)
void Layout ()
virtual bool LineDown ()
virtual bool LineUp ()
virtual void Lower ()
virtual void Move (int x, int y, int flags)
virtual bool PageDown ()
virtual bool PageUp ()
EvtHandler PopEventHandler (bool deleteHandler)
virtual bool PopupMenu (Menu menu, Point pos)
bool PopupMenu (Menu menu)
virtual void PrepareDC (DC dc)
void PushEventHandler (EvtHandler handler)
virtual void Raise ()
virtual void Refresh (bool eraseBackground, Rectangle rect)
virtual void Refresh ()
virtual void RefreshRectangle (Rectangle rect)
virtual void ReleaseMouse ()
bool RemoveEventHandler (EvtHandler handler)
virtual bool Reparent (Window newParent)
Point ScreenToClient (Point screenPoint)
virtual void ScreenToClient (ref int x, ref int y)
virtual bool ScrollLines (int lines)
virtual bool ScrollPages (int pages)
virtual void ScrollWindow (int dx, int dy, Rectangle rect)
virtual void SetFocus ()
virtual void SetFocusFromKbd ()
virtual void SetHelpTextForId (string text)
virtual void SetScrollbar (int orient, int pos, int thumbSize, int range, bool refresh)
virtual void SetScrollPos (int orient, int pos, bool refresh)
void SetSize (Size size)
void SetSize (int width, int height)
void SetSize (int x, int y, int width, int height)
virtual void SetSizeHints (int minW, int minH, int maxW, int maxH, int incW, int incH)
virtual void SetSizeHints (int minW, int minH, int maxW, int maxH)
virtual void SetSizeHints (int minW, int minH)
void SetSizer (Sizer sizer, bool deleteOld)
void SetSizer (Sizer sizer)
virtual void SetSizerAndFit (Sizer sizer, bool deleteOld)
virtual void SetSizerAndFit (Sizer sizer)
virtual void SetVirtualSizeHints (int minW, int minH, int maxW, int maxH)
virtual bool ShouldInheritColours ()
bool Show (bool show)
bool Show ()
virtual void Thaw ()
virtual void Update ()
virtual void UpdateWindowUI ()
delegate void Validator (ref bool accepted)
virtual void WarpPointer (int x, int y)
 Window (IntPtr wxObject)
 Window (Window parent, Point pos, Size size, WindowStyles style, string name)
 Window (Window parent, int id, Point pos, Size size, wx.WindowStyles style, wxString name)
 Window (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
 Window (Window parent)

Static Public Member Functions

static VisualAttributes ClassDefaultAttributes (WindowVariant variant)
static VisualAttributes ClassDefaultAttributes ()
static Window FindFocus ()
static Window FindWindowById (int id, Window parent)
static Window FindWindowByLabel (wxString label, Window parent)
static Window FindWindowByLabel (string label, Window parent)
static Window FindWindowByName (wxString name, Window parent)
static Window FindWindowByName (string name, Window parent)
static Window GetCapture ()
static int GetNumberFromUser (wxString msg, wxString prompt, wxString caption, int value, int min, int max, Window parent, Point pos)
static int GetNumberFromUser (string msg, string prompt, string caption, int value, int min, int max, Window parent, Point pos)
static int GetNumberFromUser (string msg, string prompt, string caption, int value, int min, int max, Window parent)
static int GetNumberFromUser (string msg, string prompt, string caption, int value, int min, int max)
static int GetNumberFromUser (string msg, string prompt, string caption, int value, int min)
static int GetNumberFromUser (string msg, string prompt, string caption, int value)
static int NewControlId ()
static int NextControlId (int id)
static int PrevControlId (int id)

Public Attributes

event Validator OnTransferDataFromWindow
const int wxFRAME_EX_CONTEXTHELP = 0x00000004
const int wxID_ABOUT = 5013
const int wxID_ANY = -1
const int wxID_CANCEL = 5101
const int wxID_NO = 5104
const int wxID_OK = 5100
const int wxID_YES = 5103

Static Public Attributes

static readonly int wxDefaultCoord = -1
static readonly Point wxDefaultPosition = new Point(-1, -1)
static readonly Size wxDefaultSize = new Size(-1, -1)

Protected Member Functions

override void Dispose (bool disposing)

Properties

AcceleratorTable AcceleratorTable [get, set]
virtual Size AdjustedBestSize [get]
Window AncestorWithCustomPalette [get]
virtual bool AutoLayout [get, set]
virtual Colour BackgroundColour [get, set]
BackgroundStyle BackgroundStyle [get, set]
Size BestFittingSize [get, set]
virtual Size BestSize [get]
virtual Size BestVirtualSize [get]
Border Border [get]
virtual int Bottom [get, set]
virtual Caret Caret [get, set]
virtual int CharHeight [get]
virtual int CharWidth [get]
Window[] Children [get]
virtual Point ClientAreaOrigin [get]
virtual Rectangle ClientRect [get]
Size ClientSize [get, set]
virtual Sizer ContainingSizer [get, set]
Cursor Cursor [set]
virtual VisualAttributes DefaultAttributes [get]
virtual DropTarget DropTarget [get, set]
virtual bool Enabled [get, set]
EvtHandler EventHandler [get, set]
virtual uint ExtraStyle [get, set]
virtual Font Font [get, set]
virtual Colour ForegroundColour [get, set]
virtual Window GrandParent [get]
virtual int Height [get, set]
virtual string HelpText [get, set]
int ID [get, set]
virtual bool IsRetained [get]
virtual bool IsShown [get]
virtual bool IsTopLevel [get]
virtual int Left [get, set]
virtual int MaxHeight [get]
Size MaxSize [get, set]
virtual int MaxWidth [get]
virtual int MinHeight [get, set]
Size MinSize [get, set]
virtual int MinWidth [get, set]
virtual string Name [get, set]
virtual Palette Palette [get, set]
virtual Window Parent [get, set]
virtual Point Position [get, set]
virtual Rectangle Rect [get]
virtual int Right [get, set]
virtual Size Size [get, set]
virtual Sizer Sizer [get, set]
virtual WindowStyles StyleFlags [get, set]
bool ThemeEnabled [get, set]
virtual string Title [get, set]
virtual string ToolTip [get, set]
virtual int Top [get, set]
static int UniqueID [get]
virtual Region UpdateRegion [get]
virtual Size VirtualSize [get, set]
virtual int Width [get, set]
virtual wx.WindowStyles WindowStyle [get, set]
WindowVariant WindowVariant [get, set]

Events

event EventListener Activated [add, remove]
event EventListener Char [add, remove]
event EventListener Closing [add, remove]
virtual event
EventListener 
KeyDown [add, remove]
event EventListener KeyUp [add, remove]
event EventListener LeftDoubleClick [add, remove]
event EventListener LeftDown [add, remove]
event EventListener LeftUp [add, remove]
event EventListener MiddleDoubleClick [add, remove]
event EventListener MiddleDown [add, remove]
event EventListener MiddleUp [add, remove]
event EventListener MouseEnter [add, remove]
event EventListener MouseLeave [add, remove]
event EventListener MouseMove [add, remove]
event EventListener MouseThumbTrack [add, remove]
event EventListener Moved [add, remove]
event EventListener Resized [add, remove]
event EventListener RightDoubleClick [add, remove]
event EventListener RightDown [add, remove]
event EventListener RightUp [add, remove]
event EventListener ScrollLineDown [add, remove]
event EventListener ScrollLineUp [add, remove]
virtual event
EventListener 
UpdateUI [add, remove]


Detailed Description

Window is the base class for all windows and represents any visible object on screen. All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves. Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually.

Constructor & Destructor Documentation

wx.Window.Window ( Window  parent  ) 

wx.Window.Window ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style,
string  name 
)

wx.Window.Window ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style,
wxString  name 
)

wx.Window.Window ( Window  parent,
Point  pos,
Size  size,
WindowStyles  style,
string  name 
)

wx.Window.Window ( IntPtr  wxObject  ) 


Member Function Documentation

virtual bool wx.Window.AcceptsFocus (  )  [virtual]

Reimplemented in wx.Gauge, and wx.ToolBar.

virtual bool wx.Window.AcceptsFocusFromKeyboard (  )  [virtual]

Reimplemented in wx.Html.HtmlWindow.

Border wx.Window.BorderByFlags ( int  flags  ) 

void wx.Window.CacheBestSize ( Size  size  ) 

virtual void wx.Window.CaptureMouse (  )  [virtual]

void wx.Window.Center ( Orientation  direction  ) 

void wx.Window.Center (  ) 

void wx.Window.CenterOnParent ( Orientation  direction  ) 

Centres the window on its parent. This is a more readable synonym for Centre. This methods provides for a way to center top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as wx.Window.Centre().

Parameters:
direction Specifies the direction for the centering. May be Orientation.wxHORIZONTAL, Orientation.wxVERTICAL or Orientation.wxBOTH.

void wx.Window.CenterOnParent (  ) 

Centres the window on its parent. This is a more readable synonym for Centre. This methods provides for a way to center top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as wx.Window.Centre().

void wx.Window.CenterOnScreen ( Orientation  direction  ) 

void wx.Window.CenterOnScreen (  ) 

void wx.Window.Centre ( Orientation  direction  ) 

void wx.Window.Centre (  ) 

void wx.Window.CentreOnParent ( Orientation  direction  ) 

Centres the window on its parent. This is a more readable synonym for Centre. This methods provides for a way to center top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as wx.Window.Centre().

Parameters:
direction Specifies the direction for the centering. May be Orientation.wxHORIZONTAL, Orientation.wxVERTICAL or Orientation.wxBOTH.

void wx.Window.CentreOnParent (  ) 

Centres the window on its parent. This is a more readable synonym for Centre. This methods provides for a way to center top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as wx.Window.Centre().

void wx.Window.CentreOnScreen ( Orientation  direction  ) 

void wx.Window.CentreOnScreen (  ) 

static VisualAttributes wx.Window.ClassDefaultAttributes ( WindowVariant  variant  )  [static]

static VisualAttributes wx.Window.ClassDefaultAttributes (  )  [static]

virtual void wx.Window.ClearBackground (  )  [virtual]

Point wx.Window.ClientToScreen ( Point  clientPoint  ) 

void wx.Window.ClientToScreen ( ref int  x,
ref int  y 
)

bool wx.Window.Close ( bool  force  ) 

This will create a wx.CloseEvent but handlers are not allowed to veto if force is true. Try wx.Utils.Exit() if you want the application to be exited. Otherwise, the application will exit automatically, if all top level windows are closed.

Refer also to Close().

bool wx.Window.Close (  ) 

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows (wx.Frame and wx.Dialog classes) as the others are not supposed to have any special OnClose() logic.

The close handler should check whether the window is being deleted forcibly, using wx.CloseEvent.CanVeto, in which case it should destroy the window using wx.Window.Destroy().

Note that calling Close() does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of wx.Dialog.OnCloseWindow() does not necessarily delete the dialog, since it will simply simulate an wxID_CANCEL event which is handled by the appropriate button event handler and may do anything at all.

To guarantee that the window will be destroyed, call wx.Window.Destroy instead.

virtual Size wx.Window.ConvertDialogToPixels ( Size  sz  )  [virtual]

virtual Point wx.Window.ConvertDialogToPixels ( Point  pt  )  [virtual]

virtual Size wx.Window.ConvertPixelsToDialog ( Size  sz  )  [virtual]

virtual Point wx.Window.ConvertPixelsToDialog ( Point  pt  )  [virtual]

virtual bool wx.Window.Destroy (  )  [virtual]

Destroy the window. Call this only is you do not want to show it again.

virtual bool wx.Window.DestroyChildren (  )  [virtual]

Destroy the window's children. Call this only is you do not want to show them again.

virtual bool wx.Window.Disable (  )  [virtual]

override void wx.Window.Dispose ( bool  disposing  )  [protected, virtual]

Overriden disposition. Even if we do not own the memory, we have to delete the window, since this is apparently intended by the user calling this method.

Reimplemented from wx.Object.

Reimplemented in wx.CalendarCtrl.

static Window wx.Window.FindFocus (  )  [static]

virtual Window wx.Window.FindWindow ( wxString  name  )  [virtual]

virtual Window wx.Window.FindWindow ( string  name  )  [virtual]

virtual Window wx.Window.FindWindow ( int  id,
Type  type 
) [virtual]

This will find the window of the provided id and or create one of class type.

virtual Window wx.Window.FindWindow ( int  id  )  [virtual]

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

Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code.

Parameters:
child Child window to add.

static Window wx.Window.FindWindowById ( int  id,
Window  parent 
) [static]

static Window wx.Window.FindWindowByLabel ( wxString  label,
Window  parent 
) [static]

static Window wx.Window.FindWindowByLabel ( string  label,
Window  parent 
) [static]

static Window wx.Window.FindWindowByName ( wxString  name,
Window  parent 
) [static]

static Window wx.Window.FindWindowByName ( string  name,
Window  parent 
) [static]

virtual void wx.Window.Fit (  )  [virtual]

virtual void wx.Window.FitInside (  )  [virtual]

virtual void wx.Window.Freeze (  )  [virtual]

Reimplemented in wx.TextCtrl.

static Window wx.Window.GetCapture (  )  [static]

Window wx.Window.GetNextWindow (  ) 

Get the next Window in the TAB order of the parent. This may be null if either this does not have a parent or the parent only has one child.

static int wx.Window.GetNumberFromUser ( wxString  msg,
wxString  prompt,
wxString  caption,
int  value,
int  min,
int  max,
Window  parent,
Point  pos 
) [static]

static int wx.Window.GetNumberFromUser ( string  msg,
string  prompt,
string  caption,
int  value,
int  min,
int  max,
Window  parent,
Point  pos 
) [static]

static int wx.Window.GetNumberFromUser ( string  msg,
string  prompt,
string  caption,
int  value,
int  min,
int  max,
Window  parent 
) [static]

static int wx.Window.GetNumberFromUser ( string  msg,
string  prompt,
string  caption,
int  value,
int  min,
int  max 
) [static]

static int wx.Window.GetNumberFromUser ( string  msg,
string  prompt,
string  caption,
int  value,
int  min 
) [static]

static int wx.Window.GetNumberFromUser ( string  msg,
string  prompt,
string  caption,
int  value 
) [static]

Window wx.Window.GetPreviousWindow (  ) 

Get the previous Window in the TAB order of the parent. This may be null if either this does not have a parent or the parent only has one child.

virtual int wx.Window.GetScrollPos ( int  orient  )  [virtual]

virtual int wx.Window.GetScrollRange ( int  orient  )  [virtual]

virtual int wx.Window.GetScrollThumb ( int  orient  )  [virtual]

Size wx.Window.GetTextExtent ( string  str  ) 

void wx.Window.GetTextExtent ( string  str,
out int  x,
out int  y,
Font  font 
)

void wx.Window.GetTextExtent ( string  str,
out int  x,
out int  y 
)

void wx.Window.GetTextExtent ( wxString  str,
out int  x,
out int  y,
out int  descent,
out int  externalLeading,
Font  font 
)

void wx.Window.GetTextExtent ( string  str,
out int  x,
out int  y,
out int  descent,
out int  externalLeading,
Font  font 
)

void wx.Window.GetTextExtent ( string  str,
out int  x,
out int  y,
out int  descent,
out int  externalLeading 
)

virtual bool wx.Window.HasCapture (  )  [virtual]

virtual bool wx.Window.HasCustomPalette (  )  [virtual]

virtual bool wx.Window.HasFlag ( WindowStyles  flag  )  [virtual]

True if the designated style flag has been set for this window.

virtual bool wx.Window.HasScrollbar ( int  orient  )  [virtual]

virtual bool wx.Window.Hide (  )  [virtual]

virtual void wx.Window.InheritAttributes (  )  [virtual]

void wx.Window.InvalidateBestSize (  ) 

bool wx.Window.IsBeingDeleted (  ) 

bool wx.Window.IsEnabled (  ) 

Returns true iff enabled.

virtual bool wx.Window.IsExposed ( int  x,
int  y,
int  w,
int  h 
) [virtual]

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.

void wx.Window.Layout (  ) 

virtual bool wx.Window.LineDown (  )  [virtual]

virtual bool wx.Window.LineUp (  )  [virtual]

virtual void wx.Window.Lower (  )  [virtual]

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

See also:
Raise

virtual void wx.Window.Move ( int  x,
int  y,
int  flags 
) [virtual]

static int wx.Window.NewControlId (  )  [static]

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

wx.NET provides property wx.Window.UniqueID to generate unqie IDs which are appropriate to designate windows.

static int wx.Window.NextControlId ( int  id  )  [static]

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

virtual bool wx.Window.PageDown (  )  [virtual]

virtual bool wx.Window.PageUp (  )  [virtual]

EvtHandler wx.Window.PopEventHandler ( bool  deleteHandler  ) 

cf. PushEventHandler().

virtual bool wx.Window.PopupMenu ( Menu  menu,
Point  pos 
) [virtual]

bool wx.Window.PopupMenu ( Menu  menu  ) 

virtual void wx.Window.PrepareDC ( DC  dc  )  [virtual]

This prepares the argument for drawing.

Reimplemented in wx.ScrolledWindow.

static int wx.Window.PrevControlId ( int  id  )  [static]

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

void wx.Window.PushEventHandler ( EvtHandler  handler  ) 

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

Parameters:
handler Specifies the handler to be pushed. 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.

virtual void wx.Window.Raise (  )  [virtual]

Raises the window to the top of the window hierarchy (z-order). In current version of wxWidgets this works both for managed and child windows.

See also:
Lower

virtual void wx.Window.Refresh ( bool  eraseBackground,
Rectangle  rect 
) [virtual]

virtual void wx.Window.Refresh (  )  [virtual]

virtual void wx.Window.RefreshRectangle ( Rectangle  rect  )  [virtual]

virtual void wx.Window.ReleaseMouse (  )  [virtual]

bool wx.Window.RemoveEventHandler ( EvtHandler  handler  ) 

virtual bool wx.Window.Reparent ( Window  newParent  )  [virtual]

Point wx.Window.ScreenToClient ( Point  screenPoint  ) 

virtual void wx.Window.ScreenToClient ( ref int  x,
ref int  y 
) [virtual]

virtual bool wx.Window.ScrollLines ( int  lines  )  [virtual]

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

Parameters:
lines Number of lines to scroll down (positive) or up (negative)
Returns:
Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.

Reimplemented in wx.TextCtrl, and wx.VScrolledWindow.

virtual bool wx.Window.ScrollPages ( int  pages  )  [virtual]

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

Parameters:
pages Number of pages to scroll down (positive) or up.
Returns:
This function is currently only implemented under MSW and wxGTK.

Reimplemented in wx.TextCtrl, and wx.VScrolledWindow.

virtual void wx.Window.ScrollWindow ( int  dx,
int  dy,
Rectangle  rect 
) [virtual]

virtual void wx.Window.SetFocus (  )  [virtual]

This sets the window to receive keyboard input. Please note, that this method cannot be overridden from any class. Currently, inheritors of wx.Panel and wx.Dialog can override this.

Reimplemented in wx.Panel.

virtual void wx.Window.SetFocusFromKbd (  )  [virtual]

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key). By default this method simply calls SetFocus but can be overridden to do something in addition to this in the derived classes. Please note, that this method cannot be overridden from any class. Currently, inheritors of wx.Panel and wx.Dialog can override this.

Reimplemented in wx.Panel.

virtual void wx.Window.SetHelpTextForId ( string  text  )  [virtual]

virtual void wx.Window.SetScrollbar ( int  orient,
int  pos,
int  thumbSize,
int  range,
bool  refresh 
) [virtual]

Reimplemented in wx.ScrollBar.

virtual void wx.Window.SetScrollPos ( int  orient,
int  pos,
bool  refresh 
) [virtual]

void wx.Window.SetSize ( Size  size  ) 

void wx.Window.SetSize ( int  width,
int  height 
)

void wx.Window.SetSize ( int  x,
int  y,
int  width,
int  height 
)

virtual void wx.Window.SetSizeHints ( int  minW,
int  minH,
int  maxW,
int  maxH,
int  incW,
int  incH 
) [virtual]

virtual void wx.Window.SetSizeHints ( int  minW,
int  minH,
int  maxW,
int  maxH 
) [virtual]

virtual void wx.Window.SetSizeHints ( int  minW,
int  minH 
) [virtual]

void wx.Window.SetSizer ( Sizer  sizer,
bool  deleteOld 
)

void wx.Window.SetSizer ( Sizer  sizer  ) 

virtual void wx.Window.SetSizerAndFit ( Sizer  sizer,
bool  deleteOld 
) [virtual]

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

Parameters:
sizer The new sizer to use.
deleteOld Default is true
See also:
Sizer

virtual void wx.Window.SetSizerAndFit ( Sizer  sizer  )  [virtual]

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

Parameters:
sizer The new sizer to use.
See also:
Sizer

virtual void wx.Window.SetVirtualSizeHints ( int  minW,
int  minH,
int  maxW,
int  maxH 
) [virtual]

virtual bool wx.Window.ShouldInheritColours (  )  [virtual]

Reimplemented in wx.ControlWithItems.

bool wx.Window.Show ( bool  show  ) 

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.

Parameters:
show If true displays the window. Otherwise, hides it.
Returns:
true if the window has been shown or hidden or false if nothing was done because it already was in the requested state.
See also:
IsShown, Hide, Raise

bool wx.Window.Show (  ) 

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.
See also:
IsShown, Hide, Raise

virtual void wx.Window.Thaw (  )  [virtual]

Reimplemented in wx.TextCtrl.

virtual void wx.Window.Update (  )  [virtual]

virtual void wx.Window.UpdateWindowUI (  )  [virtual]

delegate void wx.Window.Validator ( ref bool  accepted  ) 

Simply a delegator for validation. Asign false to the argument if you want to indicate

virtual void wx.Window.WarpPointer ( int  x,
int  y 
) [virtual]


Member Data Documentation

event Validator wx.Window.OnTransferDataFromWindow

This will be called on wxWindowTransferDataFromWindow. This is the right place for validation.

readonly int wx.Window.wxDefaultCoord = -1 [static]

Default coordinate. Use this when you are allowed to provide a coordinate but you do not want to provide information on a particular coordinate.

readonly Point wx.Window.wxDefaultPosition = new Point(-1, -1) [static]

Default position. Use this when you are allowed to provide a position but you do not want to provide a particular position.

readonly Size wx.Window.wxDefaultSize = new Size(-1, -1) [static]

Default size. Use this when you are allowed to provide a size but you do not want to specify a particular size.

const int wx.Window.wxFRAME_EX_CONTEXTHELP = 0x00000004

const int wx.Window.wxID_ABOUT = 5013

const int wx.Window.wxID_ANY = -1

const int wx.Window.wxID_CANCEL = 5101

const int wx.Window.wxID_NO = 5104

const int wx.Window.wxID_OK = 5100

const int wx.Window.wxID_YES = 5103


Property Documentation

AcceleratorTable wx.Window.AcceleratorTable [get, set]

The accelerator table that is associated to this window.

virtual Size wx.Window.AdjustedBestSize [get]

Window wx.Window.AncestorWithCustomPalette [get]

virtual bool wx.Window.AutoLayout [get, set]

virtual Colour wx.Window.BackgroundColour [get, set]

Reimplemented in wx.TextCtrl.

BackgroundStyle wx.Window.BackgroundStyle [get, set]

Returns or defines the background mode of the window. The background style indicates whether background colour should be determined by the system (wxBG_STYLE_SYSTEM), be set to a specific colour (wxBG_STYLE_COLOUR), or should be left to the application to implement (wxBG_STYLE_CUSTOM).

On GTK+, use of wxBG_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.

Size wx.Window.BestFittingSize [get, set]

virtual Size wx.Window.BestSize [get]

virtual Size wx.Window.BestVirtualSize [get]

Border wx.Window.Border [get]

virtual int wx.Window.Bottom [get, set]

virtual Caret wx.Window.Caret [get, set]

virtual int wx.Window.CharHeight [get]

virtual int wx.Window.CharWidth [get]

Window [] wx.Window.Children [get]

The children of this window in an array.

virtual Point wx.Window.ClientAreaOrigin [get]

Reimplemented in wx.Frame.

virtual Rectangle wx.Window.ClientRect [get]

Size wx.Window.ClientSize [get, set]

virtual Sizer wx.Window.ContainingSizer [get, set]

Cursor wx.Window.Cursor [set]

virtual VisualAttributes wx.Window.DefaultAttributes [get]

virtual DropTarget wx.Window.DropTarget [get, set]

virtual bool wx.Window.Enabled [get, set]

Enable or disable cf. read whether enabled or disabled.

Reimplemented in wx.ComboCtrl.

EvtHandler wx.Window.EventHandler [get, set]

virtual uint wx.Window.ExtraStyle [get, set]

virtual Font wx.Window.Font [get, set]

Reimplemented in wx.ComboCtrl.

virtual Colour wx.Window.ForegroundColour [get, set]

Reimplemented in wx.TextCtrl.

virtual Window wx.Window.GrandParent [get]

virtual int wx.Window.Height [get, set]

virtual string wx.Window.HelpText [get, set]

int wx.Window.ID [get, set]

virtual bool wx.Window.IsRetained [get]

virtual bool wx.Window.IsShown [get]

virtual bool wx.Window.IsTopLevel [get]

virtual int wx.Window.Left [get, set]

virtual int wx.Window.MaxHeight [get]

Size wx.Window.MaxSize [get, set]

Read and set the maximum size of the window. This should be set after changing the size for instance after construction and before adding this to tha parent sizer. However, you should consider to set size hints instead of using this method.

virtual int wx.Window.MaxWidth [get]

This is a read-only property. Use wx.Window.MaxSize to change this.

virtual int wx.Window.MinHeight [get, set]

Get or set the minimal height of the window.

Reimplemented in wx.StatusBar.

Size wx.Window.MinSize [get, set]

Read and set the minimum size of the window. This should be set after changing the size for instance after construction and before adding this to tha parent sizer. However, you should consider to set size hints instead of using this method.

virtual int wx.Window.MinWidth [get, set]

Get or set the minimal width of the window.

virtual string wx.Window.Name [get, set]

virtual Palette wx.Window.Palette [get, set]

virtual Window wx.Window.Parent [get, set]

Reimplemented in wx.Html.HtmlFindDialog.

virtual Point wx.Window.Position [get, set]

virtual Rectangle wx.Window.Rect [get]

virtual int wx.Window.Right [get, set]

virtual Size wx.Window.Size [get, set]

virtual Sizer wx.Window.Sizer [get, set]

The sizer of this window (if defined). Assign to this property to specify a dynamic layout providing a sizer.

virtual WindowStyles wx.Window.StyleFlags [get, set]

This will set or get the styles flags that define this window.

bool wx.Window.ThemeEnabled [get, set]

virtual string wx.Window.Title [get, set]

Reimplemented in wx.Dialog.

virtual string wx.Window.ToolTip [get, set]

virtual int wx.Window.Top [get, set]

int wx.Window.UniqueID [static, get]

This always returns a unique ID that is appropriate to denote windows.

virtual Region wx.Window.UpdateRegion [get]

virtual Size wx.Window.VirtualSize [get, set]

virtual int wx.Window.Width [get, set]

virtual wx.WindowStyles wx.Window.WindowStyle [get, set]

WindowVariant wx.Window.WindowVariant [get, set]


Event Documentation

event EventListener wx.Window.Activated [add, remove]

Adds a listener to the wx.Event.wxEVT_ACTIVATE.

event EventListener wx.Window.Char [add, remove]

Adds a listener to the wx.Event.wxEVT_CHAR.

event EventListener wx.Window.Closing [add, remove]

Adds a listener to the wx.Event.wxEVT_CLOSE_WINDOW.

virtual event EventListener wx.Window.KeyDown [add, remove]

Adds a listener to the wx.Event.wxEVT_KEY_DOWN.

Reimplemented in wx.ListCtrl, and wx.TreeCtrl.

event EventListener wx.Window.KeyUp [add, remove]

Adds a listener to the wx.Event.wxEVT_KEY_UP.

event EventListener wx.Window.LeftDoubleClick [add, remove]

Adds a listener to the wx.Event.wxEVT_LEFT_DCLICK.

event EventListener wx.Window.LeftDown [add, remove]

Adds a listener to the wx.Event.wxEVT_LEFT_DOWN.

event EventListener wx.Window.LeftUp [add, remove]

Adds a listener to the wx.Event.wxEVT_LEFT_UP.

event EventListener wx.Window.MiddleDoubleClick [add, remove]

Adds a listener to the wx.Event.wxEVT_MIDDLE_DCLICK.

event EventListener wx.Window.MiddleDown [add, remove]

Adds a listener to the wx.Event.wxEVT_MIDDLE_DOWN.

event EventListener wx.Window.MiddleUp [add, remove]

Adds a listener to the wx.Event.wxEVT_MIDDLE_UP.

event EventListener wx.Window.MouseEnter [add, remove]

Adds a listener to the wx.Event.wxEVT_ENTER_WINDOW.

event EventListener wx.Window.MouseLeave [add, remove]

Adds a listener to the wx.Event.wxEVT_LEAVE_WINDOW.

event EventListener wx.Window.MouseMove [add, remove]

Adds a listener to the wx.Event.wxEVT_MOTION.

event EventListener wx.Window.MouseThumbTrack [add, remove]

Adds a listener to the wx.Event.wxEVT_SCROLL_THUMBTRACK.

event EventListener wx.Window.Moved [add, remove]

Adds a listener to the wx.Event.wxEVT_MOVE.

event EventListener wx.Window.Resized [add, remove]

Adds a listener to the wx.Event.wxEVT_SIZE.

event EventListener wx.Window.RightDoubleClick [add, remove]

Adds a listener to the wx.Event.wxEVT_RIGHT_DCLICK.

event EventListener wx.Window.RightDown [add, remove]

Adds a listener to the wx.Event.wxEVT_RIGHT_DOWN.

event EventListener wx.Window.RightUp [add, remove]

Adds a listener to the wx.Event.wxEVT_RIGHT_UP.

event EventListener wx.Window.ScrollLineDown [add, remove]

Adds a listener to the wx.Event.wxEVT_SCROLL_LINEDOWN.

event EventListener wx.Window.ScrollLineUp [add, remove]

Adds a listener to the wx.Event.wxEVT_SCROLL_LINEUP.

virtual event EventListener wx.Window.UpdateUI [add, remove]

Adds a listener to the wx.Event.wxEVT_UPDATE_UI.

Reimplemented in wx.Slider, wx.SpinCtrl, and wx.TextCtrl.


Manual of the wx.NET   (c) 2003-2009 the wx.NET project