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