1 \section{\class{wxWindow
}}\label{wxwindow
}
3 wxWindow is the base class for all windows. Any children of the window will be deleted
4 automatically by the destructor before the window itself is deleted.
6 Please note that we documented a number of handler functions (OnChar(), OnMouse() etc.) in this
7 help text. These must not be called by a user program and are documented only for illustration.
8 On several platforms, only a few of these handlers are actually written (they are not always
9 needed) and if you are uncertain on how to add a certain behaviour to a window class, intercept
10 the respective event as usual and call
\helpref{wxEvent::Skip
}{wxeventskip
} so that the native
11 platform can implement its native behaviour or just ignore the event if nothing needs to be
14 \wxheading{Derived from
}
16 \helpref{wxEvtHandler
}{wxevthandler
}\\
17 \helpref{wxObject
}{wxobject
}
19 \wxheading{Include files
}
23 \wxheading{Window styles
}
25 The following styles can apply to all windows, although they will not always make sense for a particular
26 window class or on all platforms.
29 \begin{twocollist
}\itemsep=
0pt
30 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
32 \twocolitem{\windowstyle{wxDOUBLE
\_BORDER}}{Displays a double border. Windows only.
}
33 \twocolitem{\windowstyle{wxSUNKEN
\_BORDER}}{Displays a sunken border.
}
34 \twocolitem{\windowstyle{wxRAISED
\_BORDER}}{Displays a raised border. GTK only.
}
35 \twocolitem{\windowstyle{wxSTATIC
\_BORDER}}{Displays a border suitable for a static control. Windows only.
}
36 \twocolitem{\windowstyle{wxTRANSPARENT
\_WINDOW}}{The window is transparent, that is, it will not receive paint
37 events. Windows only.
}
38 \twocolitem{\windowstyle{wxNO
\_3D}}{Prevents the children of this window taking on
3D styles, even though
39 the application-wide policy is for
3D controls. Windows only.
}
40 \twocolitem{\windowstyle{wxTAB
\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.
}
41 \twocolitem{\windowstyle{wxWANTS
\_CHARS}}{Use this to indicate that the window
42 wants to get all char events - even for keys like TAB or ENTER which are
43 usually used for dialog navigation and which wouldn't be generated without
45 \twocolitem{\windowstyle{wxNO
\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting
46 the window completely when its size is changed - you will have to repaint the
47 new window area manually if you use this style. Currently only has an effect for
49 \twocolitem{\windowstyle{wxVSCROLL
}}{Use this style to enable a vertical scrollbar. (Still used?)
}
50 \twocolitem{\windowstyle{wxHSCROLL
}}{Use this style to enable a horizontal scrollbar. (Still used?)
}
51 \twocolitem{\windowstyle{wxCLIP
\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
52 repainted, then children being painted over them. Windows only.
}
55 See also
\helpref{window styles overview
}{windowstyles
}.
59 \helpref{Event handling overview
}{eventhandlingoverview
}
61 \latexignore{\rtfignore{\wxheading{Members
}}}
63 \membersection{wxWindow::wxWindow
}\label{wxwindowctor
}
65 \func{}{wxWindow
}{\void}
69 \func{}{wxWindow
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
70 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
71 \param{const wxSize\&
}{size = wxDefaultSize
},
72 \param{long
}{style =
0},
73 \param{const wxString\&
}{name = wxPanelNameStr
}}
75 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
77 \wxheading{Parameters
}
79 \docparam{parent
}{Pointer to a parent window.
}
81 \docparam{id
}{Window identifier. If -
1, will automatically create an identifier.
}
83 \docparam{pos
}{Window position. wxDefaultPosition is (-
1, -
1) which indicates that wxWindows
84 should generate a default position for the window. If using the wxWindow class directly, supply
87 \docparam{size
}{Window size. wxDefaultSize is (-
1, -
1) which indicates that wxWindows
88 should generate a default size for the window. If no suitable size can be found, the
89 window will be sized to
20x20 pixels so that the window is visible but obviously not
92 \docparam{style
}{Window style. For generic window styles, please see
\helpref{wxWindow
}{wxwindow
}.
}
94 \docparam{name
}{Window name.
}
96 \membersection{wxWindow::
\destruct{wxWindow
}}
98 \func{}{\destruct{wxWindow
}}{\void}
100 Destructor. Deletes all subwindows, then deletes itself. Instead of using
101 the
{\bf delete
} operator explicitly, you should normally
102 use
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} so that wxWindows
103 can delete a window only when it is safe to do so, in idle time.
107 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
108 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
109 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
110 \helpref{wxCloseEvent
}{wxcloseevent
}
112 \membersection{wxWindow::AddChild
}
114 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
116 Adds a child window. This is called automatically by window creation
117 functions so should not be required by the application programmer.
119 \wxheading{Parameters
}
121 \docparam{child
}{Child window to add.
}
123 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
125 \func{virtual void
}{CaptureMouse
}{\void}
127 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
132 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
134 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
136 \func{void
}{Center
}{\param{int
}{ direction
}}
138 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
140 \membersection{wxWindow::CenterOnParent
}\label{wxwindowcenteronparent
}
142 \func{void
}{CenterOnParent
}{\param{int
}{ direction
}}
144 A synonym for
\helpref{CentreOnParent
}{wxwindowcentreonparent
}.
146 \membersection{wxWindow::CenterOnScreen
}\label{wxwindowcenteronscreen
}
148 \func{void
}{CenterOnScreen
}{\param{int
}{ direction
}}
150 A synonym for
\helpref{CentreOnScreen
}{wxwindowcentreonscreen
}.
152 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
154 \func{void
}{Centre
}{\param{int
}{ direction = wxBOTH
}}
158 \wxheading{Parameters
}
160 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
161 or
{\tt wxBOTH
}. It may also include
{\tt wxCENTRE
\_ON\_SCREEN} flag
162 if you want to center the window on the entire screen and not on its
165 The flag
{\tt wxCENTRE
\_FRAME} is obsolete and should not be used any longer
170 If the window is a top level one (i.e. doesn't have a parent), it will be
171 centered relative to the screen anyhow.
175 \helpref{wxWindow::Center
}{wxwindowcenter
}
177 \membersection{wxWindow::CentreOnParent
}\label{wxwindowcentreonparent
}
179 \func{void
}{CentreOnParent
}{\param{int
}{ direction = wxBOTH
}}
181 Centres the window on its parent. This is a more readable synonym for
182 \helpref{Centre
}{wxwindowcentre
}.
184 \wxheading{Parameters
}
186 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
191 This methods provides for a way to center top level windows over their
192 parents instead of the entire screen. If there is no parent or if the
193 window is not a top level window, then behaviour is the same as
194 \helpref{wxWindow::Centre
}{wxwindowcentre
}.
198 \helpref{wxWindow::CentreOnScreen
}{wxwindowcenteronscreen
}
200 \membersection{wxWindow::CentreOnScreen
}\label{wxwindowcentreonscreen
}
202 \func{void
}{CentreOnScreen
}{\param{int
}{ direction = wxBOTH
}}
204 Centres the window on screen. This only works for top level windows -
205 otherwise, the window will still be centered on its parent.
207 \wxheading{Parameters
}
209 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
214 \helpref{wxWindow::CentreOnParent
}{wxwindowcenteronparent
}
216 \membersection{wxWindow::Clear
}\label{wxwindowclear
}
218 \func{void
}{Clear
}{\void}
220 Clears the window by filling it with the current background colour. Does not
221 cause an erase background event to be generated.
223 \membersection{wxWindow::ClientToScreen
}
225 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
227 \perlnote{In wxPerl this method returns a
2-element list intead of
228 modifying its parameters.
}
230 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
232 Converts to screen coordinates from coordinates relative to this window.
234 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
235 a screen coordinate will be passed out.
}
237 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
238 a screen coordinate will be passed out.
}
240 \docparam{pt
}{The client position for the second form of the function.
}
242 \pythonnote{In place of a single overloaded method name, wxPython
243 implements the following methods:
\par
244 \indented{2cm
}{\begin{twocollist
}
245 \twocolitem{{\bf ClientToScreen(point)
}}{Accepts and returns a wxPoint
}
246 \twocolitem{{\bf ClientToScreenXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
250 \membersection{wxWindow::Close
}\label{wxwindowclose
}
252 \func{virtual bool
}{Close
}{\param{bool
}{ force = FALSE
}}
254 The purpose of this call is to provide a safer way of destroying a window than using
255 the
{\it delete
} operator.
257 \wxheading{Parameters
}
259 \docparam{force
}{FALSE if the window's close handler should be able to veto the destruction
260 of this window, TRUE if it cannot.
}
264 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing an opportunity for the window to
265 choose whether to destroy the window.
267 The close handler should check whether the window is being deleted forcibly,
268 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}, in which case it should
269 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
271 Applies to managed windows (wxFrame and wxDialog classes) only.
273 {\it Note
} that calling Close does not guarantee that the window will be destroyed; but it
274 provides a way to simulate a manual close of a window, which may or may not be implemented by
275 destroying the window. The default implementation of wxDialog::OnCloseWindow does not
276 necessarily delete the dialog, since it will simply simulate an wxID
\_CANCEL event which
277 itself only hides the dialog.
279 To guarantee that the window will be destroyed, call
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} instead.
283 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
284 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
285 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
286 \helpref{wxCloseEvent
}{wxcloseevent
}
288 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
290 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
292 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
294 Converts a point or size from dialog units to pixels.
296 For the x dimension, the dialog units are multiplied by the average character width
297 and then divided by
4.
299 For the y dimension, the dialog units are multiplied by the average character height
300 and then divided by
8.
304 Dialog units are used for maintaining a dialog's proportions even if the font changes.
305 Dialogs created using Dialog Editor optionally use dialog units.
307 You can also use these functions programmatically. A convenience macro is defined:
311 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
317 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
319 \pythonnote{In place of a single overloaded method name, wxPython
320 implements the following methods:
\par
321 \indented{2cm
}{\begin{twocollist
}
322 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
323 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
326 Additionally, the following helper functions are defined:
\par
327 \indented{2cm
}{\begin{twocollist
}
328 \twocolitem{{\bf wxDLG
\_PNT(win, point)
}}{Converts a wxPoint from dialog
330 \twocolitem{{\bf wxDLG
\_SZE(win, size)
}}{Converts a wxSize from dialog
336 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
338 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
340 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
342 Converts a point or size from pixels to dialog units.
344 For the x dimension, the pixels are multiplied by
4 and then divided by the average
347 For the y dimension, the pixels are multipled by
8 and then divided by the average
352 Dialog units are used for maintaining a dialog's proportions even if the font changes.
353 Dialogs created using Dialog Editor optionally use dialog units.
357 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
360 \pythonnote{In place of a single overloaded method name, wxPython
361 implements the following methods:
\par
362 \indented{2cm
}{\begin{twocollist
}
363 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
364 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
368 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
370 \func{virtual bool
}{Destroy
}{\void}
372 Destroys the window safely. Use this function instead of the delete operator, since
373 different window classes can be destroyed differently. Frames and dialogs
374 are not destroyed immediately when this function is called - they are added
375 to a list of windows to be deleted on idle time, when all the window's events
376 have been processed. This prevents problems with events being sent to non-existant
379 \wxheading{Return value
}
381 TRUE if the window has either been successfully deleted, or it has been added
382 to the list of windows pending real deletion.
384 \membersection{wxWindow::DestroyChildren
}
386 \func{virtual void
}{DestroyChildren
}{\void}
388 Destroys all children of a window. Called automatically by the destructor.
390 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
392 \func{virtual void
}{DragAcceptFiles
}{\param{bool
}{ accept
}}
394 Enables or disables elibility for drop file events (OnDropFiles).
396 \wxheading{Parameters
}
398 \docparam{accept
}{If TRUE, the window is eligible for drop file events. If FALSE, the window
399 will not accept drop file events.
}
407 \helpref{wxWindow::OnDropFiles
}{wxwindowondropfiles
}
409 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
411 \func{virtual void
}{Enable
}{\param{bool
}{ enable
}}
413 Enable or disable the window for user input.
415 \wxheading{Parameters
}
417 \docparam{enable
}{If TRUE, enables the window for input. If FALSE, disables the window.
}
421 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
}
423 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
425 \func{static wxWindow*
}{FindFocus
}{\void}
427 Finds the window or control which currently has the keyboard focus.
431 Note that this is a static function, so it can be called without needing a wxWindow pointer.
435 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
437 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
439 \func{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
441 Find a child of this window, by identifier.
443 \func{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
445 Find a child of this window, by name.
447 \pythonnote{In place of a single overloaded method name, wxPython
448 implements the following methods:
\par
449 \indented{2cm
}{\begin{twocollist
}
450 \twocolitem{{\bf FindWindowById(id)
}}{Accepts an integer
}
451 \twocolitem{{\bf FindWindowByName(name)
}}{Accepts a string
}
455 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
457 \func{virtual void
}{Fit
}{\void}
459 Sizes the window so that it fits around its subwindows. This function won't do
460 anything if there are no subwindows.
462 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
464 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
466 Returns the background colour of the window.
470 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
471 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
472 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
473 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
475 \membersection{wxWindow::GetBestSize
}\label{wxwindowgetbestsize
}
477 \constfunc{virtual wxSize
}{GetBestSize
}{\void}
479 This functions returns the best acceptable minimal size for the window. For
480 example, for a static control, it will be the minimal size such that the
481 control label is not truncated. For windows containing subwindows (typically
482 \helpref{wxPanel
}{wxpanel
}), the size returned by this function will be the
483 same as the size the window would have had after calling
484 \helpref{Fit
}{wxwindowfit
}.
486 \membersection{wxWindow::GetCaret
}\label{wxwindowgetcaret
}
488 \constfunc{wxCaret *
}{GetCaret
}{\void}
490 Returns the
\helpref{caret
}{wxcaret
} associated with the window.
492 \membersection{wxWindow::GetCharHeight
}
494 \constfunc{virtual int
}{GetCharHeight
}{\void}
496 Returns the character height for this window.
498 \membersection{wxWindow::GetCharWidth
}
500 \constfunc{virtual int
}{GetCharWidth
}{\void}
502 Returns the average character width for this window.
504 \membersection{wxWindow::GetChildren
}
506 \func{wxList\&
}{GetChildren
}{\void}
508 Returns a reference to the list of the window's children.
510 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
512 \constfunc{virtual void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
514 \perlnote{In wxPerl this method takes no parameter and returns
515 a
2-element list
{\tt ( width, height )
}.
}
517 \constfunc{virtual wxSize
}{GetClientSize
}{\void}
519 This gets the size of the window `client area' in pixels. The client area is the
520 area which may be drawn on by the programmer, excluding title bar, border etc.
522 \wxheading{Parameters
}
524 \docparam{width
}{Receives the client width in pixels.
}
526 \docparam{height
}{Receives the client height in pixels.
}
528 \pythonnote{In place of a single overloaded method name, wxPython
529 implements the following methods:
\par
530 \indented{2cm
}{\begin{twocollist
}
531 \twocolitem{{\bf GetClientSizeTuple()
}}{Returns a
2-tuple of (width, height)
}
532 \twocolitem{{\bf GetClientSize()
}}{Returns a wxSize object
}
536 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
538 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
540 Returns a pointer to the window's layout constraints, or NULL if there are none.
542 \membersection{wxWindow::GetDropTarget
}\label{wxwindowgetdroptarget
}
544 \constfunc{wxDropTarget*
}{GetDropTarget
}{\void}
546 Returns the associated drop target, which may be NULL.
550 \helpref{wxWindow::SetDropTarget
}{wxwindowsetdroptarget
},
551 \helpref{Drag and drop overview
}{wxdndoverview
}
553 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
555 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
557 Returns the event handler for this window. By default, the window is its
562 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
563 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
564 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
565 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
566 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
568 \membersection{wxWindow::GetExtraStyle
}\label{wxwindowgetextrastyle
}
570 \constfunc{long
}{GetExtraStyle
}{\void}
572 Returns the extra style bits for the window.
574 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
576 \constfunc{wxFont\&
}{GetFont
}{\void}
578 Returns a reference to the font for this window.
582 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
584 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
586 \func{virtual wxColour
}{GetForegroundColour
}{\void}
588 Returns the foreground colour of the window.
592 The interpretation of foreground colour is open to interpretation according
593 to the window class; it may be the text colour or other colour, or it may not
598 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
599 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
600 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
602 \membersection{wxWindow::GetGrandParent
}
604 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
606 Returns the grandparent of a window, or NULL if there isn't one.
608 \membersection{wxWindow::GetHandle
}\label{wxwindowgethandle
}
610 \constfunc{void*
}{GetHandle
}{\void}
612 Returns the platform-specific handle of the physical window. Cast it to an appropriate
613 handle, such as
{\bf HWND
} for Windows,
{\bf Widget
} for Motif or
{\bf GtkWidget
} for GTK.
615 \pythonnote{This method will return an integer in wxPython.
}
617 \membersection{wxWindow::GetHelpText
}\label{wxwindowgethelptext
}
619 \constfunc{virtual wxString
}{GetHelpText
}{\void}
621 Gets the help text to be used as context-sensitive help for this window.
623 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
624 and not in the window object itself.
628 \helpref{SetHelpText
}{wxwindowsethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
630 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
632 \constfunc{int
}{GetId
}{\void}
634 Returns the identifier of the window.
638 Each window has an integer identifier. If the application has not provided one
639 (or the default Id -
1) an unique identifier with a negative value will be generated.
643 \helpref{wxWindow::SetId
}{wxwindowsetid
},
\rtfsp
644 \helpref{Window identifiers
}{windowids
}
646 \membersection{wxWindow::GetLabel
}
648 \constfunc{virtual wxString
}{GetLabel
}{\void}
650 Generic way of getting a label from any window, for
651 identification purposes.
655 The interpretation of this function differs from class to class.
656 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
657 the button text. This function can be useful for meta-programs (such as testing
658 tools or special-needs access programs) which need to identify windows
661 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
663 \constfunc{virtual wxString
}{GetName
}{\void}
665 Returns the window's name.
669 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
670 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
674 \helpref{wxWindow::SetName
}{wxwindowsetname
}
676 \membersection{wxWindow::GetParent
}
678 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
680 Returns the parent of the window, or NULL if there is no parent.
682 \membersection{wxWindow::GetPosition
}\label{wxwindowgetposition
}
684 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
686 \constfunc{wxPoint
}{GetPosition
}{\void}
688 This gets the position of the window in pixels, relative to the parent window or
689 if no parent, relative to the whole display.
691 \wxheading{Parameters
}
693 \docparam{x
}{Receives the x position of the window.
}
695 \docparam{y
}{Receives the y position of the window.
}
697 \pythonnote{In place of a single overloaded method name, wxPython
698 implements the following methods:
\par
699 \indented{2cm
}{\begin{twocollist
}
700 \twocolitem{{\bf GetPosition()
}}{Returns a wxPoint
}
701 \twocolitem{{\bf GetPositionTuple()
}}{Returns a tuple (x, y)
}
705 \perlnote{In wxPerl there are two methods instead of a single overloaded
707 \indented{2cm
}{\begin{twocollist
}
708 \twocolitem{{\bf GetPosition()
}}{Returns a Wx::Point
}
709 \twocolitem{{\bf GetPositionXY()
}}{Returns a
2-element list
714 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
716 \constfunc{virtual wxRect
}{GetRect
}{\void}
718 Returns the size and position of the window as a
\helpref{wxRect
}{wxrect
} object.
720 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
722 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
724 Returns the built-in scrollbar thumb size.
728 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
730 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
732 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
734 Returns the built-in scrollbar position.
738 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
740 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
742 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
744 Returns the built-in scrollbar range.
748 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
750 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
752 \constfunc{virtual void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
754 \constfunc{virtual wxSize
}{GetSize
}{\void}
756 This gets the size of the entire window in pixels.
758 \wxheading{Parameters
}
760 \docparam{width
}{Receives the window width.
}
762 \docparam{height
}{Receives the window height.
}
764 \pythonnote{In place of a single overloaded method name, wxPython
765 implements the following methods:
\par
766 \indented{2cm
}{\begin{twocollist
}
767 \twocolitem{{\bf GetSize()
}}{Returns a wxSize
}
768 \twocolitem{{\bf GetSizeTuple()
}}{Returns a
2-tuple (width, height)
}
772 \perlnote{In wxPerl there are two methods instead of a single overloaded
774 \indented{2cm
}{\begin{twocollist
}
775 \twocolitem{{\bf GetSize()
}}{Returns a Wx::Size
}
776 \twocolitem{{\bf GetSizeWH()
}}{Returns a
2-element list
777 {\tt ( width, height )
}}
781 \membersection{wxWindow::GetTextExtent
}
783 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{x
},
\param{int*
}{y
},
784 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
785 \param{const wxFont*
}{font = NULL
},
\param{bool
}{ use16 = FALSE
}}
787 Gets the dimensions of the string as it would be drawn on the
788 window with the currently selected font.
790 \wxheading{Parameters
}
792 \docparam{string
}{String whose extent is to be measured.
}
794 \docparam{x
}{Return value for width.
}
796 \docparam{y
}{Return value for height.
}
798 \docparam{descent
}{Return value for descent (optional).
}
800 \docparam{externalLeading
}{Return value for external leading (optional).
}
802 \docparam{font
}{Font to use instead of the current window font (optional).
}
804 \docparam{use16
}{If TRUE,
{\it string
} contains
16-bit characters. The default is FALSE.
}
807 \pythonnote{In place of a single overloaded method name, wxPython
808 implements the following methods:
\par
809 \indented{2cm
}{\begin{twocollist
}
810 \twocolitem{{\bf GetTextExtent(string)
}}{Returns a
2-tuple, (width, height)
}
811 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)
}}{Returns a
812 4-tuple, (width, height, descent, externalLeading)
}
816 \perlnote{In wxPerl this method takes only the
{\tt string
} and optionally
817 {\tt font
} parameters, and returns a
4-element list
818 {\tt ( x, y, descent, externalLeading )
}.
}
820 \membersection{wxWindow::GetTitle
}\label{wxwindowgettitle
}
822 \func{virtual wxString
}{GetTitle
}{\void}
824 Gets the window's title. Applicable only to frames and dialogs.
828 \helpref{wxWindow::SetTitle
}{wxwindowsettitle
}
830 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
832 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
834 Returns the region specifying which parts of the window have been damaged. Should
835 only be called within an
\helpref{OnPaint
}{wxwindowonpaint
} event handler.
839 \helpref{wxRegion
}{wxregion
},
\helpref{wxRegionIterator
}{wxregioniterator
},
\helpref{wxWindow::OnPaint
}{wxwindowonpaint
}
841 \membersection{wxWindow::GetValidator
}\label{wxwindowgetvalidator
}
843 \constfunc{wxValidator*
}{GetValidator
}{\void}
845 Returns a pointer to the current validator for the window, or NULL if there is none.
847 \membersection{wxWindow::GetWindowStyleFlag
}\label{wxwindowgetwindowstyleflag
}
849 \constfunc{long
}{GetWindowStyleFlag
}{\void}
851 Gets the window style that was passed to the constructor or
{\bf Create
}
852 method.
{\bf GetWindowStyle()
} is another name for the same function.
854 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
856 \func{void
}{InitDialog
}{\void}
858 Sends an
\helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
} event, which
859 in turn transfers data to the dialog via validators.
863 \helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
}
865 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
867 \constfunc{virtual bool
}{IsEnabled
}{\void}
869 Returns TRUE if the window is enabled for input, FALSE otherwise.
873 \helpref{wxWindow::Enable
}{wxwindowenable
}
875 \membersection{wxWindow:IsExposed
}\label{wxwindowisexposed
}
877 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
}}
879 \constfunc{bool
}{IsExposed
}{\param{wxPoint
}{\&pt
}}
881 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
},
\param{int
}{w
},
\param{int
}{h
}}
883 \constfunc{bool
}{IsExposed
}{\param{wxRect
}{\&rect
}}
885 Returns TRUE if the given point or rectange area has been exposed since the
886 last repaint. Call this in an paint event handler to optimize redrawing by
887 only redrawing those areas, which have been exposed.
889 \pythonnote{In place of a single overloaded method name, wxPython
890 implements the following methods:
\par
891 \indented{2cm
}{\begin{twocollist
}
892 \twocolitem{{\bf IsExposed(x,y, w=
0,h=
0}}{}
893 \twocolitem{{\bf IsExposedPoint(pt)
}}{}
894 \twocolitem{{\bf IsExposedRect(rect)
}}{}
897 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
899 \constfunc{virtual bool
}{IsRetained
}{\void}
901 Returns TRUE if the window is retained, FALSE otherwise.
905 Retained windows are only available on X platforms.
907 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
909 \constfunc{virtual bool
}{IsShown
}{\void}
911 Returns TRUE if the window is shown, FALSE if it has been hidden.
913 \membersection{wxWindow::IsTopLevel
}\label{wxwindowistoplevel
}
915 \constfunc{bool
}{IsTopLevel
}{\void}
917 Returns TRUE if the given window is a top-level one. Currently all frames and
918 dialogs are considered to be top-level windows (even if they have a parent
921 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
923 \func{void
}{Layout
}{\void}
925 Invokes the constraint-based layout algorithm or the sizer-based algorithm
928 See
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} on when
929 this function gets called automatically using auto layout.
931 \membersection{wxWindow::LoadFromResource
}\label{wxwindowloadfromresource
}
933 \func{virtual bool
}{LoadFromResource
}{\param{wxWindow*
}{parent
},
\rtfsp
934 \param{const wxString\&
}{resourceName
},
\param{const wxResourceTable*
}{resourceTable = NULL
}}
936 Loads a panel or dialog from a resource file.
938 \wxheading{Parameters
}
940 \docparam{parent
}{Parent window.
}
942 \docparam{resourceName
}{The name of the resource to load.
}
944 \docparam{resourceTable
}{The resource table to load it from. If this is NULL, the
945 default resource table will be used.
}
947 \wxheading{Return value
}
949 TRUE if the operation succeeded, otherwise FALSE.
951 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
953 \func{void
}{Lower
}{\void}
955 Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
958 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
960 \func{virtual void
}{MakeModal
}{\param{bool
}{flag
}}
962 Disables all other windows in the application so that
963 the user can only interact with this window. (This function
964 is not implemented anywhere).
966 \wxheading{Parameters
}
968 \docparam{flag
}{If TRUE, this call disables all other windows in the application so that
969 the user can only interact with this window. If FALSE, the effect is reversed.
}
971 \membersection{wxWindow::Move
}\label{wxwindowmove
}
973 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
975 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
977 Moves the window to the given position.
979 \wxheading{Parameters
}
981 \docparam{x
}{Required x position.
}
983 \docparam{y
}{Required y position.
}
985 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
989 Implementations of SetSize can also implicitly implement the
990 wxWindow::Move function, which is defined in the base wxWindow class
994 SetSize(x, y, -
1, -
1, wxSIZE_USE_EXISTING);
999 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
1001 \pythonnote{In place of a single overloaded method name, wxPython
1002 implements the following methods:
\par
1003 \indented{2cm
}{\begin{twocollist
}
1004 \twocolitem{{\bf Move(point)
}}{Accepts a wxPoint
}
1005 \twocolitem{{\bf MoveXY(x, y)
}}{Accepts a pair of integers
}
1009 \membersection{wxWindow::OnActivate
}\label{wxwindowonactivate
}
1011 \func{void
}{OnActivate
}{\param{wxActivateEvent\&
}{ event
}}
1013 Called when a window is activated or deactivated.
1015 \wxheading{Parameters
}
1017 \docparam{event
}{Object containing activation information.
}
1021 If the window is being activated,
\helpref{wxActivateEvent::GetActive
}{wxactivateeventgetactive
} returns TRUE,
1022 otherwise it returns FALSE (it is being deactivated).
1024 \wxheading{See also
}
1026 \helpref{wxActivateEvent
}{wxactivateevent
},
\rtfsp
1027 \helpref{Event handling overview
}{eventhandlingoverview
}
1029 \membersection{wxWindow::OnChar
}\label{wxwindowonchar
}
1031 \func{void
}{OnChar
}{\param{wxKeyEvent\&
}{ event
}}
1033 Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
1035 \wxheading{Parameters
}
1037 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1038 details about this class.
}
1042 This member function is called in response to a keypress. To intercept this event,
1043 use the EVT
\_CHAR macro in an event table definition. Your
{\bf OnChar
} handler may call this
1044 default function to achieve default keypress functionality.
1046 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1049 Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1050 keypresses, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
1051 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
1053 Most, but not all, windows allow keypresses to be intercepted.
1055 \wxheading{See also
}
1057 \helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
},
\helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
},
\rtfsp
1058 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1059 \helpref{Event handling overview
}{eventhandlingoverview
}
1061 \membersection{wxWindow::OnCharHook
}\label{wxwindowoncharhook
}
1063 \func{void
}{OnCharHook
}{\param{wxKeyEvent\&
}{ event
}}
1065 This member is called to allow the window to intercept keyboard events
1066 before they are processed by child windows.
1068 \wxheading{Parameters
}
1070 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1071 details about this class.
}
1075 This member function is called in response to a keypress, if the window is active. To intercept this event,
1076 use the EVT
\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
1077 keypress, call
\helpref{wxEvent::Skip
}{wxeventskip
} to allow default processing.
1079 An example of using this function is in the implementation of escape-character processing for wxDialog,
1080 where pressing ESC dismisses the dialog by
{\bf OnCharHook
} 'forging' a cancel button press event.
1082 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1085 This function is only relevant to top-level windows (frames and dialogs), and under
1086 Windows only. Under GTK the normal EVT
\_CHAR\_ event has the functionality, i.e.
1087 you can intercepts it and if you don't call
\helpref{wxEvent::Skip
}{wxeventskip
}
1088 the window won't get the event.
1090 \wxheading{See also
}
1092 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1093 \helpref{wxApp::OnCharHook
}{wxapponcharhook
},
\rtfsp
1094 \helpref{Event handling overview
}{eventhandlingoverview
}
1096 \membersection{wxWindow::OnCommand
}\label{wxwindowoncommand
}
1098 \func{virtual void
}{OnCommand
}{\param{wxEvtHandler\&
}{object
},
\param{wxCommandEvent\&
}{event
}}
1100 This virtual member function is called if the control does not handle the command event.
1102 \wxheading{Parameters
}
1104 \docparam{object
}{Object receiving the command event.
}
1106 \docparam{event
}{Command event
}
1110 This virtual function is provided mainly for backward compatibility. You can also intercept commands
1111 from child controls by using an event table, with identifiers or identifier ranges to identify
1112 the control(s) in question.
1114 \wxheading{See also
}
1116 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
1117 \helpref{Event handling overview
}{eventhandlingoverview
}
1119 \membersection{wxWindow::OnClose
}\label{wxwindowonclose
}
1121 \func{virtual bool
}{OnClose
}{\void}
1123 Called when the user has tried to close a a frame
1124 or dialog box using the window manager (X) or system menu (Windows).
1126 {\bf Note:
} This is an obsolete function.
1127 It is superceded by the
\helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
} event
1130 \wxheading{Return value
}
1132 If TRUE is returned by OnClose, the window will be deleted by the system, otherwise the
1133 attempt will be ignored. Do not delete the window from within this handler, although
1134 you may delete other windows.
1136 \wxheading{See also
}
1138 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
1139 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
1140 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
1141 \helpref{wxCloseEvent
}{wxcloseevent
}
1143 \membersection{wxWindow::OnCloseWindow
}\label{wxwindowonclosewindow
}
1145 \func{void
}{OnCloseWindow
}{\param{wxCloseEvent\&
}{event
}}
1147 This is an event handler function called when the user has tried to close a a frame
1148 or dialog box using the window manager (X) or system menu (Windows). It is
1149 called via the
\helpref{wxWindow::Close
}{wxwindowclose
} function, so
1150 that the application can also invoke the handler programmatically.
1152 Use the EVT
\_CLOSE event table macro to handle close events.
1154 You should check whether the application is forcing the deletion of the window
1155 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}. If this is TRUE,
1156 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
1157 If not, it is up to you whether you respond by destroying the window.
1159 (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
1160 the window is required, test for the negative of CanVeto. If CanVeto returns FALSE,
1161 it is not possible to skip window deletion.)
1163 If you don't destroy the window, you should call
\helpref{wxCloseEvent::Veto
}{wxcloseeventveto
} to
1164 let the calling code know that you did not destroy the window. This allows the
\helpref{wxWindow::Close
}{wxwindowclose
} function
1165 to return TRUE or FALSE depending on whether the close instruction was honoured or not.
1169 The
\helpref{wxWindow::OnClose
}{wxwindowonclose
} virtual function remains
1170 for backward compatibility with earlier versions of wxWindows. The
1171 default
{\bf OnCloseWindow
} handler for wxFrame and wxDialog will call
{\bf OnClose
},
1172 destroying the window if it returns TRUE or if the close is being forced.
1174 \wxheading{See also
}
1176 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
1177 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
1178 \helpref{wxWindow::OnClose
}{wxwindowonclose
},
\rtfsp
1179 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
1180 \helpref{wxCloseEvent
}{wxcloseevent
},
\rtfsp
1181 \helpref{wxApp::OnQueryEndSession
}{wxapponqueryendsession
},
\rtfsp
1182 \helpref{wxApp::OnEndSession
}{wxapponendsession
}
1184 \membersection{wxWindow::OnDropFiles
}\label{wxwindowondropfiles
}
1186 \func{void
}{OnDropFiles
}{\param{wxDropFilesEvent\&
}{ event
}}
1188 Called when files have been dragged from the file manager to the window.
1190 \wxheading{Parameters
}
1192 \docparam{event
}{Drop files event. For more information, see
\helpref{wxDropFilesEvent
}{wxdropfilesevent
}.
}
1196 The window must have previously been enabled for dropping by calling
1197 \rtfsp\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
}.
1199 This event is only generated under Windows.
1201 To intercept this event, use the EVT
\_DROP\_FILES macro in an event table definition.
1203 \wxheading{See also
}
1205 \helpref{wxDropFilesEvent
}{wxdropfilesevent
},
\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
},
\rtfsp
1206 \helpref{Event handling overview
}{eventhandlingoverview
}
1208 \membersection{wxWindow::OnEraseBackground
}\label{wxwindowonerasebackground
}
1210 \func{void
}{OnEraseBackground
}{\param{wxEraseEvent\&
}{ event
}}
1212 Called when the background of the window needs to be erased.
1214 \wxheading{Parameters
}
1216 \docparam{event
}{Erase background event. For more information, see
\helpref{wxEraseEvent
}{wxeraseevent
}.
}
1220 Under non-Windows platforms, this event is simulated (simply generated just before the
1221 paint event) and may cause flicker. It is therefore recommended that
1222 you set the text background colour explicitly in order to prevent flicker.
1223 The default background colour under GTK is grey.
1225 To intercept this event, use the EVT
\_ERASE\_BACKGROUND macro in an event table definition.
1227 \wxheading{See also
}
1229 \helpref{wxEraseEvent
}{wxeraseevent
},
\helpref{Event handling overview
}{eventhandlingoverview
}
1231 \membersection{wxWindow::OnKeyDown
}\label{wxwindowonkeydown
}
1233 \func{void
}{OnKeyDown
}{\param{wxKeyEvent\&
}{ event
}}
1235 Called when the user has pressed a key, before it is translated into an ASCII value using other
1236 modifier keys that might be pressed at the same time.
1238 \wxheading{Parameters
}
1240 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1241 details about this class.
}
1245 This member function is called in response to a key down event. To intercept this event,
1246 use the EVT
\_KEY\_DOWN macro in an event table definition. Your
{\bf OnKeyDown
} handler may call this
1247 default function to achieve default keypress functionality.
1249 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1250 keys, such as shift, control, and function keys, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
1251 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
1253 Most, but not all, windows allow keypresses to be intercepted.
1255 \wxheading{See also
}
1257 \helpref{wxWindow::OnChar
}{wxwindowonchar
},
\helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
},
\rtfsp
1258 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1259 \helpref{Event handling overview
}{eventhandlingoverview
}
1261 \membersection{wxWindow::OnKeyUp
}\label{wxwindowonkeyup
}
1263 \func{void
}{OnKeyUp
}{\param{wxKeyEvent\&
}{ event
}}
1265 Called when the user has released a key.
1267 \wxheading{Parameters
}
1269 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1270 details about this class.
}
1274 This member function is called in response to a key up event. To intercept this event,
1275 use the EVT
\_KEY\_UP macro in an event table definition. Your
{\bf OnKeyUp
} handler may call this
1276 default function to achieve default keypress functionality.
1278 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1279 keys, such as shift, control, and function keys, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
1280 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
1282 Most, but not all, windows allow key up events to be intercepted.
1284 \wxheading{See also
}
1286 \helpref{wxWindow::OnChar
}{wxwindowonchar
},
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
},
\rtfsp
1287 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1288 \helpref{Event handling overview
}{eventhandlingoverview
}
1290 \membersection{wxWindow::OnKillFocus
}\label{wxwindowonkillfocus
}
1292 \func{void
}{OnKillFocus
}{\param{wxFocusEvent\&
}{event
}}
1294 Called when a window's focus is being killed.
1296 \wxheading{Parameters
}
1298 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1302 To intercept this event, use the macro EVT
\_KILL\_FOCUS in an event table definition.
1304 Most, but not all, windows respond to this event.
1306 \wxheading{See also
}
1308 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnSetFocus
}{wxwindowonsetfocus
},
\rtfsp
1309 \helpref{Event handling overview
}{eventhandlingoverview
}
1311 \membersection{wxWindow::OnIdle
}\label{wxwindowonidle
}
1313 \func{void
}{OnIdle
}{\param{wxIdleEvent\&
}{event
}}
1315 Provide this member function for any processing which needs to be done
1316 when the application is idle.
1318 \wxheading{See also
}
1320 \helpref{wxApp::OnIdle
}{wxapponidle
},
\helpref{wxIdleEvent
}{wxidleevent
}
1322 \membersection{wxWindow::OnInitDialog
}\label{wxwindowoninitdialog
}
1324 \func{void
}{OnInitDialog
}{\param{wxInitDialogEvent\&
}{ event
}}
1326 Default handler for the wxEVT
\_INIT\_DIALOG event. Calls
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}.
1328 \wxheading{Parameters
}
1330 \docparam{event
}{Dialog initialisation event.
}
1334 Gives the window the default behaviour of transferring data to child controls via
1335 the validator that each control has.
1337 \wxheading{See also
}
1339 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}
1341 \membersection{wxWindow::OnMenuCommand
}\label{wxwindowonmenucommand
}
1343 \func{void
}{OnMenuCommand
}{\param{wxCommandEvent\&
}{event
}}
1345 Called when a menu command is received from a menu bar.
1347 \wxheading{Parameters
}
1349 \docparam{event
}{The menu command event. For more information, see
\helpref{wxCommandEvent
}{wxcommandevent
}.
}
1353 A function with this name doesn't actually exist; you can choose any member function to receive
1354 menu command events, using the EVT
\_COMMAND macro for individual commands or EVT
\_COMMAND\_RANGE for
1355 a range of commands.
1357 \wxheading{See also
}
1359 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
1360 \helpref{wxWindow::OnMenuHighlight
}{wxwindowonmenuhighlight
},
\rtfsp
1361 \helpref{Event handling overview
}{eventhandlingoverview
}
1363 \membersection{wxWindow::OnMenuHighlight
}\label{wxwindowonmenuhighlight
}
1365 \func{void
}{OnMenuHighlight
}{\param{wxMenuEvent\&
}{event
}}
1367 Called when a menu select is received from a menu bar: that is, the
1368 mouse cursor is over a menu item, but the left mouse button has not been
1371 \wxheading{Parameters
}
1373 \docparam{event
}{The menu highlight event. For more information, see
\helpref{wxMenuEvent
}{wxmenuevent
}.
}
1377 You can choose any member function to receive
1378 menu select events, using the EVT
\_MENU\_HIGHLIGHT macro for individual menu items or EVT
\_MENU\_HIGHLIGHT\_ALL macro
1381 The default implementation for
\helpref{wxFrame::OnMenuHighlight
}{wxframeonmenuhighlight
} displays help
1382 text in the first field of the status bar.
1384 This function was known as
{\bf OnMenuSelect
} in earlier versions of wxWindows, but this was confusing
1385 since a selection is normally a left-click action.
1387 \wxheading{See also
}
1389 \helpref{wxMenuEvent
}{wxmenuevent
},
\rtfsp
1390 \helpref{wxWindow::OnMenuCommand
}{wxwindowonmenucommand
},
\rtfsp
1391 \helpref{Event handling overview
}{eventhandlingoverview
}
1394 \membersection{wxWindow::OnMouseEvent
}\label{wxwindowonmouseevent
}
1396 \func{void
}{OnMouseEvent
}{\param{wxMouseEvent\&
}{ event
}}
1398 Called when the user has initiated an event with the
1401 \wxheading{Parameters
}
1403 \docparam{event
}{The mouse event. See
\helpref{wxMouseEvent
}{wxmouseevent
} for
1408 Most, but not all, windows respond to this event.
1410 To intercept this event, use the EVT
\_MOUSE\_EVENTS macro in an event table definition, or individual
1411 mouse event macros such as EVT
\_LEFT\_DOWN.
1413 \wxheading{See also
}
1415 \helpref{wxMouseEvent
}{wxmouseevent
},
\rtfsp
1416 \helpref{Event handling overview
}{eventhandlingoverview
}
1418 \membersection{wxWindow::OnMove
}\label{wxwindowonmove
}
1420 \func{void
}{OnMove
}{\param{wxMoveEvent\&
}{event
}}
1422 Called when a window is moved.
1424 \wxheading{Parameters
}
1426 \docparam{event
}{The move event. For more information, see
\helpref{wxMoveEvent
}{wxmoveevent
}.
}
1430 Use the EVT
\_MOVE macro to intercept move events.
1434 Not currently implemented.
1436 \wxheading{See also
}
1438 \helpref{wxMoveEvent
}{wxmoveevent
},
\rtfsp
1439 \helpref{wxFrame::OnSize
}{wxframeonsize
},
\rtfsp
1440 \helpref{Event handling overview
}{eventhandlingoverview
}
1442 \membersection{wxWindow::OnPaint
}\label{wxwindowonpaint
}
1444 \func{void
}{OnPaint
}{\param{wxPaintEvent\&
}{event
}}
1446 Sent to the event handler when the window must be refreshed.
1448 \wxheading{Parameters
}
1450 \docparam{event
}{Paint event. For more information, see
\helpref{wxPaintEvent
}{wxpaintevent
}.
}
1454 Use the EVT
\_PAINT macro in an event table definition to intercept paint events.
1456 Note that In a paint event handler, the application must
{\it always
} create a
\helpref{wxPaintDC
}{wxpaintdc
} object,
1457 even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
1463 void MyWindow::OnPaint(wxPaintEvent\& event)
1472 You can optimize painting by retrieving the rectangles
1473 that have been damaged and only repainting these. The rectangles are in
1474 terms of the client area, and are unscrolled, so you will need to do
1475 some calculations using the current view position to obtain logical,
1478 Here is an example of using the
\helpref{wxRegionIterator
}{wxregioniterator
} class:
1482 // Called when window needs to be repainted.
1483 void MyWindow::OnPaint(wxPaintEvent\& event)
1487 // Find Out where the window is scrolled to
1488 int vbX,vbY; // Top left corner of client
1489 GetViewStart(&vbX,&vbY);
1491 int vX,vY,vW,vH; // Dimensions of client area in pixels
1492 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1501 // Alternatively we can do this:
1503 // upd.GetRect(&rect);
1505 // Repaint this rectangle
1514 \wxheading{See also
}
1516 \helpref{wxPaintEvent
}{wxpaintevent
},
\rtfsp
1517 \helpref{wxPaintDC
}{wxpaintdc
},
\rtfsp
1518 \helpref{Event handling overview
}{eventhandlingoverview
}
1520 \membersection{wxWindow::OnScroll
}\label{wxwindowonscroll
}
1522 \func{void
}{OnScroll
}{\param{wxScrollWinEvent\&
}{event
}}
1524 Called when a scroll window event is received from one of the window's built-in scrollbars.
1526 \wxheading{Parameters
}
1528 \docparam{event
}{Command event. Retrieve the new scroll position by
1529 calling
\helpref{wxScrollEvent::GetPosition
}{wxscrolleventgetposition
}, and the
1530 scrollbar orientation by calling
\helpref{wxScrollEvent::GetOrientation
}{wxscrolleventgetorientation
}.
}
1534 Note that it is not possible to distinguish between horizontal and vertical scrollbars
1535 until the function is executing (you can't have one function for vertical, another
1536 for horizontal events).
1538 \wxheading{See also
}
1540 \helpref{wxScrollWinEvent
}{wxscrollwinevent
},
\rtfsp
1541 \helpref{Event handling overview
}{eventhandlingoverview
}
1543 \membersection{wxWindow::OnSetFocus
}\label{wxwindowonsetfocus
}
1545 \func{void
}{OnSetFocus
}{\param{wxFocusEvent\&
}{event
}}
1547 Called when a window's focus is being set.
1549 \wxheading{Parameters
}
1551 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1555 To intercept this event, use the macro EVT
\_SET\_FOCUS in an event table definition.
1557 Most, but not all, windows respond to this event.
1559 \wxheading{See also
}
1561 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnKillFocus
}{wxwindowonkillfocus
},
\rtfsp
1562 \helpref{Event handling overview
}{eventhandlingoverview
}
1564 \membersection{wxWindow::OnSize
}\label{wxwindowonsize
}
1566 \func{void
}{OnSize
}{\param{wxSizeEvent\&
}{event
}}
1568 Called when the window has been resized.
1570 \wxheading{Parameters
}
1572 \docparam{event
}{Size event. For more information, see
\helpref{wxSizeEvent
}{wxsizeevent
}.
}
1576 You may wish to use this for frames to resize their child windows as appropriate.
1578 Note that the size passed is of
1579 the whole window: call
\helpref{wxWindow::GetClientSize
}{wxwindowgetclientsize
} for the area which may be
1580 used by the application.
1582 When a window is resized, usually only a small part of the window is damaged and you
1583 may only need to repaint that area. However, if your drawing depends on the size of the window,
1584 you may need to clear the DC explicitly and repaint the whole window. In which case, you
1585 may need to call
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} to invalidate the entire window.
1587 \wxheading{See also
}
1589 \helpref{wxSizeEvent
}{wxsizeevent
},
\rtfsp
1590 \helpref{Event handling overview
}{eventhandlingoverview
}
1592 \membersection{wxWindow::OnSysColourChanged
}\label{wxwindowonsyscolourchanged
}
1594 \func{void
}{OnSysColourChanged
}{\param{wxOnSysColourChangedEvent\&
}{event
}}
1596 Called when the user has changed the system colours. Windows only.
1598 \wxheading{Parameters
}
1600 \docparam{event
}{System colour change event. For more information, see
\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}.
}
1602 \wxheading{See also
}
1604 \helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
},
\rtfsp
1605 \helpref{Event handling overview
}{eventhandlingoverview
}
1607 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
1609 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler = FALSE
}}
1611 Removes and returns the top-most event handler on the event handler stack.
1613 \wxheading{Parameters
}
1615 \docparam{deleteHandler
}{If this is TRUE, the handler will be deleted after it is removed. The
1616 default value is FALSE.
}
1618 \wxheading{See also
}
1620 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1621 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1622 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1623 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1624 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
1626 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
1628 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{const wxPoint\&
}{pos
}}
1630 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
1632 Pops up the given menu at the specified coordinates, relative to this
1633 window, and returns control when the user has dismissed the menu. If a
1634 menu item is selected, the corresponding menu event is generated and will be
1635 processed as usually.
1637 \wxheading{Parameters
}
1639 \docparam{menu
}{Menu to pop up.
}
1641 \docparam{pos
}{The position where the menu will appear.
}
1643 \docparam{x
}{Required x position for the menu to appear.
}
1645 \docparam{y
}{Required y position for the menu to appear.
}
1647 \wxheading{See also
}
1649 \helpref{wxMenu
}{wxmenu
}
1653 Just before the menu is popped up,
\helpref{wxMenu::UpdateUI
}{wxmenuupdateui
} is called
1654 to ensure that the menu items are in the correct state. The menu does not get deleted
1657 \pythonnote{In place of a single overloaded method name, wxPython
1658 implements the following methods:
\par
1659 \indented{2cm
}{\begin{twocollist
}
1660 \twocolitem{{\bf PopupMenu(menu, point)
}}{Specifies position with a wxPoint
}
1661 \twocolitem{{\bf PopupMenuXY(menu, x, y)
}}{Specifies position with two integers (x, y)
}
1665 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
1667 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1669 Pushes this event handler onto the event stack for the window.
1671 \wxheading{Parameters
}
1673 \docparam{handler
}{Specifies the handler to be pushed.
}
1677 An event handler is an object that is capable of processing the events
1678 sent to a window. By default, the window is its own event handler, but
1679 an application may wish to substitute another, for example to allow
1680 central implementation of event-handling for a variety of different
1683 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
1684 an application to set up a chain of event handlers, where an event not handled by one event handler is
1685 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
1686 remove the event handler.
1688 \wxheading{See also
}
1690 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1691 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1692 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1693 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1694 \helpref{wxEvtHandler
}{wxevthandler
}
1696 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
1698 \func{void
}{Raise
}{\void}
1700 Raises the window to the top of the window hierarchy if it is a managed window (dialog
1703 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
1705 \func{virtual void
}{Refresh
}{\param{bool
}{ eraseBackground = TRUE
},
\param{const wxRect*
}{rect
1708 Causes a message or event to be generated to repaint the
1711 \wxheading{Parameters
}
1713 \docparam{eraseBackground
}{If TRUE, the background will be
1716 \docparam{rect
}{If non-NULL, only the given rectangle will
1717 be treated as damaged.
}
1719 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
1721 \func{virtual void
}{ReleaseMouse
}{\void}
1723 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
1725 \wxheading{See also
}
1727 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}
1729 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
1731 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
1733 Removes a child window. This is called automatically by window deletion
1734 functions so should not be required by the application programmer.
1736 \wxheading{Parameters
}
1738 \docparam{child
}{Child window to remove.
}
1740 \membersection{wxWindow::Reparent
}\label{wxwindowreparent
}
1742 \func{virtual bool
}{Reparent
}{\param{wxWindow*
}{newParent
}}
1744 Reparents the window, i.e the window will be removed from its
1745 current parent window (e.g. a non-standard toolbar in a wxFrame)
1746 and then re-inserted into another. Available on Windows and GTK.
1748 \wxheading{Parameters
}
1750 \docparam{newParent
}{New parent.
}
1752 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
1754 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
1756 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
1758 Converts from screen to client window coordinates.
1760 \wxheading{Parameters
}
1762 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
1764 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
1766 \docparam{pt
}{The screen position for the second form of the function.
}
1768 \pythonnote{In place of a single overloaded method name, wxPython
1769 implements the following methods:
\par
1770 \indented{2cm
}{\begin{twocollist
}
1771 \twocolitem{{\bf ScreenToClient(point)
}}{Accepts and returns a wxPoint
}
1772 \twocolitem{{\bf ScreenToClientXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
1777 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
1779 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
1781 Physically scrolls the pixels in the window and move child windows accordingly.
1783 \wxheading{Parameters
}
1785 \docparam{dx
}{Amount to scroll horizontally.
}
1787 \docparam{dy
}{Amount to scroll vertically.
}
1789 \docparam{rect
}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
1790 pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
1791 can optimize painting by checking for the invalidated region. This parameter is ignored under GTK.
}
1795 Use this function to optimise your scrolling implementations, to minimise the area that must be
1796 redrawn. Note that it is rarely required to call this function from a user program.
1798 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
1800 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
1802 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
1804 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
1806 \func{void
}{SetAutoLayout
}{\param{bool
}{ autoLayout
}}
1808 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
1809 be called automatically when the window is resized. Use in connection with
1810 \helpref{wxWindow::SetSizer
}{wxwindowsetsizer
} and
1811 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
} for laying out subwindows.
1813 \wxheading{Parameters
}
1815 \docparam{autoLayout
}{Set this to TRUE if you wish the Layout function to be called
1816 from within wxWindow::OnSize functions.
}
1818 \wxheading{See also
}
1820 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
1822 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
1824 \func{virtual void
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
1826 Sets the background colour of the window.
1828 \wxheading{Parameters
}
1830 \docparam{colour
}{The colour to be used as the background colour.
}
1834 The background colour is usually painted by the default
\rtfsp
1835 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
} event handler function
1836 under Windows and automatically under GTK.
1838 Note that setting the background colour does not cause an immediate refresh, so you
1839 may wish to call
\helpref{wxWindow::Clear
}{wxwindowclear
} or
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} after
1840 calling this function.
1842 Use this function with care under GTK as the new appearance of the window might
1843 not look equally well when used with "Themes", i.e GTK's ability to change its
1844 look as the user wishes with run-time loadable modules.
1846 \wxheading{See also
}
1848 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
1849 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
1850 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
1851 \helpref{wxWindow::Clear
}{wxwindowclear
},
\rtfsp
1852 \helpref{wxWindow::Refresh
}{wxwindowrefresh
},
\rtfsp
1853 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
1855 \membersection{wxWindow::SetCaret
}\label{wxwindowsetcaret
}
1857 \constfunc{void
}{SetCaret
}{\param{wxCaret *
}{caret
}}
1859 Sets the
\helpref{caret
}{wxcaret
} associated with the window.
1861 \membersection{wxWindow::SetClientSize
}\label{wxwindowsetclientsize
}
1863 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
1865 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
1867 This sets the size of the window client area in pixels. Using this function to size a window
1868 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
1869 worry about what dimensions the border or title bar have when trying to fit the window
1870 around panel items, for example.
1872 \wxheading{Parameters
}
1874 \docparam{width
}{The required client area width.
}
1876 \docparam{height
}{The required client area height.
}
1878 \docparam{size
}{The required client size.
}
1880 \pythonnote{In place of a single overloaded method name, wxPython
1881 implements the following methods:
\par
1882 \indented{2cm
}{\begin{twocollist
}
1883 \twocolitem{{\bf SetClientSize(size)
}}{Accepts a wxSize
}
1884 \twocolitem{{\bf SetClientSizeWH(width, height)
}}{}
1888 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
1890 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
1892 % VZ: the docs are correct, if the code doesn't behave like this, it must be
1894 Sets the window's cursor. Notice that the window cursor also sets it for the
1895 children of the window implicitly.
1897 The
{\it cursor
} may be
{\tt wxNullCursor
} in which case the window cursor will
1898 be reset back to default.
1900 \wxheading{Parameters
}
1902 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
1904 \wxheading{See also
}
1906 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
1908 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
1910 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
1912 Sets the window to have the given layout constraints. The window
1913 will then own the object, and will take care of its deletion.
1914 If an existing layout constraints object is already owned by the
1915 window, it will be deleted.
1917 \wxheading{Parameters
}
1919 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
1924 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
1925 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
1926 explicitly. When setting both a wxLayoutConstraints and a
\helpref{wxSizer
}{wxsizer
}, only the
1927 sizer will have effect.
1929 \membersection{wxWindow::SetDropTarget
}\label{wxwindowsetdroptarget
}
1931 \func{void
}{SetDropTarget
}{\param{wxDropTarget*
}{ target
}}
1933 Associates a drop target with this window.
1935 If the window already has a drop target, it is deleted.
1937 \wxheading{See also
}
1939 \helpref{wxWindow::GetDropTarget
}{wxwindowgetdroptarget
},
1940 \helpref{Drag and drop overview
}{wxdndoverview
}
1942 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
1944 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1946 Sets the event handler for this window.
1948 \wxheading{Parameters
}
1950 \docparam{handler
}{Specifies the handler to be set.
}
1954 An event handler is an object that is capable of processing the events
1955 sent to a window. By default, the window is its own event handler, but
1956 an application may wish to substitute another, for example to allow
1957 central implementation of event-handling for a variety of different
1960 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
1961 this sets up a chain of event handlers, where an event not handled by one event handler is
1962 handed to the next one in the chain.
1964 \wxheading{See also
}
1966 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1967 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1968 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1969 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1970 \helpref{wxEvtHandler
}{wxevthandler
}
1972 \membersection{wxWindow::SetExtraStyle
}\label{wxwindowsetextrastyle
}
1974 \func{void
}{SetExtraStyle
}{\param{long
}{exStyle
}}
1976 Sets the extra style bits for the window. The currently defined extra style
1980 \begin{twocollist
}\itemsep=
0pt
1981 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
1982 and Validate() methods will recursively descend into all children of the
1983 window if it has this style flag set.
}
1986 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
1988 \func{virtual void
}{SetFocus
}{\void}
1990 This sets the window to receive keyboard input.
1992 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
1994 \func{void
}{SetFont
}{\param{const wxFont\&
}{font
}}
1996 Sets the font for this window.
1998 \wxheading{Parameters
}
2000 \docparam{font
}{Font to associate with this window.
}
2002 \wxheading{See also
}
2004 \helpref{wxWindow::GetFont
}{wxwindowgetfont
}
2006 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
2008 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
2010 Sets the foreground colour of the window.
2012 \wxheading{Parameters
}
2014 \docparam{colour
}{The colour to be used as the foreground colour.
}
2018 The interpretation of foreground colour is open to interpretation according
2019 to the window class; it may be the text colour or other colour, or it may not
2022 Note that when using this functions under GTK, you will disable the so called "themes",
2023 i.e. the user chosen apperance of windows and controls, including the themes of
2024 their parent windows.
2026 \wxheading{See also
}
2028 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2029 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2030 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
2032 \membersection{wxWindow::SetHelpText
}\label{wxwindowsethelptext
}
2034 \func{virtual void
}{SetHelpText
}{\param{const wxString\&
}{helpText
}}
2036 Sets the help text to be used as context-sensitive help for this window.
2038 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
2039 and not in the window object itself.
2041 \wxheading{See also
}
2043 \helpref{GetHelpText
}{wxwindowgethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
2045 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
2047 \func{void
}{SetId
}{\param{int
}{ id
}}
2049 Sets the identifier of the window.
2053 Each window has an integer identifier. If the application has not provided one,
2054 an identifier will be generated. Normally, the identifier should be provided
2055 on creation and should not be modified subsequently.
2057 \wxheading{See also
}
2059 \helpref{wxWindow::GetId
}{wxwindowgetid
},
\rtfsp
2060 \helpref{Window identifiers
}{windowids
}
2062 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
2064 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
2066 Sets the window's name.
2068 \wxheading{Parameters
}
2070 \docparam{name
}{A name to set for the window.
}
2072 \wxheading{See also
}
2074 \helpref{wxWindow::GetName
}{wxwindowgetname
}
2076 \membersection{wxWindow::SetPalette
}\label{wxwindowsetpalette
}
2078 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
2080 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
2082 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
2084 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
2085 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
2086 \param{bool
}{refresh = TRUE
}}
2088 Sets the scrollbar properties of a built-in scrollbar.
2090 \wxheading{Parameters
}
2092 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2094 \docparam{position
}{The position of the scrollbar in scroll units.
}
2096 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
2098 \docparam{range
}{The maximum position of the scrollbar.
}
2100 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2104 Let's say you wish to display
50 lines of text, using the same font.
2105 The window is sized so that you can only see
16 lines at a time.
2111 SetScrollbar(wxVERTICAL,
0,
16,
50);
2115 Note that with the window at this size, the thumb position can never go
2116 above
50 minus
16, or
34.
2118 You can determine how many lines are currently visible by dividing the current view
2119 size by the character height in pixels.
2121 When defining your own scrollbar behaviour, you will always need to recalculate
2122 the scrollbar settings when the window size changes. You could therefore put your
2123 scrollbar calculations and SetScrollbar
2124 call into a function named AdjustScrollbars, which can be called initially and also
2125 from your
\helpref{wxWindow::OnSize
}{wxwindowonsize
} event handler function.
2127 \wxheading{See also
}
2129 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
2130 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2133 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
2135 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{bool
}{refresh = TRUE
}}
2137 Sets the page size of one of the built-in scrollbars.
2139 \wxheading{Parameters
}
2141 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2143 \docparam{pageSize
}{Page size in scroll units.
}
2145 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2149 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
2150 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
2151 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
2152 value has to be adjusted when the window is resized, since the page size will have changed.
2154 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
2155 the thumb changes size to reflect the page size relative to the length of the
document. When the
2156 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
2157 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
2160 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
2161 handling of pages and ranges.
2163 \wxheading{See also
}
2165 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2166 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2167 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2168 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2171 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
2173 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{bool
}{refresh = TRUE
}}
2175 Sets the position of one of the built-in scrollbars.
2177 \wxheading{Parameters
}
2179 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2181 \docparam{pos
}{Position in scroll units.
}
2183 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2187 This function does not directly affect the contents of the window: it is up to the
2188 application to take note of scrollbar attributes and redraw contents accordingly.
2190 \wxheading{See also
}
2192 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
2193 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2194 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
2195 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2198 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
2200 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{bool
}{refresh = TRUE
}}
2202 Sets the range of one of the built-in scrollbars.
2204 \wxheading{Parameters
}
2206 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2208 \docparam{range
}{Scroll range.
}
2210 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2214 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
2215 object length of the scrollbar. If you are implementing a scrolling window, for example, you
2216 would adjust the scroll range when the window is resized, by subtracting the window view size from the
2217 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
2218 and usually the scrollbar will be automatically hidden.
2220 \wxheading{See also
}
2222 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2223 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2224 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2225 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2226 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2229 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
2231 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
2232 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
2234 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
2236 Sets the size and position of the window in pixels.
2238 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
2240 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
2242 Sets the size of the window in pixels.
2244 \wxheading{Parameters
}
2246 \docparam{x
}{Required x position in pixels, or -
1 to indicate that the existing
2247 value should be used.
}
2249 \docparam{y
}{Required y position in pixels, or -
1 to indicate that the existing
2250 value should be used.
}
2252 \docparam{width
}{Required width in pixels, or -
1 to indicate that the existing
2253 value should be used.
}
2255 \docparam{height
}{Required height position in pixels, or -
1 to indicate that the existing
2256 value should be used.
}
2258 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
2260 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
2262 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
2264 {\bf wxSIZE
\_AUTO\_WIDTH}: a -
1 width value is taken to indicate
2265 a wxWindows-supplied default width.\\
2266 {\bf wxSIZE
\_AUTO\_HEIGHT}: a -
1 height value is taken to indicate
2267 a wxWindows-supplied default width.\\
2268 {\bf wxSIZE
\_AUTO}: -
1 size values are taken to indicate
2269 a wxWindows-supplied default size.\\
2270 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
2271 if -
1 values are supplied.\\
2272 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow dimensions of -
1 and less to be interpreted
2273 as real dimensions, not default values.
2278 The second form is a convenience for calling the first form with default
2279 x and y parameters, and must be used with non-default width and height values.
2281 The first form sets the position and optionally size, of the window.
2282 Parameters may be -
1 to indicate either that a default should be supplied
2283 by wxWindows, or that the current value of the dimension should be used.
2285 \wxheading{See also
}
2287 \helpref{wxWindow::Move
}{wxwindowmove
}
2289 \pythonnote{In place of a single overloaded method name, wxPython
2290 implements the following methods:
\par
2291 \indented{2cm
}{\begin{twocollist
}
2292 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE
\_AUTO)
}}{}
2293 \twocolitem{{\bf SetSize(size)
}}{}
2294 \twocolitem{{\bf SetPosition(point)
}}{}
2298 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
2300 \func{virtual void
}{SetSizeHints
}{\param{int
}{ minW=-
1},
\param{int
}{ minH=-
1},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1},
2301 \param{int
}{ incW=-
1},
\param{int
}{ incH=-
1}}
2303 Allows specification of minimum and maximum window sizes, and window size increments.
2304 If a pair of values is not set (or set to -
1), the default values will be used.
2306 \wxheading{Parameters
}
2308 \docparam{minW
}{Specifies the minimum width allowable.
}
2310 \docparam{minH
}{Specifies the minimum height allowable.
}
2312 \docparam{maxW
}{Specifies the maximum width allowable.
}
2314 \docparam{maxH
}{Specifies the maximum height allowable.
}
2316 \docparam{incW
}{Specifies the increment for sizing the width (Motif/Xt only).
}
2318 \docparam{incH
}{Specifies the increment for sizing the height (Motif/Xt only).
}
2322 If this function is called, the user will not be able to size the window outside the
2325 The resizing increments are only significant under Motif or Xt.
2327 \membersection{wxWindow::SetSizer
}\label{wxwindowsetsizer
}
2329 \func{void
}{SetSizer
}{\param{wxSizer*
}{sizer
}}
2331 Sets the window to have the given layout sizer. The window
2332 will then own the object, and will take care of its deletion.
2333 If an existing layout constraints object is already owned by the
2334 window, it will be deleted.
2336 \wxheading{Parameters
}
2338 \docparam{sizer
}{The sizer to set. Pass NULL to disassociate and delete the window's
2343 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
2344 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
2345 explicitly. When setting both a wxSizer and a
\helpref{wxLayoutConstraints
}{wxlayoutconstraints
},
2346 only the sizer will have effect.
2348 \membersection{wxWindow::SetTitle
}\label{wxwindowsettitle
}
2350 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{title
}}
2352 Sets the window's title. Applicable only to frames and dialogs.
2354 \wxheading{Parameters
}
2356 \docparam{title
}{The window's title.
}
2358 \wxheading{See also
}
2360 \helpref{wxWindow::GetTitle
}{wxwindowgettitle
}
2362 \membersection{wxWindow::SetValidator
}\label{wxwindowsetvalidator
}
2364 \func{virtual void
}{SetValidator
}{\param{const wxValidator\&
}{ validator
}}
2366 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
2367 create a new validator of this type.
2369 \membersection{wxWindow::SetToolTip
}\label{wxwindowsettooltip
}
2371 \func{void
}{SetToolTip
}{\param{const wxString\&
}{tip
}}
2373 \func{void
}{SetToolTip
}{\param{wxToolTip*
}{tip
}}
2375 Attach a tooltip to the window.
2377 See also:
\helpref{GetToolTip
}{wxwindowgettooltip
},
2378 \helpref{wxToolTip
}{wxtooltip
}
2381 \membersection{wxWindow::GetToolTip
}\label{wxwindowgettooltip
}
2383 \constfunc{wxToolTip*
}{GetToolTip
}{\void}
2385 Get the associated tooltip or NULL if none.
2389 \membersection{wxWindow::SetWindowStyle
}\label{wxwindowsetwindowstyle
}
2391 \func{void
}{SetWindowStyle
}{\param{long
}{ style
}}
2393 Identical to
\helpref{SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
}.
2395 \membersection{wxWindow::SetWindowStyleFlag
}\label{wxwindowsetwindowstyleflag
}
2397 \func{virtual void
}{SetWindowStyleFlag
}{\param{long
}{ style
}}
2399 Sets the style of the window. Please note that some styles cannot be changed
2400 after the window creation and that
\helpref{Refresh()
}{wxwindowrefresh
} might
2401 be called after changing the others for the change to take place immediately.
2403 See
\helpref{Window styles
}{windowstyles
} for more information about flags.
2405 \wxheading{See also
}
2407 \helpref{GetWindowStyleFlag
}{wxwindowgetwindowstyleflag
}
2409 \membersection{wxWindow::Show
}\label{wxwindowshow
}
2411 \func{virtual bool
}{Show
}{\param{bool
}{ show
}}
2413 Shows or hides the window.
2415 \wxheading{Parameters
}
2417 \docparam{show
}{If TRUE, displays the window and brings it to the front. Otherwise,
2420 \wxheading{See also
}
2422 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
2424 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
2426 \func{virtual bool
}{TransferDataFromWindow
}{\void}
2428 Transfers values from child controls to data areas specified by their validators. Returns
2429 FALSE if a transfer failed.
2431 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2432 the method will also call TransferDataFromWindow() of all child windows.
2434 \wxheading{See also
}
2436 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
2437 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
2439 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
2441 \func{virtual bool
}{TransferDataToWindow
}{\void}
2443 Transfers values to child controls from data areas specified by their validators.
2445 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2446 the method will also call TransferDataToWindow() of all child windows.
2448 \wxheading{Return value
}
2450 Returns FALSE if a transfer failed.
2452 \wxheading{See also
}
2454 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2455 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
2457 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
2459 \func{virtual bool
}{Validate
}{\void}
2461 Validates the current values of the child controls using their validators.
2463 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2464 the method will also call Validate() of all child windows.
2466 \wxheading{Return value
}
2468 Returns FALSE if any of the validations failed.
2470 \wxheading{See also
}
2472 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2473 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2474 \helpref{wxValidator
}{wxvalidator
}
2476 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
2478 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
2480 Moves the pointer to the given position on the window.
2482 \wxheading{Parameters
}
2484 \docparam{x
}{The new x position for the cursor.
}
2486 \docparam{y
}{The new y position for the cursor.
}