1 \section{\class{wxWindow
}}\label{wxwindow
}
3 wxWindow is the base class for all windows. Any
4 children of the window will be deleted automatically by the destructor
5 before the window itself is deleted.
7 \wxheading{Derived from
}
9 \helpref{wxEvtHandler
}{wxevthandler
}\\
10 \helpref{wxObject
}{wxobject
}
12 \wxheading{Window styles
}
14 The following styles can apply to all windows, although they will not always make sense for a particular
18 \begin{twocollist
}\itemsep=
0pt
19 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
21 \twocolitem{\windowstyle{wxDOUBLE
\_BORDER}}{Displays a double border. Windows only.
}
22 \twocolitem{\windowstyle{wxSUNKEN
\_BORDER}}{Displays a sunken border.
}
23 \twocolitem{\windowstyle{wxRAISED
\_BORDER}}{Displays a raised border.
}
24 \twocolitem{\windowstyle{wxSTATIC
\_BORDER}}{Displays a border suitable for a static control.
}
25 \twocolitem{\windowstyle{wxTRANSPARENT
\_WINDOW}}{The window is transparent, that is, it will not receive paint
26 events. Windows only.
}
27 \twocolitem{\windowstyle{wxNO
\_3D}}{Prevents the children of this window taking on
3D styles, even though
28 the application-wide policy is for
3D controls. Windows only.
}
29 \twocolitem{\windowstyle{wxTAB
\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.
}
30 \twocolitem{\windowstyle{wxVSCROLL
}}{Use this style to enable a vertical scrollbar.
}
31 \twocolitem{\windowstyle{wxHSCROLL
}}{Use this style to enable a horizontal scrollbar.
}
32 \twocolitem{\windowstyle{wxCLIP
\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
33 repainted, then children being painted over them. Windows-only.
}
36 See also
\helpref{window styles overview
}{windowstyles
}.
40 \helpref{Event handling overview
}{eventhandlingoverview
}
42 \latexignore{\rtfignore{\wxheading{Members
}}}
44 \membersection{wxWindow::wxWindow
}
46 \func{}{wxWindow
}{\void}
50 \func{}{wxWindow
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
51 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
52 \param{const wxSize\&
}{size = wxDefaultSize
},
53 \param{long
}{style =
0},
54 \param{const wxString\&
}{name = wxPanelNameStr
}}
56 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
58 \wxheading{Parameters
}
60 \docparam{parent
}{Pointer to a parent window.
}
62 \docparam{id
}{Window identifier. If -
1, will automatically create an identifier.
}
64 \docparam{pos
}{Window position. wxDefaultPosition is (-
1, -
1) which indicates that wxWindows
65 should generate a default position for the window. If using the wxWindow class directly, supply
68 \docparam{size
}{Window size. wxDefaultSize is (-
1, -
1) which indicates that wxWindows
69 should generate a default size for the window.
}
71 \docparam{style
}{Window style. For generic window styles, please see
\helpref{wxWindow
}{wxwindow
}.
}
73 \docparam{name
}{Window name.
}
75 \membersection{wxWindow::
\destruct{wxWindow
}}
77 \func{}{\destruct{wxWindow
}}{\void}
79 Destructor. Deletes all subwindows, then deletes itself. Instead of using
80 the
{\bf delete
} operator explicitly, you should normally
81 use
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} so that wxWindows
82 can delete a window only when it is safe to do so, in idle time.
86 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
87 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
88 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
89 \helpref{wxCloseEvent
}{wxcloseevent
}
91 \membersection{wxWindow::AddChild
}
93 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
95 Adds a child window. This is called automatically by window creation
96 functions so should not be required by the application programmer.
98 \wxheading{Parameters
}
100 \docparam{child
}{Child window to add.
}
102 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
104 \func{virtual void
}{CaptureMouse
}{\void}
106 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
111 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
113 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
115 \func{void
}{Center
}{\param{int
}{ direction
}}
117 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
119 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
121 \func{virtual void
}{Centre
}{\param{int
}{ direction = wxHORIZONTAL
}}
125 \wxheading{Parameters
}
127 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
132 The actual behaviour depends on the derived window. For a frame or dialog box,
133 centring is relative to the whole display. For a panel item, centring is
134 relative to the panel.
138 \helpref{wxWindow::Center
}{wxwindowcenter
}
140 \membersection{wxWindow::Clear
}\label{wxwindowclear
}
142 \func{void
}{Clear
}{\void}
144 Clears the window by filling it with the current background colour.
146 \membersection{wxWindow::ClientToScreen
}
148 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
150 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
152 Converts to screen coordinates from coordinates relative to this window.
154 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
155 a screen coordinate will be passed out.
}
157 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
158 a screen coordinate will be passed out.
}
160 \docparam{pt
}{The client position for the second form of the function.
}
162 \membersection{wxWindow::Close
}\label{wxwindowclose
}
164 \func{virtual bool
}{Close
}{\param{const bool
}{ force = FALSE
}}
166 The purpose of this call is to provide a safer way of destroying a window than using
167 the
{\it delete
} operator.
169 \wxheading{Parameters
}
171 \docparam{force
}{FALSE if the window's close handler should be able to veto the destruction
172 of this window, TRUE if it cannot.
}
176 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing an opportunity for the window to
177 choose whether to destroy the window.
179 The close handler should check whether the window is being deleted forcibly,
180 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}, in which case it should
181 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
183 Applies to managed windows (wxFrame and wxDialog classes) only.
187 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
188 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
189 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
190 \helpref{wxCloseEvent
}{wxcloseevent
}
192 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
194 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
196 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
198 Converts a point or size from dialog units to pixels.
200 For the x dimension, the dialog units are multiplied by the average character width
201 and then divided by
4.
203 For the y dimension, the dialog units are multiplied by the average character height
204 and then divided by
8.
208 Dialog units are used for maintaining a dialog's proportions even if the font changes.
209 Dialogs created using Dialog Editor optionally use dialog units.
211 You can also use these functions programmatically. A convenience macro is defined:
215 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
221 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
223 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
225 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
227 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
229 Converts a point or size from pixels to dialog units.
231 For the x dimension, the pixels are multiplied by
4 and then divided by the average
234 For the y dimension, the pixels are multipled by
8 and then divided by the average
239 Dialog units are used for maintaining a dialog's proportions even if the font changes.
240 Dialogs created using Dialog Editor optionally use dialog units.
244 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
246 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
248 \func{virtual bool
}{Destroy
}{\void}
250 Destroys the window safely. Use this function instead of the delete operator, since
251 different window classes can be destroyed differently. Frames and dialogs
252 are not destroyed immediately when this function is called - they are added
253 to a list of windows to be deleted on idle time, when all the window's events
254 have been processed. This prevents problems with events being sent to non-existant
257 \wxheading{Return value
}
259 TRUE if the window has either been successfully deleted, or it has been added
260 to the list of windows pending real deletion.
262 \membersection{wxWindow::DestroyChildren
}
264 \func{virtual void
}{DestroyChildren
}{\void}
266 Destroys all children of a window. Called automatically by the destructor.
268 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
270 \func{virtual void
}{DragAcceptFiles
}{\param{const bool
}{ accept
}}
272 Enables or disables elibility for drop file events (OnDropFiles).
274 \wxheading{Parameters
}
276 \docparam{accept
}{If TRUE, the window is eligible for drop file events. If FALSE, the window
277 will not accept drop file events.
}
285 \helpref{wxWindow::OnDropFiles
}{wxwindowondropfiles
}
287 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
289 \func{virtual void
}{Enable
}{\param{const bool
}{ enable
}}
291 Enable or disable the window for user input.
293 \wxheading{Parameters
}
295 \docparam{enable
}{If TRUE, enables the window for input. If FALSE, disables the window.
}
299 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
}
301 \membersection{wxWindow::FakePopupMenu
}\label{wxwindowfakepopupmenu
}
303 \func{virtual bool
}{FakePopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
305 A replacement for wxWindow::PopupMenu for cases where the PopupMenu implementation
306 does not work correctly, in particular on Motif platforms.
308 \wxheading{Parameters
}
310 \docparam{menu
}{Menu to pop up.
}
312 \docparam{x
}{Required x position for the menu to appear.
}
314 \docparam{y
}{Required y position for the menu to appear.
}
318 This is a cut-down version of PopupMenu using a dialog and listbox; pull-right menus
323 \helpref{wxMenu
}{wxmenu
},
\helpref{wxWindow::PopupMenu
}{wxwindowpopupmenu
}
325 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
327 \func{static wxWindow*
}{FindFocus
}{\void}
329 Finds the window or control which currently has the keyboard focus.
333 Note that this is a static function, so it can be called without needing a wxWindow pointer.
337 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
339 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
341 \func{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
343 Find a child of this window, by identifier.
345 \func{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
347 Find a child of this window, by name.
349 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
351 \func{virtual void
}{Fit
}{\void}
353 Sizes the window so that it fits around its subwindows.
355 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
357 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
359 Returns the background colour of the window.
363 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
364 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
365 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
366 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
368 \membersection{wxWindow::GetCharHeight
}
370 \constfunc{virtual int
}{GetCharHeight
}{\void}
372 Returns the character height for this window.
374 \membersection{wxWindow::GetCharWidth
}
376 \constfunc{virtual int
}{GetCharWidth
}{\void}
378 Returns the average character width for this window.
380 \membersection{wxWindow::GetChildren
}
382 \func{wxList\&
}{GetChildren
}{\void}
384 Returns a reference to the list of the window's children.
386 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
388 \constfunc{virtual void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
390 \constfunc{virtual wxSize
}{GetClientSize
}{\void}
392 This gets the size of the window `client area' in pixels. The client area is the
393 area which may be drawn on by the programmer, excluding title bar, border etc.
395 \wxheading{Parameters
}
397 \docparam{width
}{Receives the client width in pixels.
}
399 \docparam{height
}{Receives the client height in pixels.
}
401 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
403 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
405 Returns a pointer to the window's layout constraints, or NULL if there are none.
407 \membersection{wxWindow::GetDefaultItem
}\label{wxwindowgetdefaultitem
}
409 \constfunc{wxButton*
}{GetDefaultItem
}{\void}
411 Returns a pointer to the button which is the default for this window, or NULL.
413 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
415 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
417 Returns the event handler for this window. By default, the window is its
422 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
423 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
424 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
425 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
426 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
428 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
430 \constfunc{wxFont\&
}{GetFont
}{\void}
432 Returns a reference to the font for this window.
436 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
438 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
440 \func{virtual wxColour
}{GetForegroundColour
}{\void}
442 Returns the foreground colour of the window.
446 The interpretation of foreground colour is open to interpretation according
447 to the window class; it may be the text colour or other colour, or it may not
452 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
453 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
454 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
456 \membersection{wxWindow::GetGrandParent
}
458 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
460 Returns the grandparent of a window, or NULL if there isn't one.
462 \membersection{wxWindow::GetHandle
}
464 \constfunc{void*
}{GetHandle
}{\void}
466 Returns the platform-specific handle of the physical window. Cast it to an appropriate
467 handle, such as
{\bf HWND
} for Windows or
{\bf Widget
} for Motif.
469 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
471 \constfunc{int
}{GetId
}{\void}
473 Returns the identifier of the window.
477 Each window has an integer identifier. If the application has not provided one,
478 an identifier will be generated.
480 TODO: perhaps there should be a default identifier for each class, rather
481 choosing one, which could clash with other ones.
485 \helpref{wxWindow::SetId
}{wxwindowsetid
}
487 \membersection{wxWindow::GetPosition
}
489 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
491 This gets the position of the window in pixels, relative to the parent window or
492 if no parent, relative to the whole display.
494 \wxheading{Parameters
}
496 \docparam{x
}{Receives the x position of the window.
}
498 \docparam{y
}{Receives the y position of the window.
}
500 \membersection{wxWindow::GetLabel
}
502 \constfunc{virtual wxString\&
}{GetLabel
}{\void}
504 Generic way of getting a label from any window, for
505 identification purposes.
509 The interpretation of this function differs from class to class.
510 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
511 the button text. This function can be useful for meta-programs (such as testing
512 tools or special-needs access programs) which need to identify windows
515 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
517 \constfunc{virtual wxString\&
}{GetName
}{\void}
519 Returns the window's name.
523 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
524 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
528 \helpref{wxWindow::SetName
}{wxwindowsetname
}
530 \membersection{wxWindow::GetParent
}
532 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
534 Returns the parent of the window, or NULL if there is no parent.
536 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
538 \constfunc{virtual wxRect
}{GetRect
}{\void}
540 Returns the size and position of the window as a
\helpref{wxRect
}{wxrect
} object.
542 \membersection{wxWindow::GetReturnCode
}\label{wxwindowgetreturncode
}
544 \func{int
}{GetReturnCode
}{\void}
546 Gets the return code for this window.
550 A return code is normally associated with a modal dialog, where
\helpref{wxDialog::ShowModal
}{wxdialogshowmodal
} returns
551 a code to the application.
555 \helpref{wxWindow::SetReturnCode
}{wxwindowsetreturncode
},
\helpref{wxDialog::ShowModal
}{wxdialogshowmodal
},
\rtfsp
556 \helpref{wxDialog::EndModal
}{wxdialogendmodal
}
558 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
560 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
562 Returns the built-in scrollbar thumb size.
566 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
568 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
570 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
572 Returns the built-in scrollbar position.
576 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
578 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
580 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
582 Returns the built-in scrollbar range.
586 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
588 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
590 \constfunc{virtual void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
592 \constfunc{virtual wxSize
}{GetSize
}{\void}
594 This gets the size of the entire window in pixels.
596 \wxheading{Parameters
}
598 \docparam{width
}{Receives the window width.
}
600 \docparam{height
}{Receives the window height.
}
602 \membersection{wxWindow::GetTextExtent
}
604 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{x
},
\param{int*
}{y
},
605 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
606 \param{const wxFont*
}{font = NULL
},
\param{const bool
}{ use16 = FALSE
}}
608 Gets the dimensions of the string as it would be drawn on the
609 window with the currently selected font.
611 \wxheading{Parameters
}
613 \docparam{string
}{String whose extent is to be measured.
}
615 \docparam{x
}{Return value for width.
}
617 \docparam{y
}{Return value for height.
}
619 \docparam{descent
}{Return value for descent (optional).
}
621 \docparam{externalLeading
}{Return value for external leading (optional).
}
623 \docparam{font
}{Font to use instead of the current window font (optional).
}
625 \docparam{use16
}{If TRUE,
{\it string
} contains
16-bit characters. The default is FALSE.
}
627 \membersection{wxWindow::GetTitle
}\label{wxwindowgettitle
}
629 \func{virtual wxString
}{GetTitle
}{\void}
631 Gets the window's title. Applicable only to frames and dialogs.
635 \helpref{wxWindow::SetTitle
}{wxwindowsettitle
}
637 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
639 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
641 Returns the region specifying which parts of the window have been damaged. Should
642 only be called within an
\helpref{OnPaint
}{wxwindowonpaint
} event handler.
646 \helpref{wxRegion
}{wxregion
},
\helpref{wxRegionIterator
}{wxregioniterator
},
\helpref{wxWindow::OnPaint
}{wxwindowonpaint
}
648 \membersection{wxWindow::GetWindowStyleFlag
}
650 \constfunc{long
}{GetWindowStyleFlag
}{\void}
652 Gets the window style that was passed to the consructor or
{\bf Create
} member.
654 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
656 \func{void
}{InitDialog
}{\void}
658 Sends an
\helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
} event, which
659 in turn transfers data to the dialog via validators.
663 \helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
}
665 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
667 \constfunc{virtual bool
}{IsEnabled
}{\void}
669 Returns TRUE if the window is enabled for input, FALSE otherwise.
673 \helpref{wxWindow::Enable
}{wxwindowenable
}
675 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
677 \constfunc{virtual bool
}{IsRetained
}{\void}
679 Returns TRUE if the window is retained, FALSE otherwise.
683 Retained windows are only available on X platforms.
685 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
687 \constfunc{virtual bool
}{IsShown
}{\void}
689 Returns TRUE if the window is shown, FALSE if it has been hidden.
691 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
693 \func{void
}{Layout
}{\void}
695 Invokes the constraint-based layout algorithm for this window. It is called
696 automatically by the default
{\bf wxWindow::OnSize
} member.
698 \membersection{wxWindow::LoadFromResource
}\label{wxwindowloadfromresource
}
700 \func{virtual bool
}{LoadFromResource
}{\param{wxWindow*
}{parent
},
\rtfsp
701 \param{const wxString\&
}{resourceName
},
\param{const wxResourceTable*
}{resourceTable = NULL
}}
703 Loads a panel or dialog from a resource file.
705 \wxheading{Parameters
}
707 \docparam{parent
}{Parent window.
}
709 \docparam{resourceName
}{The name of the resource to load.
}
711 \docparam{resourceTable
}{The resource table to load it from. If this is NULL, the
712 default resource table will be used.
}
714 \wxheading{Return value
}
716 TRUE if the operation succeeded, otherwise FALSE.
726 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
728 \func{void
}{Lower
}{\void}
730 Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
733 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
735 \func{virtual void
}{MakeModal
}{\param{const bool
}{flag
}}
737 Disables all other windows in the application so that
738 the user can only interact with this window.
740 \wxheading{Parameters
}
742 \docparam{flag
}{If TRUE, this call disables all other windows in the application so that
743 the user can only interact with this window. If FALSE, the effect is reversed.
}
745 \membersection{wxWindow::Move
}\label{wxwindowmove
}
747 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
749 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
751 Moves the window to the given position.
753 \wxheading{Parameters
}
755 \docparam{x
}{Required x position.
}
757 \docparam{y
}{Required y position.
}
759 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
763 Implementations of SetSize can also implicitly implement the
764 wxWindow::Move function, which is defined in the base wxWindow class
768 SetSize(x, y, -
1, -
1, wxSIZE_USE_EXISTING);
773 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
775 \membersection{wxWindow::OnActivate
}\label{wxwindowonactivate
}
777 \func{void
}{OnActivate
}{\param{wxActivateEvent\&
}{ event
}}
779 Called when a window is activated or deactivated.
781 \wxheading{Parameters
}
783 \docparam{event
}{Object containing activation information.
}
787 If the window is being activated,
\helpref{wxActivateEvent::GetActive
}{wxactivateeventgetactive
} returns TRUE,
788 otherwise it returns FALSE (it is being deactivated).
792 \helpref{wxActivateEvent
}{wxactivateevent
},
\rtfsp
793 \helpref{Event handling overview
}{eventhandlingoverview
}
795 \membersection{wxWindow::OnChar
}\label{wxwindowonchar
}
797 \func{void
}{OnChar
}{\param{wxKeyEvent\&
}{ event
}}
799 Called when the user has pressed a key.
801 \wxheading{Parameters
}
803 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
804 details about this class.
}
808 This member function is called in response to a keypress. To intercept this event,
809 use the EVT
\_CHAR macro in an event table definition. Your
{\bf OnChar
} handler may call this
810 default function to achieve default keypress functionality.
812 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
815 Most, but not all, windows allow keypresses to be intercepted.
819 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
820 \helpref{Event handling overview
}{eventhandlingoverview
}
822 \membersection{wxWindow::OnCharHook
}\label{wxwindowoncharhook
}
824 \func{void
}{OnCharHook
}{\param{wxKeyEvent\&
}{ event
}}
826 This member is called to allow the window to intercept keyboard events
827 before they are processed by child windows.
829 \wxheading{Parameters
}
831 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
832 details about this class.
}
836 This member function is called in response to a keypress, if the window is active. To intercept this event,
837 use the EVT
\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
838 keypress, call
\helpref{wxEvent::Skip
}{wxeventskip
} to allow default processing.
840 An example of using this function is in the implementation of escape-character processing for wxDialog,
841 where pressing ESC dismisses the dialog by
{\bf OnCharHook
} 'forging' a cancel button press event.
843 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
846 This function is only relevant to top-level windows (frames and dialogs), and under
851 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
852 \helpref{wxApp::OnCharHook
}{wxapponcharhook
},
\rtfsp
853 \helpref{Event handling overview
}{eventhandlingoverview
}
855 \membersection{wxWindow::OnCommand
}\label{wxwindowoncommand
}
857 \func{virtual void
}{OnCommand
}{\param{wxEvtHandler\&
}{object
},
\param{wxCommandEvent\&
}{event
}}
859 This virtual member function is called if the control does not handle the command event.
861 \wxheading{Parameters
}
863 \docparam{object
}{Object receiving the command event.
}
865 \docparam{event
}{Command event
}
869 This virtual function is provided mainly for backward compatibility. You can also intercept commands
870 from child controls by using an event table, with identifiers or identifier ranges to identify
871 the control(s) in question.
875 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
876 \helpref{Event handling overview
}{eventhandlingoverview
}
878 \membersection{wxWindow::OnClose
}\label{wxwindowonclose
}
880 \func{virtual bool
}{OnClose
}{\void}
882 Called when the user has tried to close a a frame
883 or dialog box using the window manager (X) or system menu (Windows).
885 {\bf Note:
} This is an obsolete function retained for backward compatibility.
886 It is superceded by the
\helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
} event
889 \wxheading{Return value
}
891 If TRUE is returned by OnClose, the window will be deleted by the system, otherwise the
892 attempt will be ignored. Do not delete the window from within this handler, although
893 you may delete other windows.
897 Derive your own class to handle this message. The default handler returns TRUE.
901 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
902 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
903 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
904 \helpref{wxCloseEvent
}{wxcloseevent
}
906 \membersection{wxWindow::OnCloseWindow
}\label{wxwindowonclosewindow
}
908 \func{void
}{OnCloseWindow
}{\param{wxCloseEvent\&
}{event
}}
910 This is an event handler function called when the user has tried to close a a frame
911 or dialog box using the window manager (X) or system menu (Windows). It is
912 called via the
\helpref{wxWindow::Close
}{wxwindowclose
} function, so
913 that the application can also invoke the handler programmatically.
915 Use the EVT
\_CLOSE event table macro to handle close events.
917 You should check whether the application is forcing the deletion of the window
918 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}. If this is TRUE,
919 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
920 If not, it is up to you whether you respond by destroying the window.
922 (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
923 the window is required, test for the negative of CanVeto. If CanVeto returns FALSE,
924 it is not possible to skip window deletion.)
926 If you don't destroy the window, you should call
\helpref{wxCloseEvent::Veto
}{wxcloseeventveto
} to
927 let the calling code know that you did not destroy the window. This allows the
\helpref{wxWindow::Close
}{wxwindowclose
} function
928 to return TRUE or FALSE depending on whether the close instruction was honoured or not.
932 The
\helpref{wxWindow::OnClose
}{wxwindowonclose
} virtual function remains
933 for backward compatibility with earlier versions of wxWindows. The
934 default
{\bf OnCloseWindow
} handler for wxFrame and wxDialog will call
{\bf OnClose
},
935 destroying the window if it returns TRUE or if the close is being forced.
939 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
940 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
941 \helpref{wxWindow::OnClose
}{wxwindowonclose
},
\rtfsp
942 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
943 \helpref{wxCloseEvent
}{wxcloseevent
},
\rtfsp
944 \helpref{wxApp::OnQueryEndSession
}{wxapponqueryendsession
},
\rtfsp
945 \helpref{wxApp::OnEndSession
}{wxapponendsession
}
947 \membersection{wxWindow::OnDropFiles
}\label{wxwindowondropfiles
}
949 \func{void
}{OnDropFiles
}{\param{wxDropFilesEvent\&
}{ event
}}
951 Called when files have been dragged from the file manager to the window.
953 \wxheading{Parameters
}
955 \docparam{event
}{Drop files event. For more information, see
\helpref{wxDropFilesEvent
}{wxdropfilesevent
}.
}
959 The window must have previously been enabled for dropping by calling
960 \rtfsp\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
}.
962 This event is only generated under Windows.
964 To intercept this event, use the EVT
\_DROP\_FILES macro in an event table definition.
968 \helpref{wxDropFilesEvent
}{wxdropfilesevent
},
\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
},
\rtfsp
969 \helpref{Event handling overview
}{eventhandlingoverview
}
971 \membersection{wxWindow::OnEraseBackground
}\label{wxwindowonerasebackground
}
973 \func{void
}{OnEraseBackground
}{\param{wxEraseEvent\&
}{ event
}}
975 Called when the background of the window needs to be erased.
977 \wxheading{Parameters
}
979 \docparam{event
}{Erase background event. For more information, see
\helpref{wxEraseEvent
}{wxeraseevent
}.
}
983 This event is only generated under Windows.
985 To intercept this event, use the EVT
\_ERASE\_BACKGROUND macro in an event table definition.
989 \helpref{wxEraseEvent
}{wxeraseevent
},
\helpref{Event handling overview
}{eventhandlingoverview
}
991 \membersection{wxWindow::OnKillFocus
}\label{wxwindowonkillfocus
}
993 \func{void
}{OnKillFocus
}{\param{wxFocusEvent\&
}{event
}}
995 Called when a window's focus is being killed.
997 \wxheading{Parameters
}
999 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1003 To intercept this event, use the macro EVT
\_KILL\_FOCUS in an event table definition.
1005 Most, but not all, windows respond to this event.
1007 \wxheading{See also
}
1009 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnSetFocus
}{wxwindowonsetfocus
},
\rtfsp
1010 \helpref{Event handling overview
}{eventhandlingoverview
}
1012 \membersection{wxWindow::OnIdle
}\label{wxwindowonidle
}
1014 \func{void
}{OnIdle
}{\param{wxIdleEvent\&
}{event
}}
1016 Provide this member function for any processing which needs to be done
1017 when the application is idle.
1019 \wxheading{See also
}
1021 \helpref{wxApp::OnIdle
}{wxapponidle
},
\helpref{wxIdleEvent
}{wxidleevent
}
1023 \membersection{wxWindow::OnInitDialog
}\label{wxwindowoninitdialog
}
1025 \func{void
}{OnInitDialog
}{\param{wxInitDialogEvent\&
}{ event
}}
1027 Default handler for the wxEVT
\_INIT\_DIALOG event. Calls
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}.
1029 \wxheading{Parameters
}
1031 \docparam{event
}{Dialog initialisation event.
}
1035 Gives the window the default behaviour of transferring data to child controls via
1036 the validator that each control has.
1038 \wxheading{See also
}
1040 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}
1042 \membersection{wxWindow::OnMenuCommand
}\label{wxwindowonmenucommand
}
1044 \func{void
}{OnMenuCommand
}{\param{wxCommandEvent\&
}{event
}}
1046 Called when a menu command is received from a menu bar.
1048 \wxheading{Parameters
}
1050 \docparam{event
}{The menu command event. For more information, see
\helpref{wxCommandEvent
}{wxcommandevent
}.
}
1054 A function with this name doesn't actually exist; you can choose any member function to receive
1055 menu command events, using the EVT
\_COMMAND macro for individual commands or EVT
\_COMMAND\_RANGE for
1056 a range of commands.
1058 \wxheading{See also
}
1060 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
1061 \helpref{wxWindow::OnMenuHighlight
}{wxwindowonmenuhighlight
},
\rtfsp
1062 \helpref{Event handling overview
}{eventhandlingoverview
}
1064 \membersection{wxWindow::OnMenuHighlight
}\label{wxwindowonmenuhighlight
}
1066 \func{void
}{OnMenuHighlight
}{\param{wxMenuEvent\&
}{event
}}
1068 Called when a menu select is received from a menu bar: that is, the
1069 mouse cursor is over a menu item, but the left mouse button has not been
1072 \wxheading{Parameters
}
1074 \docparam{event
}{The menu highlight event. For more information, see
\helpref{wxMenuEvent
}{wxmenuevent
}.
}
1078 You can choose any member function to receive
1079 menu select events, using the EVT
\_MENU\_HIGHLIGHT macro for individual menu items or EVT
\_MENU\_HIGHLIGHT\_ALL macro
1082 The default implementation for
\helpref{wxFrame::OnMenuHighlight
}{wxframeonmenuhighlight
} displays help
1083 text in the first field of the status bar.
1085 This function was known as
{\bf OnMenuSelect
} in earlier versions of wxWindows, but this was confusing
1086 since a selection is normally a left-click action.
1088 \wxheading{See also
}
1090 \helpref{wxMenuEvent
}{wxmenuevent
},
\rtfsp
1091 \helpref{wxWindow::OnMenuCommand
}{wxwindowonmenucommand
},
\rtfsp
1092 \helpref{Event handling overview
}{eventhandlingoverview
}
1095 \membersection{wxWindow::OnMouseEvent
}\label{wxwindowonmouseevent
}
1097 \func{void
}{OnMouseEvent
}{\param{wxMouseEvent\&
}{ event
}}
1099 Called when the user has initiated an event with the
1102 \wxheading{Parameters
}
1104 \docparam{event
}{The mouse event. See
\helpref{wxMouseEvent
}{wxmouseevent
} for
1109 Most, but not all, windows respond to this event.
1111 To intercept this event, use the EVT
\_MOUSE\_EVENTS macro in an event table definition, or individual
1112 mouse event macros such as EVT
\_LEFT\_DOWN.
1114 \wxheading{See also
}
1116 \helpref{wxMouseEvent
}{wxmouseevent
},
\rtfsp
1117 \helpref{Event handling overview
}{eventhandlingoverview
}
1119 \membersection{wxWindow::OnMove
}\label{wxwindowonmove
}
1121 \func{void
}{OnMove
}{\param{wxMoveEvent\&
}{event
}}
1123 Called when a window is moved.
1125 \wxheading{Parameters
}
1127 \docparam{event
}{The move event. For more information, see
\helpref{wxMoveEvent
}{wxmoveevent
}.
}
1131 Use the EVT
\_MOVE macro to intercept move events.
1135 Not currently implemented.
1137 \wxheading{See also
}
1139 \helpref{wxMoveEvent
}{wxmoveevent
},
\rtfsp
1140 \helpref{wxFrame::OnSize
}{wxframeonsize
},
\rtfsp
1141 \helpref{Event handling overview
}{eventhandlingoverview
}
1143 \membersection{wxWindow::OnPaint
}\label{wxwindowonpaint
}
1145 \func{void
}{OnPaint
}{\param{wxPaintEvent\&
}{event
}}
1147 Sent to the event handler when the window must be refreshed.
1149 \wxheading{Parameters
}
1151 \docparam{event
}{Paint event. For more information, see
\helpref{wxPaintEvent
}{wxpaintevent
}.
}
1155 Use the EVT
\_PAINT macro in an event table definition to intercept paint events.
1157 In a paint event handler, the application should always create a
\helpref{wxPaintDC
}{wxpaintdc
} object.
1163 void MyWindow::OnPaint(wxPaintEvent& event)
1172 You can optimize painting by retrieving the rectangles
1173 that have been damaged and only repainting these. The rectangles are in
1174 terms of the client area, and are unscrolled, so you will need to do
1175 some calculations using the current view position to obtain logical,
1178 Here is an example of using the
\helpref{wxRegionIterator
}{wxregioniterator
} class:
1182 // Called when window needs to be repainted.
1183 void MyWindow::OnPaint(wxPaintEvent& event)
1187 // Find Out where the window is scrolled to
1188 int vbX,vbY; // Top left corner of client
1189 ViewStart(&vbX,&vbY);
1191 int vX,vY,vW,vH; // Dimensions of client area in pixels
1192 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1201 // Alternatively we can do this:
1203 // upd.GetRect(&rect);
1205 // Repaint this rectangle
1214 \wxheading{See also
}
1216 \helpref{wxPaintEvent
}{wxpaintevent
},
\rtfsp
1217 \helpref{wxPaintDC
}{wxpaintdc
},
\rtfsp
1218 \helpref{Event handling overview
}{eventhandlingoverview
}
1220 \func{void
}{OnScroll
}{\param{wxScrollEvent\&
}{event
}}
1222 Called when a scroll event is received from one of the window's built-in scrollbars.
1224 \wxheading{Parameters
}
1226 \docparam{event
}{Command event. Retrieve the new scroll position by
1227 calling
\helpref{wxScrollEvent::GetPosition
}{wxscrolleventgetposition
}, and the
1228 scrollbar orientation by calling
\helpref{wxScrollEvent::GetOrientation
}{wxscrolleventgetorientation
}.
}
1232 Note that it is not possible to distinguish between horizontal and vertical scrollbars
1233 until the function is executing (you can't have one function for vertical, another
1234 for horizontal events).
1236 \wxheading{See also
}
1238 \helpref{wxScrollEvent
}{wxscrollevent
},
\rtfsp
1239 \helpref{Event handling overview
}{eventhandlingoverview
}
1241 \membersection{wxWindow::OnSetFocus
}\label{wxwindowonsetfocus
}
1243 \func{void
}{OnSetFocus
}{\param{wxFocusEvent\&
}{event
}}
1245 Called when a window's focus is being set.
1247 \wxheading{Parameters
}
1249 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1253 To intercept this event, use the macro EVT
\_SET\_FOCUS in an event table definition.
1255 Most, but not all, windows respond to this event.
1257 \wxheading{See also
}
1259 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnKillFocus
}{wxwindowonkillfocus
},
\rtfsp
1260 \helpref{Event handling overview
}{eventhandlingoverview
}
1262 \membersection{wxWindow::OnSize
}\label{wxwindowonsize
}
1264 \func{void
}{OnSize
}{\param{wxSizeEvent\&
}{event
}}
1266 Called when the window has been resized.
1268 \wxheading{Parameters
}
1270 \docparam{event
}{Size event. For more information, see
\helpref{wxSizeEvent
}{wxsizeevent
}.
}
1274 You may wish to use this for frames to resize their child windows as appropriate.
1276 Note that the size passed is of
1277 the whole window: call
\helpref{wxWindow::GetClientSize
}{wxwindowgetclientsize
} for the area which may be
1278 used by the application.
1280 \wxheading{See also
}
1282 \helpref{wxSizeEvent
}{wxsizeevent
},
\rtfsp
1283 \helpref{Event handling overview
}{eventhandlingoverview
}
1285 \membersection{wxWindow::OnSysColourChanged
}\label{wxwindowonsyscolourchanged
}
1287 \func{void
}{OnSysColourChanged
}{\param{wxOnSysColourChangedEvent\&
}{event
}}
1289 Called when the user has changed the system colours.
1291 \wxheading{Parameters
}
1293 \docparam{event
}{System colour change event. For more information, see
\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}.
}
1295 \wxheading{See also
}
1297 \helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
},
\rtfsp
1298 \helpref{Event handling overview
}{eventhandlingoverview
}
1300 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
1302 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler = FALSE
}}
1304 Removes and returns the top-most event handler on the event handler stack.
1306 \wxheading{Parameters
}
1308 \docparam{deleteHandler
}{If this is TRUE, the handler will be deleted after it is removed. The
1309 default value is FALSE.
}
1311 \wxheading{See also
}
1313 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1314 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1315 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1316 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1317 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
1319 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
1321 \func{virtual bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
1323 Pops up the given menu at the specified coordinates, relative to this
1324 window, and returns control when the user has dismissed the menu. If a
1325 menu item is selected, the callback defined for the menu is called with
1326 wxMenu and wxCommandEvent reference arguments. The callback should access
1327 the commandInt member of the event to check the selected menu identifier.
1329 \wxheading{Parameters
}
1331 \docparam{menu
}{Menu to pop up.
}
1333 \docparam{x
}{Required x position for the menu to appear.
}
1335 \docparam{y
}{Required y position for the menu to appear.
}
1337 \wxheading{See also
}
1339 \helpref{wxMenu
}{wxmenu
},
\helpref{wxWindow::FakePopupMenu
}{wxwindowfakepopupmenu
}
1341 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
1343 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1345 Pushes this event handler onto the event stack for the window.
1347 \wxheading{Parameters
}
1349 \docparam{handler
}{Specifies the handler to be pushed.
}
1353 An event handler is an object that is capable of processing the events
1354 sent to a window. By default, the window is its own event handler, but
1355 an application may wish to substitute another, for example to allow
1356 central implementation of event-handling for a variety of different
1359 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
1360 an application to set up a chain of event handlers, where an event not handled by one event handler is
1361 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
1362 remove the event handler.
1364 \wxheading{See also
}
1366 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1367 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1368 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1369 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1370 \helpref{wxEvtHandler
}{wxevthandler
}
1372 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
1374 \func{void
}{Raise
}{\void}
1376 Raises the window to the top of the window hierarchy if it is a managed window (dialog
1379 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
1381 \func{virtual void
}{Refresh
}{\param{const bool
}{ eraseBackground = TRUE
},
\param{const wxRect*
}{rect
1384 Causes a message or event to be generated to repaint the
1387 \wxheading{Parameters
}
1389 \docparam{eraseBackground
}{If TRUE, the background will be
1392 \docparam{rect
}{If non-NULL, only the given rectangle will
1393 be treated as damaged.
}
1395 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
1397 \func{virtual void
}{ReleaseMouse
}{\void}
1399 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
1401 \wxheading{See also
}
1403 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}
1405 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
1407 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
1409 Removes a child window. This is called automatically by window deletion
1410 functions so should not be required by the application programmer.
1412 \wxheading{Parameters
}
1414 \docparam{child
}{Child window to remove.
}
1416 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
1418 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
1420 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
1422 Converts from screen to client window coordinates.
1424 \wxheading{Parameters
}
1426 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
1428 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
1430 \docparam{pt
}{The screen position for the second form of the function.
}
1432 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
1434 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
1436 Physically scrolls the pixels in the window.
1438 \wxheading{Parameters
}
1440 \docparam{dx
}{Amount to scroll horizontally.
}
1442 \docparam{dy
}{Amount to scroll vertically.
}
1444 \docparam{rect
}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
1445 pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
1446 can optimise painting by checking for the invalidated region.
}
1450 Available only under Windows.
1452 Use this function to optimise your scrolling implementations, to minimise the area that must be
1455 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
1457 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
1459 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
1461 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
1463 \func{void
}{SetAutoLayout
}{\param{const bool
}{ autoLayout
}}
1465 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
1466 be called automatically when the window is resized.
1468 \wxheading{Parameters
}
1470 \docparam{autoLayout
}{Set this to TRUE if you wish the Layout function to be called
1471 from within wxWindow::OnSize functions.
}
1473 \wxheading{See also
}
1475 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
1477 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
1479 \func{virtual void
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
1481 Sets the background colour of the window.
1483 \wxheading{Parameters
}
1485 \docparam{colour
}{The colour to be used as the background colour.
}
1489 The background colour is usually painted by the default
\rtfsp
1490 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
} event handler function.
1492 \wxheading{See also
}
1494 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
1495 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
1496 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
1497 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
1499 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
1501 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
1503 Sets the window to have the given layout constraints. The window
1504 will then own the object, and will take care of its deletion.
1505 If an existing layout constraints object is already owned by the
1506 window, it will be deleted.
1508 \wxheading{Parameters
}
1510 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
1515 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
1516 the constraints automatically in OnSize; otherwise, you must
1517 override OnSize and call Layout explicitly.
1519 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
1521 \func{virtual void
}{SetFocus
}{\void}
1523 This sets the window to receive keyboard input.
1525 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
1527 \func{void
}{SetFont
}{\param{const wxFont\&
}{font
}}
1529 Sets the font for this window.
1531 \wxheading{Parameters
}
1533 \docparam{font
}{Font to associate with this window.
}
1535 \wxheading{See also
}
1537 \helpref{wxWindow::GetFont
}{wxwindowgetfont
}
1539 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
1541 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
1543 Sets the foreground colour of the window.
1545 \wxheading{Parameters
}
1547 \docparam{colour
}{The colour to be used as the foreground colour.
}
1551 The interpretation of foreground colour is open to interpretation according
1552 to the window class; it may be the text colour or other colour, or it may not
1555 \wxheading{See also
}
1557 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
1558 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
1559 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
1561 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
1563 \func{void
}{SetId
}{\param{int
}{ id
}}
1565 Sets the identifier of the window.
1569 Each window has an integer identifier. If the application has not provided one,
1570 an identifier will be generated. Normally, the identifier should be provided
1571 on creation and should not be modified subsequently.
1573 TODO: perhaps there should be a default identifier for each class, rather
1574 choosing one, which could clash with other ones.
1576 \wxheading{See also
}
1578 \helpref{wxWindow::GetId
}{wxwindowgetid
}
1581 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
1583 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
1585 Sets the window's name.
1587 \wxheading{Parameters
}
1589 \docparam{name
}{A name to set for the window.
}
1591 \wxheading{See also
}
1593 \helpref{wxWindow::GetName
}{wxwindowgetname
}
1595 \membersection{wxWindow::SetReturnCode
}\label{wxwindowsetreturncode
}
1597 \func{void
}{SetReturnCode
}{\param{int
}{retCode
}}
1599 Sets the return code for this window.
1601 \wxheading{Parameters
}
1603 \docparam{retCode
}{The integer return code, usually a control identifier.
}
1607 A return code is normally associated with a modal dialog, where
\helpref{wxDialog::ShowModal
}{wxdialogshowmodal
} returns
1608 a code to the application. The function
\helpref{wxDialog::EndModal
}{wxdialogendmodal
} calls
{\bf SetReturnCode
}.
1610 \wxheading{See also
}
1612 \helpref{wxWindow::GetReturnCode
}{wxwindowgetreturncode
},
\helpref{wxDialog::ShowModal
}{wxdialogshowmodal
},
\rtfsp
1613 \helpref{wxDialog::EndModal
}{wxdialogendmodal
}
1615 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
1617 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
1618 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
1619 \param{const bool
}{refresh = TRUE
}}
1621 Sets the scrollbar properties of a built-in scrollbar.
1623 \wxheading{Parameters
}
1625 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
1627 \docparam{position
}{The position of the scrollbar in scroll units.
}
1629 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
1631 \docparam{range
}{The maximum position of the scrollbar.
}
1633 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
1637 Let's say you wish to display
50 lines of text, using the same font.
1638 The window is sized so that you can only see
16 lines at a time.
1644 SetScrollbar(wxVERTICAL,
0,
16,
50);
1648 Note that with the window at this size, the thumb position can never go
1649 above
50 minus
16, or
34.
1651 You can determine how many lines are currently visible by dividing the current view
1652 size by the character height in pixels.
1654 When defining your own scrollbar behaviour, you will always need to recalculate
1655 the scrollbar settings when the window size changes. You could therefore put your
1656 scrollbar calculations and SetScrollbar
1657 call into a function named AdjustScrollbars, which can be called initially and also
1658 from your
\helpref{wxWindow::OnSize
}{wxwindowonsize
} event handler function.
1660 \wxheading{See also
}
1662 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
1663 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
1666 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
1668 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{const bool
}{refresh = TRUE
}}
1670 Sets the page size of one of the built-in scrollbars.
1672 \wxheading{Parameters
}
1674 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
1676 \docparam{pageSize
}{Page size in scroll units.
}
1678 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
1682 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
1683 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
1684 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
1685 value has to be adjusted when the window is resized, since the page size will have changed.
1687 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
1688 the thumb changes size to reflect the page size relative to the length of the
document. When the
1689 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
1690 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
1693 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
1694 handling of pages and ranges.
1696 \wxheading{See also
}
1698 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
1699 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
1700 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
1701 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
1704 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
1706 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{const bool
}{refresh = TRUE
}}
1708 Sets the position of one of the built-in scrollbars.
1710 \wxheading{Parameters
}
1712 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
1714 \docparam{pos
}{Position in scroll units.
}
1716 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
1720 This function does not directly affect the contents of the window: it is up to the
1721 application to take note of scrollbar attributes and redraw contents accordingly.
1723 \wxheading{See also
}
1725 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
1726 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
1727 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
1728 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
1731 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
1733 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{const bool
}{refresh = TRUE
}}
1735 Sets the range of one of the built-in scrollbars.
1737 \wxheading{Parameters
}
1739 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
1741 \docparam{range
}{Scroll range.
}
1743 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
1747 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
1748 object length of the scrollbar. If you are implementing a scrolling window, for example, you
1749 would adjust the scroll range when the window is resized, by subtracting the window view size from the
1750 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
1751 and usually the scrollbar will be automatically hidden.
1753 \wxheading{See also
}
1755 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
1756 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
1757 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
1758 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
1759 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
1762 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
1764 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
1765 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
1767 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
1769 Sets the size and position of the window in pixels.
1771 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
1773 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
1775 Sets the size of the window in pixels.
1777 \wxheading{Parameters
}
1779 \docparam{x
}{Required x position in pixels, or -
1 to indicate that the existing
1780 value should be used.
}
1782 \docparam{y
}{Required y position in pixels, or -
1 to indicate that the existing
1783 value should be used.
}
1785 \docparam{width
}{Required width in pixels, or -
1 to indicate that the existing
1786 value should be used.
}
1788 \docparam{height
}{Required height position in pixels, or -
1 to indicate that the existing
1789 value should be used.
}
1791 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
1793 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
1795 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
1797 {\bf wxSIZE
\_AUTO\_WIDTH}: a -
1 width value is taken to indicate
1798 a wxWindows-supplied default width.\\
1799 {\bf wxSIZE
\_AUTO\_HEIGHT}: a -
1 height value is taken to indicate
1800 a wxWindows-supplied default width.\\
1801 {\bf wxSIZE
\_AUTO}: -
1 size values are taken to indicate
1802 a wxWindows-supplied default size.\\
1803 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
1804 if -
1 values are supplied.\\
1805 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow dimensions of -
1 and less to be interpreted
1806 as real dimensions, not default values.
1811 The second form is a convenience for calling the first form with default
1812 x and y parameters, and must be used with non-default width and height values.
1814 The first form sets the position and optionally size, of the window.
1815 Parameters may be -
1 to indicate either that a default should be supplied
1816 by wxWindows, or that the current value of the dimension should be used.
1818 \wxheading{See also
}
1820 \helpref{wxWindow::Move
}{wxwindowmove
}
1822 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
1824 \func{virtual void
}{SetSizeHints
}{\param{int
}{ minW=-
1},
\param{int
}{ minH=-
1},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1},
1825 \param{int
}{ incW=-
1},
\param{int
}{ incH=-
1}}
1827 Allows specification of minimum and maximum window sizes, and window size increments.
1828 If a pair of values is not set (or set to -
1), the default values will be used.
1830 \wxheading{Parameters
}
1832 \docparam{minW
}{Specifies the minimum width allowable.
}
1834 \docparam{minH
}{Specifies the minimum height allowable.
}
1836 \docparam{maxW
}{Specifies the maximum width allowable.
}
1838 \docparam{maxH
}{Specifies the maximum height allowable.
}
1840 \docparam{incW
}{Specifies the increment for sizing the width (Motif/Xt only).
}
1842 \docparam{incH
}{Specifies the increment for sizing the height (Motif/Xt only).
}
1846 If this function is called, the user will not be able to size the window outside the
1849 The resizing increments are only significant under Motif or Xt.
1851 \membersection{wxWindow::SetClientSize
}
1853 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
1855 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
1857 This sets the size of the window client area in pixels. Using this function to size a window
1858 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
1859 worry about what dimensions the border or title bar have when trying to fit the window
1860 around panel items, for example.
1862 \wxheading{Parameters
}
1864 \docparam{width
}{The required client area width.
}
1866 \docparam{height
}{The required client area height.
}
1868 \docparam{size
}{The required client size.
}
1870 \membersection{wxWindow::SetPalette
}
1872 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
1874 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
1876 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
1878 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
1880 Sets the window's cursor.
1882 \wxheading{Parameters
}
1884 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
1888 Under Windows, you sometimes need to call ::wxSetCursor in addition to this
1889 function if you want the cursor to change immediately, because under Windows,
1890 wxWindows only sets the global cursor when it detects mouse movement.
1892 \wxheading{See also
}
1894 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
1896 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
1898 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1900 Sets the event handler for this window.
1902 \wxheading{Parameters
}
1904 \docparam{handler
}{Specifies the handler to be set.
}
1908 An event handler is an object that is capable of processing the events
1909 sent to a window. By default, the window is its own event handler, but
1910 an application may wish to substitute another, for example to allow
1911 central implementation of event-handling for a variety of different
1914 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
1915 this sets up a chain of event handlers, where an event not handled by one event handler is
1916 handed to the next one in the chain.
1918 \wxheading{See also
}
1920 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1921 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1922 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1923 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1924 \helpref{wxEvtHandler
}{wxevthandler
}
1926 \membersection{wxWindow::SetTitle
}\label{wxwindowsettitle
}
1928 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{title
}}
1930 Sets the window's title. Applicable only to frames and dialogs.
1932 \wxheading{Parameters
}
1934 \docparam{title
}{The window's title.
}
1936 \wxheading{See also
}
1938 \helpref{wxWindow::GetTitle
}{wxwindowgettitle
}
1940 \membersection{wxWindow::Show
}
1942 \func{virtual bool
}{Show
}{\param{const bool
}{ show
}}
1944 Shows or hides the window.
1946 \wxheading{Parameters
}
1948 \docparam{show
}{If TRUE, displays the window and brings it to the front. Otherwise,
1951 \wxheading{See also
}
1953 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
1955 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
1957 \func{virtual bool
}{TransferDataFromWindow
}{\void}
1959 Transfers values from child controls to data areas specified by their validators. Returns
1960 FALSE if a transfer failed.
1962 \wxheading{See also
}
1964 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
1965 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
1967 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
1969 \func{virtual bool
}{TransferDataToWindow
}{\void}
1971 Transfers values to child controls from data areas specified by their validators.
1973 \wxheading{Return value
}
1975 Returns FALSE if a transfer failed.
1977 \wxheading{See also
}
1979 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
1980 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
1982 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
1984 \func{virtual bool
}{Validate
}{\void}
1986 Validates the current values of the child controls using their validators.
1988 \wxheading{Return value
}
1990 Returns FALSE if any of the validations failed.
1992 \wxheading{See also
}
1994 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
1995 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
1996 \helpref{wxValidator
}{wxvalidator
}
1998 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
2000 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
2002 Moves the pointer to the given position on the window.
2004 \wxheading{Parameters
}
2006 \docparam{x
}{The new x position for the cursor.
}
2008 \docparam{y
}{The new y position for the cursor.
}