]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/window.tex
Some doc fixes; BC++, Watcom C++, Mingw32 fixes
[wxWidgets.git] / docs / latex / wx / window.tex
1 \section{\class{wxWindow}}\label{wxwindow}
2
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.
5
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
12 done.
13
14 \wxheading{Derived from}
15
16 \helpref{wxEvtHandler}{wxevthandler}\\
17 \helpref{wxObject}{wxobject}
18
19 \wxheading{Include files}
20
21 <wx/window.h>
22
23 \wxheading{Window styles}
24
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.
27
28 \twocolwidtha{5cm}%
29 \begin{twocollist}\itemsep=0pt
30 \twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
31 for this style. }
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
44 this style}
45 \twocolitem{\windowstyle{wxNO\_FULLREPAINT\_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 style. Currently only has effect for
48 Windows.}
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.}
53 \end{twocollist}
54
55 See also \helpref{window styles overview}{windowstyles}.
56
57 \wxheading{See also}
58
59 \helpref{Event handling overview}{eventhandlingoverview}
60
61 \latexignore{\rtfignore{\wxheading{Members}}}
62
63 \membersection{wxWindow::wxWindow}
64
65 \func{}{wxWindow}{\void}
66
67 Default constructor.
68
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}}
74
75 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
76
77 \wxheading{Parameters}
78
79 \docparam{parent}{Pointer to a parent window.}
80
81 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
82
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
85 an actual position.}
86
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
90 correctly sized. }
91
92 \docparam{style}{Window style. For generic window styles, please see \helpref{wxWindow}{wxwindow}.}
93
94 \docparam{name}{Window name.}
95
96 \membersection{wxWindow::\destruct{wxWindow}}
97
98 \func{}{\destruct{wxWindow}}{\void}
99
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.
104
105 \wxheading{See also}
106
107 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
108 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
109 \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
110 \helpref{wxCloseEvent}{wxcloseevent}
111
112 \membersection{wxWindow::AddChild}
113
114 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}
115
116 Adds a child window. This is called automatically by window creation
117 functions so should not be required by the application programmer.
118
119 \wxheading{Parameters}
120
121 \docparam{child}{Child window to add.}
122
123 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
124
125 \func{virtual void}{CaptureMouse}{\void}
126
127 Directs all mouse input to this window. Call \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse} to
128 release the capture.
129
130 \wxheading{See also}
131
132 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}
133
134 \membersection{wxWindow::Center}\label{wxwindowcenter}
135
136 \func{void}{Center}{\param{int}{ direction}}
137
138 A synonym for \helpref{Centre}{wxwindowcentre}.
139
140 \membersection{wxWindow::CenterOnParent}\label{wxwindowcenteronparent}
141
142 \func{void}{CenterOnParent}{\param{int}{ direction}}
143
144 A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}.
145
146 \membersection{wxWindow::CenterOnScreen}\label{wxwindowcenteronscreen}
147
148 \func{void}{CenterOnScreen}{\param{int}{ direction}}
149
150 A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}.
151
152 \membersection{wxWindow::Centre}\label{wxwindowcentre}
153
154 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
155
156 Centres the window.
157
158 \wxheading{Parameters}
159
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
163 parent window.}
164
165 The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer
166 (it has no effect).
167
168 \wxheading{Remarks}
169
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.
172
173 \wxheading{See also}
174
175 \helpref{wxWindow::Center}{wxwindowcenter}
176
177 \membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent}
178
179 \func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
180
181 Centres the window on its parent. This is a more readable synonym for
182 \helpref{Centre}{wxwindowcentre}.
183
184 \wxheading{Parameters}
185
186 \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
187 or {\tt wxBOTH}.}
188
189 \wxheading{Remarks}
190
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}.
195
196 \wxheading{See also}
197
198 \helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen}
199
200 \membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen}
201
202 \func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
203
204 Centres the window on screen. This only works for top level windows -
205 otherwise, the window will still be centered on its parent.
206
207 \wxheading{Parameters}
208
209 \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
210 or {\tt wxBOTH}.}
211
212 \wxheading{See also}
213
214 \helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent}
215
216 \membersection{wxWindow::Clear}\label{wxwindowclear}
217
218 \func{void}{Clear}{\void}
219
220 Clears the window by filling it with the current background colour. Does not
221 cause an erase background event to be generated.
222
223 \membersection{wxWindow::ClientToScreen}
224
225 \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
226
227 \constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}}
228
229 Converts to screen coordinates from coordinates relative to this window.
230
231 \docparam{x}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
232 a screen coordinate will be passed out.}
233
234 \docparam{y}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
235 a screen coordinate will be passed out.}
236
237 \docparam{pt}{The client position for the second form of the function.}
238
239 \pythonnote{In place of a single overloaded method name, wxPython
240 implements the following methods:\par
241 \indented{2cm}{\begin{twocollist}
242 \twocolitem{{\bf ClientToScreen(point)}}{Accepts and returns a wxPoint}
243 \twocolitem{{\bf ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)}
244 \end{twocollist}}
245 }
246
247
248 \membersection{wxWindow::Close}\label{wxwindowclose}
249
250 \func{virtual bool}{Close}{\param{bool}{ force = FALSE}}
251
252 The purpose of this call is to provide a safer way of destroying a window than using
253 the {\it delete} operator.
254
255 \wxheading{Parameters}
256
257 \docparam{force}{FALSE if the window's close handler should be able to veto the destruction
258 of this window, TRUE if it cannot.}
259
260 \wxheading{Remarks}
261
262 Close calls the \helpref{close handler}{wxcloseevent} for the window, providing an opportunity for the window to
263 choose whether to destroy the window.
264
265 The close handler should check whether the window is being deleted forcibly,
266 using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}, in which case it should
267 destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
268
269 Applies to managed windows (wxFrame and wxDialog classes) only.
270
271 {\it Note} that calling Close does not guarantee that the window will be destroyed; but it
272 provides a way to simulate a manual close of a window, which may or may not be implemented by
273 destroying the window. The default implementation of wxDialog::OnCloseWindow does not
274 necessarily delete the dialog, since it will simply simulate an wxID\_CANCEL event which
275 itself only hides the dialog.
276
277 To guarantee that the window will be destroyed, call \helpref{wxWindow::Destroy}{wxwindowdestroy} instead.
278
279 \wxheading{See also}
280
281 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
282 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
283 \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
284 \helpref{wxCloseEvent}{wxcloseevent}
285
286 \membersection{wxWindow::ConvertDialogToPixels}\label{wxwindowconvertdialogtopixels}
287
288 \func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}}
289
290 \func{wxSize}{ConvertDialogToPixels}{\param{const wxSize\&}{ sz}}
291
292 Converts a point or size from dialog units to pixels.
293
294 For the x dimension, the dialog units are multiplied by the average character width
295 and then divided by 4.
296
297 For the y dimension, the dialog units are multiplied by the average character height
298 and then divided by 8.
299
300 \wxheading{Remarks}
301
302 Dialog units are used for maintaining a dialog's proportions even if the font changes.
303 Dialogs created using Dialog Editor optionally use dialog units.
304
305 You can also use these functions programmatically. A convenience macro is defined:
306
307 {\small
308 \begin{verbatim}
309 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
310 \end{verbatim}
311 }
312
313 \wxheading{See also}
314
315 \helpref{wxWindow::ConvertPixelsToDialog}{wxwindowconvertpixelstodialog}
316
317 \pythonnote{In place of a single overloaded method name, wxPython
318 implements the following methods:\par
319 \indented{2cm}{\begin{twocollist}
320 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
321 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
322 \end{twocollist}}
323
324 Additionally, the following helper functions are defined:\par
325 \indented{2cm}{\begin{twocollist}
326 \twocolitem{{\bf wxDLG\_PNT(win, point)}}{Converts a wxPoint from dialog
327 units to pixels}
328 \twocolitem{{\bf wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog
329 units to pixels}
330 \end{twocollist}}
331 }
332
333
334 \membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog}
335
336 \func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}}
337
338 \func{wxSize}{ConvertPixelsToDialog}{\param{const wxSize\&}{ sz}}
339
340 Converts a point or size from pixels to dialog units.
341
342 For the x dimension, the pixels are multiplied by 4 and then divided by the average
343 character width.
344
345 For the y dimension, the pixels are multipled by 8 and then divided by the average
346 character height.
347
348 \wxheading{Remarks}
349
350 Dialog units are used for maintaining a dialog's proportions even if the font changes.
351 Dialogs created using Dialog Editor optionally use dialog units.
352
353 \wxheading{See also}
354
355 \helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
356
357
358 \pythonnote{In place of a single overloaded method name, wxPython
359 implements the following methods:\par
360 \indented{2cm}{\begin{twocollist}
361 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
362 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
363 \end{twocollist}}
364 }
365
366 \membersection{wxWindow::Destroy}\label{wxwindowdestroy}
367
368 \func{virtual bool}{Destroy}{\void}
369
370 Destroys the window safely. Use this function instead of the delete operator, since
371 different window classes can be destroyed differently. Frames and dialogs
372 are not destroyed immediately when this function is called - they are added
373 to a list of windows to be deleted on idle time, when all the window's events
374 have been processed. This prevents problems with events being sent to non-existant
375 windows.
376
377 \wxheading{Return value}
378
379 TRUE if the window has either been successfully deleted, or it has been added
380 to the list of windows pending real deletion.
381
382 \membersection{wxWindow::DestroyChildren}
383
384 \func{virtual void}{DestroyChildren}{\void}
385
386 Destroys all children of a window. Called automatically by the destructor.
387
388 \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
389
390 \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
391
392 Enables or disables elibility for drop file events (OnDropFiles).
393
394 \wxheading{Parameters}
395
396 \docparam{accept}{If TRUE, the window is eligible for drop file events. If FALSE, the window
397 will not accept drop file events.}
398
399 \wxheading{Remarks}
400
401 Windows only.
402
403 \wxheading{See also}
404
405 \helpref{wxWindow::OnDropFiles}{wxwindowondropfiles}
406
407 \membersection{wxWindow::Enable}\label{wxwindowenable}
408
409 \func{virtual void}{Enable}{\param{bool}{ enable}}
410
411 Enable or disable the window for user input.
412
413 \wxheading{Parameters}
414
415 \docparam{enable}{If TRUE, enables the window for input. If FALSE, disables the window.}
416
417 \wxheading{See also}
418
419 \helpref{wxWindow::IsEnabled}{wxwindowisenabled}
420
421 \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus}
422
423 \func{static wxWindow*}{FindFocus}{\void}
424
425 Finds the window or control which currently has the keyboard focus.
426
427 \wxheading{Remarks}
428
429 Note that this is a static function, so it can be called without needing a wxWindow pointer.
430
431 \wxheading{See also}
432
433 \helpref{wxWindow::SetFocus}{wxwindowsetfocus}
434
435 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
436
437 \func{wxWindow*}{FindWindow}{\param{long}{ id}}
438
439 Find a child of this window, by identifier.
440
441 \func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
442
443 Find a child of this window, by name.
444
445 \pythonnote{In place of a single overloaded method name, wxPython
446 implements the following methods:\par
447 \indented{2cm}{\begin{twocollist}
448 \twocolitem{{\bf FindWindowById(id)}}{Accepts an integer}
449 \twocolitem{{\bf FindWindowByName(name)}}{Accepts a string}
450 \end{twocollist}}
451 }
452
453 \membersection{wxWindow::Fit}\label{wxwindowfit}
454
455 \func{virtual void}{Fit}{\void}
456
457 Sizes the window so that it fits around its subwindows. This function won't do
458 anything if there are no subwindows.
459
460 \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}
461
462 \constfunc{virtual wxColour}{GetBackgroundColour}{\void}
463
464 Returns the background colour of the window.
465
466 \wxheading{See also}
467
468 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
469 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
470 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
471 \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}
472
473 \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
474
475 \constfunc{virtual wxSize}{GetBestSize}{\void}
476
477 This functions returns the best acceptable minimal size for the window. For
478 example, for a static control, it will be the minimal size such that the
479 control label is not truncated. For windows containing subwindows (typically
480 \helpref{wxPanel}{wxpanel}), the size returned by this function will be the
481 same as the size the window would have had after calling
482 \helpref{Fit}{wxwindowfit}.
483
484 \membersection{wxWindow::GetCharHeight}
485
486 \constfunc{virtual int}{GetCharHeight}{\void}
487
488 Returns the character height for this window.
489
490 \membersection{wxWindow::GetCharWidth}
491
492 \constfunc{virtual int}{GetCharWidth}{\void}
493
494 Returns the average character width for this window.
495
496 \membersection{wxWindow::GetChildren}
497
498 \func{wxList\&}{GetChildren}{\void}
499
500 Returns a reference to the list of the window's children.
501
502 \membersection{wxWindow::GetClientSize}\label{wxwindowgetclientsize}
503
504 \constfunc{virtual void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}}
505
506 \constfunc{virtual wxSize}{GetClientSize}{\void}
507
508 This gets the size of the window `client area' in pixels. The client area is the
509 area which may be drawn on by the programmer, excluding title bar, border etc.
510
511 \wxheading{Parameters}
512
513 \docparam{width}{Receives the client width in pixels.}
514
515 \docparam{height}{Receives the client height in pixels.}
516
517 \pythonnote{In place of a single overloaded method name, wxPython
518 implements the following methods:\par
519 \indented{2cm}{\begin{twocollist}
520 \twocolitem{{\bf wxGetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
521 \twocolitem{{\bf wxGetClientSize()}}{Returns a wxSize object}
522 \end{twocollist}}
523 }
524
525 \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
526
527 \constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
528
529 Returns a pointer to the window's layout constraints, or NULL if there are none.
530
531 \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget}
532
533 \constfunc{wxDropTarget*}{GetDropTarget}{\void}
534
535 Returns the associated drop target, which may be NULL.
536
537 \wxheading{See also}
538
539 \helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
540 \helpref{Drag and drop overview}{wxdndoverview}
541
542 \membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
543
544 \constfunc{wxEvtHandler*}{GetEventHandler}{\void}
545
546 Returns the event handler for this window. By default, the window is its
547 own event handler.
548
549 \wxheading{See also}
550
551 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
552 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
553 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
554 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
555 \helpref{wxEvtHandler}{wxevthandler}\rtfsp
556
557 \membersection{wxWindow::GetExtraStyle}\label{wxwindowgetextrastyle}
558
559 \constfunc{long}{GetExtraStyle}{\void}
560
561 Returns the extra style bits for the window.
562
563 \membersection{wxWindow::GetFont}\label{wxwindowgetfont}
564
565 \constfunc{wxFont\&}{GetFont}{\void}
566
567 Returns a reference to the font for this window.
568
569 \wxheading{See also}
570
571 \helpref{wxWindow::SetFont}{wxwindowsetfont}
572
573 \membersection{wxWindow::GetForegroundColour}\label{wxwindowgetforegroundcolour}
574
575 \func{virtual wxColour}{GetForegroundColour}{\void}
576
577 Returns the foreground colour of the window.
578
579 \wxheading{Remarks}
580
581 The interpretation of foreground colour is open to interpretation according
582 to the window class; it may be the text colour or other colour, or it may not
583 be used at all.
584
585 \wxheading{See also}
586
587 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
588 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
589 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
590
591 \membersection{wxWindow::GetGrandParent}
592
593 \constfunc{wxWindow*}{GetGrandParent}{\void}
594
595 Returns the grandparent of a window, or NULL if there isn't one.
596
597 \membersection{wxWindow::GetHandle}
598
599 \constfunc{void*}{GetHandle}{\void}
600
601 Returns the platform-specific handle of the physical window. Cast it to an appropriate
602 handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget} for GTK.
603
604 \pythonnote{This method will return an integer in wxPython.}
605
606 \membersection{wxWindow::GetId}\label{wxwindowgetid}
607
608 \constfunc{int}{GetId}{\void}
609
610 Returns the identifier of the window.
611
612 \wxheading{Remarks}
613
614 Each window has an integer identifier. If the application has not provided one
615 (or the default Id -1) an unique identifier with a negative value will be generated.
616
617 \wxheading{See also}
618
619 \helpref{wxWindow::SetId}{wxwindowsetid},\rtfsp
620 \helpref{Window identifiers}{windowids}
621
622 \membersection{wxWindow::GetLabel}
623
624 \constfunc{virtual wxString }{GetLabel}{\void}
625
626 Generic way of getting a label from any window, for
627 identification purposes.
628
629 \wxheading{Remarks}
630
631 The interpretation of this function differs from class to class.
632 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
633 the button text. This function can be useful for meta-programs (such as testing
634 tools or special-needs access programs) which need to identify windows
635 by name.
636
637 \membersection{wxWindow::GetPosition}
638
639 \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}
640
641 This gets the position of the window in pixels, relative to the parent window or
642 if no parent, relative to the whole display.
643
644 \wxheading{Parameters}
645
646 \docparam{x}{Receives the x position of the window.}
647
648 \docparam{y}{Receives the y position of the window.}
649
650 \pythonnote{In place of a single overloaded method name, wxPython
651 implements the following methods:\par
652 \indented{2cm}{\begin{twocollist}
653 \twocolitem{{\bf GetPosition()}}{Returns a wxPoint}
654 \twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)}
655 \end{twocollist}}
656 }
657
658 \membersection{wxWindow::GetName}\label{wxwindowgetname}
659
660 \constfunc{virtual wxString }{GetName}{\void}
661
662 Returns the window's name.
663
664 \wxheading{Remarks}
665
666 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
667 name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetname}.
668
669 \wxheading{See also}
670
671 \helpref{wxWindow::SetName}{wxwindowsetname}
672
673 \membersection{wxWindow::GetParent}
674
675 \constfunc{virtual wxWindow*}{GetParent}{\void}
676
677 Returns the parent of the window, or NULL if there is no parent.
678
679 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
680
681 \constfunc{virtual wxRect}{GetRect}{\void}
682
683 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
684
685 \membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
686
687 \func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
688
689 Returns the built-in scrollbar thumb size.
690
691 \wxheading{See also}
692
693 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
694
695 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
696
697 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}
698
699 Returns the built-in scrollbar position.
700
701 \wxheading{See also}
702
703 See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
704
705 \membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange}
706
707 \func{virtual int}{GetScrollRange}{\param{int }{orientation}}
708
709 Returns the built-in scrollbar range.
710
711 \wxheading{See also}
712
713 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
714
715 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
716
717 \constfunc{virtual void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
718
719 \constfunc{virtual wxSize}{GetSize}{\void}
720
721 This gets the size of the entire window in pixels.
722
723 \wxheading{Parameters}
724
725 \docparam{width}{Receives the window width.}
726
727 \docparam{height}{Receives the window height.}
728
729 \pythonnote{In place of a single overloaded method name, wxPython
730 implements the following methods:\par
731 \indented{2cm}{\begin{twocollist}
732 \twocolitem{{\bf GetSize()}}{Returns a wxSize}
733 \twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
734 \end{twocollist}}
735 }
736
737 \membersection{wxWindow::GetTextExtent}
738
739 \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
740 \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
741 \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = FALSE}}
742
743 Gets the dimensions of the string as it would be drawn on the
744 window with the currently selected font.
745
746 \wxheading{Parameters}
747
748 \docparam{string}{String whose extent is to be measured.}
749
750 \docparam{x}{Return value for width.}
751
752 \docparam{y}{Return value for height.}
753
754 \docparam{descent}{Return value for descent (optional).}
755
756 \docparam{externalLeading}{Return value for external leading (optional).}
757
758 \docparam{font}{Font to use instead of the current window font (optional).}
759
760 \docparam{use16}{If TRUE, {\it string} contains 16-bit characters. The default is FALSE.}
761
762
763 \pythonnote{In place of a single overloaded method name, wxPython
764 implements the following methods:\par
765 \indented{2cm}{\begin{twocollist}
766 \twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
767 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a
768 4-tuple, (width, height, descent, externalLeading) }
769 \end{twocollist}}
770 }
771
772
773 \membersection{wxWindow::GetTitle}\label{wxwindowgettitle}
774
775 \func{virtual wxString}{GetTitle}{\void}
776
777 Gets the window's title. Applicable only to frames and dialogs.
778
779 \wxheading{See also}
780
781 \helpref{wxWindow::SetTitle}{wxwindowsettitle}
782
783 \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
784
785 \constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
786
787 Returns the region specifying which parts of the window have been damaged. Should
788 only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler.
789
790 \wxheading{See also}
791
792 \helpref{wxRegion}{wxregion}, \helpref{wxRegionIterator}{wxregioniterator}, \helpref{wxWindow::OnPaint}{wxwindowonpaint}
793
794 \membersection{wxWindow::GetValidator}\label{wxwindowgetvalidator}
795
796 \constfunc{wxValidator*}{GetValidator}{\void}
797
798 Returns a pointer to the current validator for the window, or NULL if there is none.
799
800 \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
801
802 \constfunc{long}{GetWindowStyleFlag}{\void}
803
804 Gets the window style that was passed to the constructor or {\bf Create}
805 method. {\bf GetWindowStyle()} is another name for the same function.
806
807 \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
808
809 \func{void}{InitDialog}{\void}
810
811 Sends an \helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog} event, which
812 in turn transfers data to the dialog via validators.
813
814 \wxheading{See also}
815
816 \helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog}
817
818 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
819
820 \constfunc{virtual bool}{IsEnabled}{\void}
821
822 Returns TRUE if the window is enabled for input, FALSE otherwise.
823
824 \wxheading{See also}
825
826 \helpref{wxWindow::Enable}{wxwindowenable}
827
828 \membersection{wxWindow:IsExposed}\label{wxwindowisexposed}
829
830 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
831
832 \constfunc{bool}{IsExposed}{\param{wxPoint }{\&pt}}
833
834 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, \param{int }{w}, \param{int }{h}}
835
836 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
837
838 Returns TRUE if the given point or rectange area has been exposed since the
839 last repaint. Call this in an paint event handler to optimize redrawing by
840 only redrawing those areas, which have been exposed.
841
842 \pythonnote{In place of a single overloaded method name, wxPython
843 implements the following methods:\par
844 \indented{2cm}{\begin{twocollist}
845 \twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{}
846 \twocolitem{{\bf IsExposedPoint(pt)}}{}
847 \twocolitem{{\bf IsExposedRect(rect)}}{}
848 \end{twocollist}}}
849
850 \membersection{wxWindow::IsRetained}\label{wxwindowisretained}
851
852 \constfunc{virtual bool}{IsRetained}{\void}
853
854 Returns TRUE if the window is retained, FALSE otherwise.
855
856 \wxheading{Remarks}
857
858 Retained windows are only available on X platforms.
859
860 \membersection{wxWindow::IsShown}\label{wxwindowisshown}
861
862 \constfunc{virtual bool}{IsShown}{\void}
863
864 Returns TRUE if the window is shown, FALSE if it has been hidden.
865
866 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
867
868 \constfunc{bool}{IsTopLevel}{\void}
869
870 Returns TRUE if the given window is a top-level one. Currently all frames and
871 dialogs are considered to be top-level windows (even if they have a parent
872 window).
873
874 \membersection{wxWindow::Layout}\label{wxwindowlayout}
875
876 \func{void}{Layout}{\void}
877
878 Invokes the constraint-based layout algorithm or the sizer-based algorithm
879 for this window.
880
881 See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} on when
882 this function gets called automatically using auto layout.
883
884 \membersection{wxWindow::LoadFromResource}\label{wxwindowloadfromresource}
885
886 \func{virtual bool}{LoadFromResource}{\param{wxWindow* }{parent},\rtfsp
887 \param{const wxString\& }{resourceName}, \param{const wxResourceTable* }{resourceTable = NULL}}
888
889 Loads a panel or dialog from a resource file.
890
891 \wxheading{Parameters}
892
893 \docparam{parent}{Parent window.}
894
895 \docparam{resourceName}{The name of the resource to load.}
896
897 \docparam{resourceTable}{The resource table to load it from. If this is NULL, the
898 default resource table will be used.}
899
900 \wxheading{Return value}
901
902 TRUE if the operation succeeded, otherwise FALSE.
903
904 \membersection{wxWindow::Lower}\label{wxwindowlower}
905
906 \func{void}{Lower}{\void}
907
908 Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
909 or frame).
910
911 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}
912
913 \func{virtual void}{MakeModal}{\param{bool }{flag}}
914
915 Disables all other windows in the application so that
916 the user can only interact with this window. (This function
917 is not implemented anywhere).
918
919 \wxheading{Parameters}
920
921 \docparam{flag}{If TRUE, this call disables all other windows in the application so that
922 the user can only interact with this window. If FALSE, the effect is reversed.}
923
924 \membersection{wxWindow::Move}\label{wxwindowmove}
925
926 \func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
927
928 \func{void}{Move}{\param{const wxPoint\&}{ pt}}
929
930 Moves the window to the given position.
931
932 \wxheading{Parameters}
933
934 \docparam{x}{Required x position.}
935
936 \docparam{y}{Required y position.}
937
938 \docparam{pt}{\helpref{wxPoint}{wxpoint} object representing the position.}
939
940 \wxheading{Remarks}
941
942 Implementations of SetSize can also implicitly implement the
943 wxWindow::Move function, which is defined in the base wxWindow class
944 as the call:
945
946 \begin{verbatim}
947 SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING);
948 \end{verbatim}
949
950 \wxheading{See also}
951
952 \helpref{wxWindow::SetSize}{wxwindowsetsize}
953
954 \pythonnote{In place of a single overloaded method name, wxPython
955 implements the following methods:\par
956 \indented{2cm}{\begin{twocollist}
957 \twocolitem{{\bf Move(point)}}{Accepts a wxPoint}
958 \twocolitem{{\bf MoveXY(x, y)}}{Accepts a pair of integers}
959 \end{twocollist}}
960 }
961
962 \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
963
964 \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
965
966 Called when a window is activated or deactivated.
967
968 \wxheading{Parameters}
969
970 \docparam{event}{Object containing activation information.}
971
972 \wxheading{Remarks}
973
974 If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns TRUE,
975 otherwise it returns FALSE (it is being deactivated).
976
977 \wxheading{See also}
978
979 \helpref{wxActivateEvent}{wxactivateevent},\rtfsp
980 \helpref{Event handling overview}{eventhandlingoverview}
981
982 \membersection{wxWindow::OnChar}\label{wxwindowonchar}
983
984 \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
985
986 Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
987
988 \wxheading{Parameters}
989
990 \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
991 details about this class.}
992
993 \wxheading{Remarks}
994
995 This member function is called in response to a keypress. To intercept this event,
996 use the EVT\_CHAR macro in an event table definition. Your {\bf OnChar} handler may call this
997 default function to achieve default keypress functionality.
998
999 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1000 values.
1001
1002 Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1003 keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1004 \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1005
1006 Most, but not all, windows allow keypresses to be intercepted.
1007
1008 \wxheading{See also}
1009
1010 \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1011 \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1012 \helpref{Event handling overview}{eventhandlingoverview}
1013
1014 \membersection{wxWindow::OnCharHook}\label{wxwindowoncharhook}
1015
1016 \func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
1017
1018 This member is called to allow the window to intercept keyboard events
1019 before they are processed by child windows.
1020
1021 \wxheading{Parameters}
1022
1023 \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1024 details about this class.}
1025
1026 \wxheading{Remarks}
1027
1028 This member function is called in response to a keypress, if the window is active. To intercept this event,
1029 use the EVT\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
1030 keypress, call \helpref{wxEvent::Skip}{wxeventskip} to allow default processing.
1031
1032 An example of using this function is in the implementation of escape-character processing for wxDialog,
1033 where pressing ESC dismisses the dialog by {\bf OnCharHook} 'forging' a cancel button press event.
1034
1035 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1036 values.
1037
1038 This function is only relevant to top-level windows (frames and dialogs), and under
1039 Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
1040 you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
1041 the window won't get the event.
1042
1043 \wxheading{See also}
1044
1045 \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1046 \helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp
1047 \helpref{Event handling overview}{eventhandlingoverview}
1048
1049 \membersection{wxWindow::OnCommand}\label{wxwindowoncommand}
1050
1051 \func{virtual void}{OnCommand}{\param{wxEvtHandler\& }{object}, \param{wxCommandEvent\& }{event}}
1052
1053 This virtual member function is called if the control does not handle the command event.
1054
1055 \wxheading{Parameters}
1056
1057 \docparam{object}{Object receiving the command event.}
1058
1059 \docparam{event}{Command event}
1060
1061 \wxheading{Remarks}
1062
1063 This virtual function is provided mainly for backward compatibility. You can also intercept commands
1064 from child controls by using an event table, with identifiers or identifier ranges to identify
1065 the control(s) in question.
1066
1067 \wxheading{See also}
1068
1069 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1070 \helpref{Event handling overview}{eventhandlingoverview}
1071
1072 \membersection{wxWindow::OnClose}\label{wxwindowonclose}
1073
1074 \func{virtual bool}{OnClose}{\void}
1075
1076 Called when the user has tried to close a a frame
1077 or dialog box using the window manager (X) or system menu (Windows).
1078
1079 {\bf Note:} This is an obsolete function.
1080 It is superceded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
1081 handler.
1082
1083 \wxheading{Return value}
1084
1085 If TRUE is returned by OnClose, the window will be deleted by the system, otherwise the
1086 attempt will be ignored. Do not delete the window from within this handler, although
1087 you may delete other windows.
1088
1089 \wxheading{See also}
1090
1091 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
1092 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
1093 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
1094 \helpref{wxCloseEvent}{wxcloseevent}
1095
1096 \membersection{wxWindow::OnCloseWindow}\label{wxwindowonclosewindow}
1097
1098 \func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}}
1099
1100 This is an event handler function called when the user has tried to close a a frame
1101 or dialog box using the window manager (X) or system menu (Windows). It is
1102 called via the \helpref{wxWindow::Close}{wxwindowclose} function, so
1103 that the application can also invoke the handler programmatically.
1104
1105 Use the EVT\_CLOSE event table macro to handle close events.
1106
1107 You should check whether the application is forcing the deletion of the window
1108 using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE,
1109 destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
1110 If not, it is up to you whether you respond by destroying the window.
1111
1112 (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
1113 the window is required, test for the negative of CanVeto. If CanVeto returns FALSE,
1114 it is not possible to skip window deletion.)
1115
1116 If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to
1117 let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function
1118 to return TRUE or FALSE depending on whether the close instruction was honoured or not.
1119
1120 \wxheading{Remarks}
1121
1122 The \helpref{wxWindow::OnClose}{wxwindowonclose} virtual function remains
1123 for backward compatibility with earlier versions of wxWindows. The
1124 default {\bf OnCloseWindow} handler for wxFrame and wxDialog will call {\bf OnClose},
1125 destroying the window if it returns TRUE or if the close is being forced.
1126
1127 \wxheading{See also}
1128
1129 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
1130 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
1131 \helpref{wxWindow::OnClose}{wxwindowonclose},\rtfsp
1132 \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
1133 \helpref{wxCloseEvent}{wxcloseevent},\rtfsp
1134 \helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession},\rtfsp
1135 \helpref{wxApp::OnEndSession}{wxapponendsession}
1136
1137 \membersection{wxWindow::OnDropFiles}\label{wxwindowondropfiles}
1138
1139 \func{void}{OnDropFiles}{\param{wxDropFilesEvent\&}{ event}}
1140
1141 Called when files have been dragged from the file manager to the window.
1142
1143 \wxheading{Parameters}
1144
1145 \docparam{event}{Drop files event. For more information, see \helpref{wxDropFilesEvent}{wxdropfilesevent}.}
1146
1147 \wxheading{Remarks}
1148
1149 The window must have previously been enabled for dropping by calling
1150 \rtfsp\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}.
1151
1152 This event is only generated under Windows.
1153
1154 To intercept this event, use the EVT\_DROP\_FILES macro in an event table definition.
1155
1156 \wxheading{See also}
1157
1158 \helpref{wxDropFilesEvent}{wxdropfilesevent}, \helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles},\rtfsp
1159 \helpref{Event handling overview}{eventhandlingoverview}
1160
1161 \membersection{wxWindow::OnEraseBackground}\label{wxwindowonerasebackground}
1162
1163 \func{void}{OnEraseBackground}{\param{wxEraseEvent\&}{ event}}
1164
1165 Called when the background of the window needs to be erased.
1166
1167 \wxheading{Parameters}
1168
1169 \docparam{event}{Erase background event. For more information, see \helpref{wxEraseEvent}{wxeraseevent}.}
1170
1171 \wxheading{Remarks}
1172
1173 Under non-Windows platforms, this event is simulated (simply generated just before the
1174 paint event) and may cause flicker. It is therefore recommended that
1175 you set the text background colour explicitly in order to prevent flicker.
1176 The default background colour under GTK is grey.
1177
1178 To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table definition.
1179
1180 \wxheading{See also}
1181
1182 \helpref{wxEraseEvent}{wxeraseevent}, \helpref{Event handling overview}{eventhandlingoverview}
1183
1184 \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
1185
1186 \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
1187
1188 Called when the user has pressed a key, before it is translated into an ASCII value using other
1189 modifier keys that might be pressed at the same time.
1190
1191 \wxheading{Parameters}
1192
1193 \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1194 details about this class.}
1195
1196 \wxheading{Remarks}
1197
1198 This member function is called in response to a key down event. To intercept this event,
1199 use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this
1200 default function to achieve default keypress functionality.
1201
1202 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1203 keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1204 \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1205
1206 Most, but not all, windows allow keypresses to be intercepted.
1207
1208 \wxheading{See also}
1209
1210 \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1211 \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1212 \helpref{Event handling overview}{eventhandlingoverview}
1213
1214 \membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup}
1215
1216 \func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}}
1217
1218 Called when the user has released a key.
1219
1220 \wxheading{Parameters}
1221
1222 \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1223 details about this class.}
1224
1225 \wxheading{Remarks}
1226
1227 This member function is called in response to a key up event. To intercept this event,
1228 use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this
1229 default function to achieve default keypress functionality.
1230
1231 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1232 keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1233 \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1234
1235 Most, but not all, windows allow key up events to be intercepted.
1236
1237 \wxheading{See also}
1238
1239 \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp
1240 \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1241 \helpref{Event handling overview}{eventhandlingoverview}
1242
1243 \membersection{wxWindow::OnKillFocus}\label{wxwindowonkillfocus}
1244
1245 \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
1246
1247 Called when a window's focus is being killed.
1248
1249 \wxheading{Parameters}
1250
1251 \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
1252
1253 \wxheading{Remarks}
1254
1255 To intercept this event, use the macro EVT\_KILL\_FOCUS in an event table definition.
1256
1257 Most, but not all, windows respond to this event.
1258
1259 \wxheading{See also}
1260
1261 \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnSetFocus}{wxwindowonsetfocus},\rtfsp
1262 \helpref{Event handling overview}{eventhandlingoverview}
1263
1264 \membersection{wxWindow::OnIdle}\label{wxwindowonidle}
1265
1266 \func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
1267
1268 Provide this member function for any processing which needs to be done
1269 when the application is idle.
1270
1271 \wxheading{See also}
1272
1273 \helpref{wxApp::OnIdle}{wxapponidle}, \helpref{wxIdleEvent}{wxidleevent}
1274
1275 \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
1276
1277 \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
1278
1279 Default handler for the wxEVT\_INIT\_DIALOG event. Calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
1280
1281 \wxheading{Parameters}
1282
1283 \docparam{event}{Dialog initialisation event.}
1284
1285 \wxheading{Remarks}
1286
1287 Gives the window the default behaviour of transferring data to child controls via
1288 the validator that each control has.
1289
1290 \wxheading{See also}
1291
1292 \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
1293
1294 \membersection{wxWindow::OnMenuCommand}\label{wxwindowonmenucommand}
1295
1296 \func{void}{OnMenuCommand}{\param{wxCommandEvent\& }{event}}
1297
1298 Called when a menu command is received from a menu bar.
1299
1300 \wxheading{Parameters}
1301
1302 \docparam{event}{The menu command event. For more information, see \helpref{wxCommandEvent}{wxcommandevent}.}
1303
1304 \wxheading{Remarks}
1305
1306 A function with this name doesn't actually exist; you can choose any member function to receive
1307 menu command events, using the EVT\_COMMAND macro for individual commands or EVT\_COMMAND\_RANGE for
1308 a range of commands.
1309
1310 \wxheading{See also}
1311
1312 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1313 \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight},\rtfsp
1314 \helpref{Event handling overview}{eventhandlingoverview}
1315
1316 \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
1317
1318 \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
1319
1320 Called when a menu select is received from a menu bar: that is, the
1321 mouse cursor is over a menu item, but the left mouse button has not been
1322 pressed.
1323
1324 \wxheading{Parameters}
1325
1326 \docparam{event}{The menu highlight event. For more information, see \helpref{wxMenuEvent}{wxmenuevent}.}
1327
1328 \wxheading{Remarks}
1329
1330 You can choose any member function to receive
1331 menu select events, using the EVT\_MENU\_HIGHLIGHT macro for individual menu items or EVT\_MENU\_HIGHLIGHT\_ALL macro
1332 for all menu items.
1333
1334 The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
1335 text in the first field of the status bar.
1336
1337 This function was known as {\bf OnMenuSelect} in earlier versions of wxWindows, but this was confusing
1338 since a selection is normally a left-click action.
1339
1340 \wxheading{See also}
1341
1342 \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
1343 \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp
1344 \helpref{Event handling overview}{eventhandlingoverview}
1345
1346
1347 \membersection{wxWindow::OnMouseEvent}\label{wxwindowonmouseevent}
1348
1349 \func{void}{OnMouseEvent}{\param{wxMouseEvent\&}{ event}}
1350
1351 Called when the user has initiated an event with the
1352 mouse.
1353
1354 \wxheading{Parameters}
1355
1356 \docparam{event}{The mouse event. See \helpref{wxMouseEvent}{wxmouseevent} for
1357 more details.}
1358
1359 \wxheading{Remarks}
1360
1361 Most, but not all, windows respond to this event.
1362
1363 To intercept this event, use the EVT\_MOUSE\_EVENTS macro in an event table definition, or individual
1364 mouse event macros such as EVT\_LEFT\_DOWN.
1365
1366 \wxheading{See also}
1367
1368 \helpref{wxMouseEvent}{wxmouseevent},\rtfsp
1369 \helpref{Event handling overview}{eventhandlingoverview}
1370
1371 \membersection{wxWindow::OnMove}\label{wxwindowonmove}
1372
1373 \func{void}{OnMove}{\param{wxMoveEvent\& }{event}}
1374
1375 Called when a window is moved.
1376
1377 \wxheading{Parameters}
1378
1379 \docparam{event}{The move event. For more information, see \helpref{wxMoveEvent}{wxmoveevent}.}
1380
1381 \wxheading{Remarks}
1382
1383 Use the EVT\_MOVE macro to intercept move events.
1384
1385 \wxheading{Remarks}
1386
1387 Not currently implemented.
1388
1389 \wxheading{See also}
1390
1391 \helpref{wxMoveEvent}{wxmoveevent},\rtfsp
1392 \helpref{wxFrame::OnSize}{wxframeonsize},\rtfsp
1393 \helpref{Event handling overview}{eventhandlingoverview}
1394
1395 \membersection{wxWindow::OnPaint}\label{wxwindowonpaint}
1396
1397 \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
1398
1399 Sent to the event handler when the window must be refreshed.
1400
1401 \wxheading{Parameters}
1402
1403 \docparam{event}{Paint event. For more information, see \helpref{wxPaintEvent}{wxpaintevent}.}
1404
1405 \wxheading{Remarks}
1406
1407
1408
1409 Use the EVT\_PAINT macro in an event table definition to intercept paint events.
1410
1411 Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
1412 even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
1413
1414 For example:
1415
1416 \small{%
1417 \begin{verbatim}
1418 void MyWindow::OnPaint(wxPaintEvent\& event)
1419 {
1420 wxPaintDC dc(this);
1421
1422 DrawMyDocument(dc);
1423 }
1424 \end{verbatim}
1425 }%
1426
1427 You can optimize painting by retrieving the rectangles
1428 that have been damaged and only repainting these. The rectangles are in
1429 terms of the client area, and are unscrolled, so you will need to do
1430 some calculations using the current view position to obtain logical,
1431 scrolled units.
1432
1433 Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
1434
1435 {\small%
1436 \begin{verbatim}
1437 // Called when window needs to be repainted.
1438 void MyWindow::OnPaint(wxPaintEvent\& event)
1439 {
1440 wxPaintDC dc(this);
1441
1442 // Find Out where the window is scrolled to
1443 int vbX,vbY; // Top left corner of client
1444 GetViewStart(&vbX,&vbY);
1445
1446 int vX,vY,vW,vH; // Dimensions of client area in pixels
1447 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1448
1449 while (upd)
1450 {
1451 vX = upd.GetX();
1452 vY = upd.GetY();
1453 vW = upd.GetW();
1454 vH = upd.GetH();
1455
1456 // Alternatively we can do this:
1457 // wxRect rect;
1458 // upd.GetRect(&rect);
1459
1460 // Repaint this rectangle
1461 ...some code...
1462
1463 upd ++ ;
1464 }
1465 }
1466 \end{verbatim}
1467 }%
1468
1469 \wxheading{See also}
1470
1471 \helpref{wxPaintEvent}{wxpaintevent},\rtfsp
1472 \helpref{wxPaintDC}{wxpaintdc},\rtfsp
1473 \helpref{Event handling overview}{eventhandlingoverview}
1474
1475 \membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
1476
1477 \func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
1478
1479 Called when a scroll window event is received from one of the window's built-in scrollbars.
1480
1481 \wxheading{Parameters}
1482
1483 \docparam{event}{Command event. Retrieve the new scroll position by
1484 calling \helpref{wxScrollEvent::GetPosition}{wxscrolleventgetposition}, and the
1485 scrollbar orientation by calling \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}.}
1486
1487 \wxheading{Remarks}
1488
1489 Note that it is not possible to distinguish between horizontal and vertical scrollbars
1490 until the function is executing (you can't have one function for vertical, another
1491 for horizontal events).
1492
1493 \wxheading{See also}
1494
1495 \helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp
1496 \helpref{Event handling overview}{eventhandlingoverview}
1497
1498 \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus}
1499
1500 \func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
1501
1502 Called when a window's focus is being set.
1503
1504 \wxheading{Parameters}
1505
1506 \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
1507
1508 \wxheading{Remarks}
1509
1510 To intercept this event, use the macro EVT\_SET\_FOCUS in an event table definition.
1511
1512 Most, but not all, windows respond to this event.
1513
1514 \wxheading{See also}
1515
1516 \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
1517 \helpref{Event handling overview}{eventhandlingoverview}
1518
1519 \membersection{wxWindow::OnSize}\label{wxwindowonsize}
1520
1521 \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
1522
1523 Called when the window has been resized.
1524
1525 \wxheading{Parameters}
1526
1527 \docparam{event}{Size event. For more information, see \helpref{wxSizeEvent}{wxsizeevent}.}
1528
1529 \wxheading{Remarks}
1530
1531 You may wish to use this for frames to resize their child windows as appropriate.
1532
1533 Note that the size passed is of
1534 the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
1535 used by the application.
1536
1537 \wxheading{See also}
1538
1539 \helpref{wxSizeEvent}{wxsizeevent},\rtfsp
1540 \helpref{Event handling overview}{eventhandlingoverview}
1541
1542 \membersection{wxWindow::OnSysColourChanged}\label{wxwindowonsyscolourchanged}
1543
1544 \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}}
1545
1546 Called when the user has changed the system colours. Windows only.
1547
1548 \wxheading{Parameters}
1549
1550 \docparam{event}{System colour change event. For more information, see \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}.}
1551
1552 \wxheading{See also}
1553
1554 \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
1555 \helpref{Event handling overview}{eventhandlingoverview}
1556
1557 \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
1558
1559 \constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = FALSE}}
1560
1561 Removes and returns the top-most event handler on the event handler stack.
1562
1563 \wxheading{Parameters}
1564
1565 \docparam{deleteHandler}{If this is TRUE, the handler will be deleted after it is removed. The
1566 default value is FALSE.}
1567
1568 \wxheading{See also}
1569
1570 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
1571 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
1572 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
1573 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
1574 \helpref{wxEvtHandler}{wxevthandler}\rtfsp
1575
1576 \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
1577
1578 \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}}
1579
1580 \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
1581
1582 Pops up the given menu at the specified coordinates, relative to this
1583 window, and returns control when the user has dismissed the menu. If a
1584 menu item is selected, the corresponding menu event is generated and will be
1585 processed as usually.
1586
1587 \wxheading{Parameters}
1588
1589 \docparam{menu}{Menu to pop up.}
1590
1591 \docparam{pos}{The position where the menu will appear.}
1592
1593 \docparam{x}{Required x position for the menu to appear.}
1594
1595 \docparam{y}{Required y position for the menu to appear.}
1596
1597 \wxheading{See also}
1598
1599 \helpref{wxMenu}{wxmenu}
1600
1601 \wxheading{Remarks}
1602
1603 Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} is called
1604 to ensure that the menu items are in the correct state. The menu does not get deleted
1605 by the window.
1606
1607 \pythonnote{In place of a single overloaded method name, wxPython
1608 implements the following methods:\par
1609 \indented{2cm}{\begin{twocollist}
1610 \twocolitem{{\bf PopupMenu(menu, point)}}{Specifies position with a wxPoint}
1611 \twocolitem{{\bf PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)}
1612 \end{twocollist}}
1613 }
1614
1615 \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler}
1616
1617 \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}
1618
1619 Pushes this event handler onto the event stack for the window.
1620
1621 \wxheading{Parameters}
1622
1623 \docparam{handler}{Specifies the handler to be pushed.}
1624
1625 \wxheading{Remarks}
1626
1627 An event handler is an object that is capable of processing the events
1628 sent to a window. By default, the window is its own event handler, but
1629 an application may wish to substitute another, for example to allow
1630 central implementation of event-handling for a variety of different
1631 window classes.
1632
1633 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} allows
1634 an application to set up a chain of event handlers, where an event not handled by one event handler is
1635 handed to the next one in the chain. Use \helpref{wxWindow::PopEventHandler}{wxwindowpopeventhandler} to
1636 remove the event handler.
1637
1638 \wxheading{See also}
1639
1640 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
1641 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
1642 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
1643 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
1644 \helpref{wxEvtHandler}{wxevthandler}
1645
1646 \membersection{wxWindow::Raise}\label{wxwindowraise}
1647
1648 \func{void}{Raise}{\void}
1649
1650 Raises the window to the top of the window hierarchy if it is a managed window (dialog
1651 or frame).
1652
1653 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
1654
1655 \func{virtual void}{Refresh}{\param{bool}{ eraseBackground = TRUE}, \param{const wxRect* }{rect
1656 = NULL}}
1657
1658 Causes a message or event to be generated to repaint the
1659 window.
1660
1661 \wxheading{Parameters}
1662
1663 \docparam{eraseBackground}{If TRUE, the background will be
1664 erased.}
1665
1666 \docparam{rect}{If non-NULL, only the given rectangle will
1667 be treated as damaged.}
1668
1669 \membersection{wxWindow::ReleaseMouse}\label{wxwindowreleasemouse}
1670
1671 \func{virtual void}{ReleaseMouse}{\void}
1672
1673 Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}.
1674
1675 \wxheading{See also}
1676
1677 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}
1678
1679 \membersection{wxWindow::RemoveChild}\label{wxwindowremovechild}
1680
1681 \func{virtual void}{RemoveChild}{\param{wxWindow* }{child}}
1682
1683 Removes a child window. This is called automatically by window deletion
1684 functions so should not be required by the application programmer.
1685
1686 \wxheading{Parameters}
1687
1688 \docparam{child}{Child window to remove.}
1689
1690 \membersection{wxWindow::Reparent}\label{wxwindowreparent}
1691
1692 \func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}}
1693
1694 Reparents the window, i.e the window will be removed from its
1695 current parent window (e.g. a non-standard toolbar in a wxFrame)
1696 and then re-inserted into another. Available on Windows and GTK.
1697
1698 \wxheading{Parameters}
1699
1700 \docparam{newParent}{New parent.}
1701
1702 \membersection{wxWindow::ScreenToClient}\label{wxwindowscreentoclient}
1703
1704 \constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* }{y}}
1705
1706 \constfunc{virtual wxPoint}{ScreenToClient}{\param{const wxPoint\& }{pt}}
1707
1708 Converts from screen to client window coordinates.
1709
1710 \wxheading{Parameters}
1711
1712 \docparam{x}{Stores the screen x coordinate and receives the client x coordinate.}
1713
1714 \docparam{y}{Stores the screen x coordinate and receives the client x coordinate.}
1715
1716 \docparam{pt}{The screen position for the second form of the function.}
1717
1718 \pythonnote{In place of a single overloaded method name, wxPython
1719 implements the following methods:\par
1720 \indented{2cm}{\begin{twocollist}
1721 \twocolitem{{\bf ScreenToClient(point)}}{Accepts and returns a wxPoint}
1722 \twocolitem{{\bf ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)}
1723 \end{twocollist}}
1724 }
1725
1726
1727 \membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
1728
1729 \func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
1730
1731 Physically scrolls the pixels in the window and move child windows accordingly.
1732
1733 \wxheading{Parameters}
1734
1735 \docparam{dx}{Amount to scroll horizontally.}
1736
1737 \docparam{dy}{Amount to scroll vertically.}
1738
1739 \docparam{rect}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
1740 pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
1741 can optimise painting by checking for the invalidated region. This paramter is ignored under GTK.}
1742
1743 \wxheading{Remarks}
1744
1745 Use this function to optimise your scrolling implementations, to minimise the area that must be
1746 redrawn. Note that it is rarely required to call this function from a user program.
1747
1748 \membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable}
1749
1750 \func{virtual void}{SetAcceleratorTable}{\param{const wxAcceleratorTable\&}{ accel}}
1751
1752 Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}.
1753
1754 \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout}
1755
1756 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
1757
1758 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
1759 be called automatically when the window is resized. Use in connection with
1760 \helpref{wxWindow::SetSizer}{wxwindowsetsizer} and
1761 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for layouting subwindows.
1762
1763 \wxheading{Parameters}
1764
1765 \docparam{autoLayout}{Set this to TRUE if you wish the Layout function to be called
1766 from within wxWindow::OnSize functions.}
1767
1768 \wxheading{See also}
1769
1770 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
1771
1772 \membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour}
1773
1774 \func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
1775
1776 Sets the background colour of the window.
1777
1778 \wxheading{Parameters}
1779
1780 \docparam{colour}{The colour to be used as the background colour.}
1781
1782 \wxheading{Remarks}
1783
1784 The background colour is usually painted by the default\rtfsp
1785 \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function
1786 under Windows and automatically under GTK.
1787
1788 Note that setting the background colour does not cause an immediate refresh, so you
1789 may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
1790 calling this function.
1791
1792 Use this function with care under GTK as the new appearance of the window might
1793 not look equally well when used with "Themes", i.e GTK's ability to change its
1794 look as the user wishes with run-time loadable modules.
1795
1796 \wxheading{See also}
1797
1798 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp
1799 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
1800 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
1801 \helpref{wxWindow::Clear}{wxwindowclear},\rtfsp
1802 \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
1803 \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}
1804
1805 \membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize}
1806
1807 \func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}}
1808
1809 \func{virtual void}{SetClientSize}{\param{const wxSize\&}{ size}}
1810
1811 This sets the size of the window client area in pixels. Using this function to size a window
1812 tends to be more device-independent than \helpref{wxWindow::SetSize}{wxwindowsetsize}, since the application need not
1813 worry about what dimensions the border or title bar have when trying to fit the window
1814 around panel items, for example.
1815
1816 \wxheading{Parameters}
1817
1818 \docparam{width}{The required client area width.}
1819
1820 \docparam{height}{The required client area height.}
1821
1822 \docparam{size}{The required client size.}
1823
1824 \pythonnote{In place of a single overloaded method name, wxPython
1825 implements the following methods:\par
1826 \indented{2cm}{\begin{twocollist}
1827 \twocolitem{{\bf SetClientSize(size)}}{Accepts a wxSize}
1828 \twocolitem{{\bf SetClientSizeWH(width, height)}}{}
1829 \end{twocollist}}
1830 }
1831
1832 \membersection{wxWindow::SetCursor}\label{wxwindowsetcursor}
1833
1834 \func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
1835
1836 % VZ: the docs are correct, if the code doesn't behave like this, it must be
1837 % changed
1838 Sets the window's cursor. Notice that the window cursor also sets it for the
1839 children of the window implicitly.
1840
1841 The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will
1842 be reset back to default.
1843
1844 \wxheading{Parameters}
1845
1846 \docparam{cursor}{Specifies the cursor that the window should normally display.}
1847
1848 \wxheading{See also}
1849
1850 \helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor}
1851
1852 \membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler}
1853
1854 \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
1855
1856 Sets the event handler for this window.
1857
1858 \wxheading{Parameters}
1859
1860 \docparam{handler}{Specifies the handler to be set.}
1861
1862 \wxheading{Remarks}
1863
1864 An event handler is an object that is capable of processing the events
1865 sent to a window. By default, the window is its own event handler, but
1866 an application may wish to substitute another, for example to allow
1867 central implementation of event-handling for a variety of different
1868 window classes.
1869
1870 It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since
1871 this sets up a chain of event handlers, where an event not handled by one event handler is
1872 handed to the next one in the chain.
1873
1874 \wxheading{See also}
1875
1876 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
1877 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
1878 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
1879 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
1880 \helpref{wxEvtHandler}{wxevthandler}
1881
1882 \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
1883
1884 \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}
1885
1886 Sets the window to have the given layout constraints. The window
1887 will then own the object, and will take care of its deletion.
1888 If an existing layout constraints object is already owned by the
1889 window, it will be deleted.
1890
1891 \wxheading{Parameters}
1892
1893 \docparam{constraints}{The constraints to set. Pass NULL to disassociate and delete the window's
1894 constraints.}
1895
1896 \wxheading{Remarks}
1897
1898 You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use
1899 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
1900 explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
1901 sizer will have effect.
1902
1903 \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget}
1904
1905 \func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}}
1906
1907 Associates a drop target with this window.
1908
1909 If the window already has a drop target, it is deleted.
1910
1911 \wxheading{See also}
1912
1913 \helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
1914 \helpref{Drag and drop overview}{wxdndoverview}
1915
1916 \membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle}
1917
1918 \func{void}{SetExtraStyle}{\param{long }{exStyle}}
1919
1920 Sets the extra style bits for the window. The currently defined extra style
1921 bits are:
1922
1923 \twocolwidtha{5cm}%
1924 \begin{twocollist}\itemsep=0pt
1925 \twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
1926 and Validate() methods will recursively descend into all children of the
1927 window if it has this style flag set.}
1928 \end{twocollist}
1929
1930 \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
1931
1932 \func{virtual void}{SetFocus}{\void}
1933
1934 This sets the window to receive keyboard input.
1935
1936 \membersection{wxWindow::SetFont}\label{wxwindowsetfont}
1937
1938 \func{void}{SetFont}{\param{const wxFont\& }{font}}
1939
1940 Sets the font for this window.
1941
1942 \wxheading{Parameters}
1943
1944 \docparam{font}{Font to associate with this window.}
1945
1946 \wxheading{See also}
1947
1948 \helpref{wxWindow::GetFont}{wxwindowgetfont}
1949
1950 \membersection{wxWindow::SetForegroundColour}\label{wxwindowsetforegroundcolour}
1951
1952 \func{virtual void}{SetForegroundColour}{\param{const wxColour\& }{colour}}
1953
1954 Sets the foreground colour of the window.
1955
1956 \wxheading{Parameters}
1957
1958 \docparam{colour}{The colour to be used as the foreground colour.}
1959
1960 \wxheading{Remarks}
1961
1962 The interpretation of foreground colour is open to interpretation according
1963 to the window class; it may be the text colour or other colour, or it may not
1964 be used at all.
1965
1966 Note that when using this functions under GTK, you will disable the so called "themes",
1967 i.e. the user chosen apperance of windows and controls, including the themes of
1968 their parent windows.
1969
1970 \wxheading{See also}
1971
1972 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
1973 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
1974 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
1975
1976 \membersection{wxWindow::SetId}\label{wxwindowsetid}
1977
1978 \func{void}{SetId}{\param{int}{ id}}
1979
1980 Sets the identifier of the window.
1981
1982 \wxheading{Remarks}
1983
1984 Each window has an integer identifier. If the application has not provided one,
1985 an identifier will be generated. Normally, the identifier should be provided
1986 on creation and should not be modified subsequently.
1987
1988 \wxheading{See also}
1989
1990 \helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp
1991 \helpref{Window identifiers}{windowids}
1992
1993 \membersection{wxWindow::SetName}\label{wxwindowsetname}
1994
1995 \func{virtual void}{SetName}{\param{const wxString\& }{name}}
1996
1997 Sets the window's name.
1998
1999 \wxheading{Parameters}
2000
2001 \docparam{name}{A name to set for the window.}
2002
2003 \wxheading{See also}
2004
2005 \helpref{wxWindow::GetName}{wxwindowgetname}
2006
2007 \membersection{wxWindow::SetPalette}\label{wxwindowsetpalette}
2008
2009 \func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}
2010
2011 Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead.
2012
2013 \membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar}
2014
2015 \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
2016 \param{int }{thumbSize}, \param{int }{range},\rtfsp
2017 \param{bool }{refresh = TRUE}}
2018
2019 Sets the scrollbar properties of a built-in scrollbar.
2020
2021 \wxheading{Parameters}
2022
2023 \docparam{orientation}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.}
2024
2025 \docparam{position}{The position of the scrollbar in scroll units.}
2026
2027 \docparam{thumbSize}{The size of the thumb, or visible portion of the scrollbar, in scroll units.}
2028
2029 \docparam{range}{The maximum position of the scrollbar.}
2030
2031 \docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
2032
2033 \wxheading{Remarks}
2034
2035 Let's say you wish to display 50 lines of text, using the same font.
2036 The window is sized so that you can only see 16 lines at a time.
2037
2038 You would use:
2039
2040 {\small%
2041 \begin{verbatim}
2042 SetScrollbar(wxVERTICAL, 0, 16, 50);
2043 \end{verbatim}
2044 }
2045
2046 Note that with the window at this size, the thumb position can never go
2047 above 50 minus 16, or 34.
2048
2049 You can determine how many lines are currently visible by dividing the current view
2050 size by the character height in pixels.
2051
2052 When defining your own scrollbar behaviour, you will always need to recalculate
2053 the scrollbar settings when the window size changes. You could therefore put your
2054 scrollbar calculations and SetScrollbar
2055 call into a function named AdjustScrollbars, which can be called initially and also
2056 from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
2057
2058 \wxheading{See also}
2059
2060 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
2061 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
2062
2063 \begin{comment}
2064 \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
2065
2066 \func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = TRUE}}
2067
2068 Sets the page size of one of the built-in scrollbars.
2069
2070 \wxheading{Parameters}
2071
2072 \docparam{orientation}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.}
2073
2074 \docparam{pageSize}{Page size in scroll units.}
2075
2076 \docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
2077
2078 \wxheading{Remarks}
2079
2080 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
2081 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
2082 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
2083 value has to be adjusted when the window is resized, since the page size will have changed.
2084
2085 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
2086 the thumb changes size to reflect the page size relative to the length of the document. When the
2087 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
2088 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
2089 disappear.
2090
2091 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
2092 handling of pages and ranges.
2093
2094 \wxheading{See also}
2095
2096 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
2097 \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
2098 \helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
2099 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
2100 \end{comment}
2101
2102 \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
2103
2104 \func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = TRUE}}
2105
2106 Sets the position of one of the built-in scrollbars.
2107
2108 \wxheading{Parameters}
2109
2110 \docparam{orientation}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.}
2111
2112 \docparam{pos}{Position in scroll units.}
2113
2114 \docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
2115
2116 \wxheading{Remarks}
2117
2118 This function does not directly affect the contents of the window: it is up to the
2119 application to take note of scrollbar attributes and redraw contents accordingly.
2120
2121 \wxheading{See also}
2122
2123 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp
2124 \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
2125 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
2126 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
2127
2128 \begin{comment}
2129 \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
2130
2131 \func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = TRUE}}
2132
2133 Sets the range of one of the built-in scrollbars.
2134
2135 \wxheading{Parameters}
2136
2137 \docparam{orientation}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.}
2138
2139 \docparam{range}{Scroll range.}
2140
2141 \docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
2142
2143 \wxheading{Remarks}
2144
2145 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
2146 object length of the scrollbar. If you are implementing a scrolling window, for example, you
2147 would adjust the scroll range when the window is resized, by subtracting the window view size from the
2148 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
2149 and usually the scrollbar will be automatically hidden.
2150
2151 \wxheading{See also}
2152
2153 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
2154 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp
2155 \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
2156 \helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
2157 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
2158 \end{comment}
2159
2160 \membersection{wxWindow::SetSize}\label{wxwindowsetsize}
2161
2162 \func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
2163 \param{int}{ sizeFlags = wxSIZE\_AUTO}}
2164
2165 \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
2166
2167 Sets the size and position of the window in pixels.
2168
2169 \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
2170
2171 \func{virtual void}{SetSize}{\param{const wxSize\&}{ size}}
2172
2173 Sets the size of the window in pixels.
2174
2175 \wxheading{Parameters}
2176
2177 \docparam{x}{Required x position in pixels, or -1 to indicate that the existing
2178 value should be used.}
2179
2180 \docparam{y}{Required y position in pixels, or -1 to indicate that the existing
2181 value should be used.}
2182
2183 \docparam{width}{Required width in pixels, or -1 to indicate that the existing
2184 value should be used.}
2185
2186 \docparam{height}{Required height position in pixels, or -1 to indicate that the existing
2187 value should be used.}
2188
2189 \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}
2190
2191 \docparam{rect}{\helpref{wxRect}{wxrect} object for setting the position and size.}
2192
2193 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
2194
2195 {\bf wxSIZE\_AUTO\_WIDTH}: a -1 width value is taken to indicate
2196 a wxWindows-supplied default width.\\
2197 {\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height value is taken to indicate
2198 a wxWindows-supplied default width.\\
2199 {\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
2200 a wxWindows-supplied default size.\\
2201 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
2202 if -1 values are supplied.\\
2203 {\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of -1 and less to be interpreted
2204 as real dimensions, not default values.
2205 }
2206
2207 \wxheading{Remarks}
2208
2209 The second form is a convenience for calling the first form with default
2210 x and y parameters, and must be used with non-default width and height values.
2211
2212 The first form sets the position and optionally size, of the window.
2213 Parameters may be -1 to indicate either that a default should be supplied
2214 by wxWindows, or that the current value of the dimension should be used.
2215
2216 \wxheading{See also}
2217
2218 \helpref{wxWindow::Move}{wxwindowmove}
2219
2220 \pythonnote{In place of a single overloaded method name, wxPython
2221 implements the following methods:\par
2222 \indented{2cm}{\begin{twocollist}
2223 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE\_AUTO)}}{}
2224 \twocolitem{{\bf SetSize(size)}}{}
2225 \twocolitem{{\bf SetPosition(point)}}{}
2226 \end{twocollist}}
2227 }
2228
2229 \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
2230
2231 \func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
2232 \param{int}{ incW=-1}, \param{int}{ incH=-1}}
2233
2234 Allows specification of minimum and maximum window sizes, and window size increments.
2235 If a pair of values is not set (or set to -1), the default values will be used.
2236
2237 \wxheading{Parameters}
2238
2239 \docparam{minW}{Specifies the minimum width allowable.}
2240
2241 \docparam{minH}{Specifies the minimum height allowable.}
2242
2243 \docparam{maxW}{Specifies the maximum width allowable.}
2244
2245 \docparam{maxH}{Specifies the maximum height allowable.}
2246
2247 \docparam{incW}{Specifies the increment for sizing the width (Motif/Xt only).}
2248
2249 \docparam{incH}{Specifies the increment for sizing the height (Motif/Xt only).}
2250
2251 \wxheading{Remarks}
2252
2253 If this function is called, the user will not be able to size the window outside the
2254 given bounds.
2255
2256 The resizing increments are only significant under Motif or Xt.
2257
2258 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
2259
2260 \func{void}{SetSizer}{\param{wxSizer* }{sizer}}
2261
2262 Sets the window to have the given layout sizer. The window
2263 will then own the object, and will take care of its deletion.
2264 If an existing layout constraints object is already owned by the
2265 window, it will be deleted.
2266
2267 \wxheading{Parameters}
2268
2269 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and delete the window's
2270 sizer.}
2271
2272 \wxheading{Remarks}
2273
2274 You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use
2275 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
2276 explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints},
2277 only the sizer will have effect.
2278
2279 \membersection{wxWindow::SetTitle}\label{wxwindowsettitle}
2280
2281 \func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
2282
2283 Sets the window's title. Applicable only to frames and dialogs.
2284
2285 \wxheading{Parameters}
2286
2287 \docparam{title}{The window's title.}
2288
2289 \wxheading{See also}
2290
2291 \helpref{wxWindow::GetTitle}{wxwindowgettitle}
2292
2293 \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
2294
2295 \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}
2296
2297 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
2298 create a new validator of this type.
2299
2300 \membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
2301
2302 \func{void}{SetWindowStyle}{\param{long}{ style}}
2303
2304 Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}.
2305
2306 \membersection{wxWindow::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag}
2307
2308 \func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}}
2309
2310 Sets the style of the window. Please note that some styles cannot be changed
2311 after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might
2312 be called after changing the others for the change to take place immediately.
2313
2314 See \helpref{Window styles}{windowstyles} for more information about flags.
2315
2316 \wxheading{See also}
2317
2318 \helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag}
2319
2320 \membersection{wxWindow::Show}\label{wxwindowshow}
2321
2322 \func{virtual bool}{Show}{\param{bool}{ show}}
2323
2324 Shows or hides the window.
2325
2326 \wxheading{Parameters}
2327
2328 \docparam{show}{If TRUE, displays the window and brings it to the front. Otherwise,
2329 hides the window.}
2330
2331 \wxheading{See also}
2332
2333 \helpref{wxWindow::IsShown}{wxwindowisshown}
2334
2335 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
2336
2337 \func{virtual bool}{TransferDataFromWindow}{\void}
2338
2339 Transfers values from child controls to data areas specified by their validators. Returns
2340 FALSE if a transfer failed.
2341
2342 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2343 the method will also call TransferDataFromWindow() of all child windows.
2344
2345 \wxheading{See also}
2346
2347 \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
2348 \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
2349
2350 \membersection{wxWindow::TransferDataToWindow}\label{wxwindowtransferdatatowindow}
2351
2352 \func{virtual bool}{TransferDataToWindow}{\void}
2353
2354 Transfers values to child controls from data areas specified by their validators.
2355
2356 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2357 the method will also call TransferDataToWindow() of all child windows.
2358
2359 \wxheading{Return value}
2360
2361 Returns FALSE if a transfer failed.
2362
2363 \wxheading{See also}
2364
2365 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
2366 \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
2367
2368 \membersection{wxWindow::Validate}\label{wxwindowvalidate}
2369
2370 \func{virtual bool}{Validate}{\void}
2371
2372 Validates the current values of the child controls using their validators.
2373
2374 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
2375 the method will also call Validate() of all child windows.
2376
2377 \wxheading{Return value}
2378
2379 Returns FALSE if any of the validations failed.
2380
2381 \wxheading{See also}
2382
2383 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
2384 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
2385 \helpref{wxValidator}{wxvalidator}
2386
2387 \membersection{wxWindow::WarpPointer}\label{wxwindowwarppointer}
2388
2389 \func{void}{WarpPointer}{\param{int}{ x}, \param{int}{ y}}
2390
2391 Moves the pointer to the given position on the window.
2392
2393 \wxheading{Parameters}
2394
2395 \docparam{x}{The new x position for the cursor.}
2396
2397 \docparam{y}{The new y position for the cursor.}
2398