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