]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/window.tex
cleanup
[wxWidgets.git] / docs / latex / wx / window.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: window.tex
3 %% Purpose: wxWindow documentation
4 %% Author: wxWidgets Team
5 %% Modified by:
6 %% Created:
7 %% RCS-ID: $Id$
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxWindow}}\label{wxwindow}
13
14 wxWindow is the base class for all windows and represents any visible object on
15 screen. All controls, top level windows and so on are windows. Sizers and
16 device contexts are not, however, as they don't appear on screen themselves.
17
18 Please note that all children of the window will be deleted automatically by
19 the destructor before the window itself is deleted which means that you don't
20 have to worry about deleting them manually. Please see the \helpref{window
21 deletion overview}{windowdeletionoverview} for more information.
22
23 Also note that in this, and many others, wxWidgets classes some
24 \texttt{GetXXX()} methods may be overloaded (as, for example,
25 \helpref{GetSize}{wxwindowgetsize} or
26 \helpref{GetClientSize}{wxwindowgetclientsize}). In this case, the overloads
27 are non-virtual because having multiple virtual functions with the same name
28 results in a virtual function name hiding at the derived class level (in
29 English, this means that the derived class has to override all overloaded
30 variants if it overrides any of them). To allow overriding them in the derived
31 class, wxWidgets uses a unique protected virtual \texttt{DoGetXXX()} method
32 and all \texttt{GetXXX()} ones are forwarded to it, so overriding the former
33 changes the behaviour of the latter.
34
35 \wxheading{Derived from}
36
37 \helpref{wxEvtHandler}{wxevthandler}\\
38 \helpref{wxObject}{wxobject}
39
40 \wxheading{Include files}
41
42 <wx/window.h>
43
44 \wxheading{Library}
45
46 \helpref{wxCore}{librarieslist}
47
48 \wxheading{Window styles}
49
50 The following styles can apply to all windows, although they will not always make sense for a particular
51 window class or on all platforms.
52
53 \twocolwidtha{5cm}%
54 \begin{twocollist}\itemsep=0pt
55 \twocolitem{\windowstyle{wxBORDER\_DEFAULT}}{The window class will decide the kind of border to show, if any.}
56 \twocolitem{\windowstyle{wxBORDER\_SIMPLE}}{Displays a thin border around the window. wxSIMPLE\_BORDER is the old name
57 for this style. }
58 \twocolitem{\windowstyle{wxBORDER\_SUNKEN}}{Displays a sunken border. wxSUNKEN\_BORDER is the old name for this style.}
59 \twocolitem{\windowstyle{wxBORDER\_RAISED}}{Displays a raised border. wxRAISED\_BORDER is the old name for this style. }
60 \twocolitem{\windowstyle{wxBORDER\_STATIC}}{Displays a border suitable for a static control. wxSTATIC\_BORDER is the old name for this style. Windows only. }
61 \twocolitem{\windowstyle{wxBORDER\_THEME}}{Displays a native border suitable for a control, on the current platform. On Windows XP or Vista, this will be a themed border; on most other platforms
62 a sunken border will be used. For more information for themed borders on Windows, please see \helpref{Themed borders on Windows}{wxmswthemedborders}.}
63 \twocolitem{\windowstyle{wxBORDER\_NONE}}{Displays no border, overriding the default border style for the window. wxNO\_BORDER is the old name for this style.}
64 \twocolitem{\windowstyle{wxBORDER\_DOUBLE}}{This style is obsolete and should not be used.}
65 \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint
66 events. Windows only.}
67 \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.}
68 \twocolitem{\windowstyle{wxWANTS\_CHARS}}{Use this to indicate that
69 the window wants to get all char/key events for all keys - even for
70 keys like TAB or ENTER which are usually used for dialog navigation
71 and which wouldn't be generated without this style. If you need to
72 use this style in order to get the arrows or etc., but would still like
73 to have normal keyboard navigation take place, you should call
74 \helpref{Navigate}{wxwindownavigate} in response to the key events for
75 Tab and Shift-Tab.}
76 \twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting
77 the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete
78 and no longer has an effect.}
79 \twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical
80 scrollbar. Notice that this style cannot be used with native controls
81 which don't support scrollbars nor with top-level windows in most ports.}
82 \twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal
83 scrollbar. The same limitations as for wxVSCROLL apply to this style.}
84 \twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars,
85 disable them instead of hiding them when they are not needed (i.e. when the
86 size of the window is big enough to not require the scrollbars to navigate it).
87 This style is currently implemented for wxMSW, wxGTK and wxUniversal and does
88 nothing on the other platforms.}
89 \twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
90 repainted, then children being painted over them. Windows only.}
91 \twocolitem{\windowstyle{wxFULL\_REPAINT\_ON\_RESIZE}}{Use this style to force
92 a complete redraw of the window whenever it is resized instead of redrawing
93 just the part of the window affected by resizing. Note that this was the
94 behaviour by default before 2.5.1 release and that if you experience redraw
95 problems with code which previously used to work you may want to try this.
96 Currently this style applies on GTK+ 2 and Windows only, and full repainting is always
97 done on other platforms.}
98 \end{twocollist}
99
100 See also \helpref{window styles overview}{windowstyles}.
101
102 \wxheading{Extra window styles}
103
104 The following are extra styles, set using \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle}.
105
106 \twocolwidtha{5cm}%
107 \begin{twocollist}\itemsep=0pt
108 \twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{By default, Validate/TransferDataTo/FromWindow()
109 only work on direct children of the window (compatible behaviour). Set this flag to make them recursively
110 descend into all subwindows.}
111 \twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{wxCommandEvents and the objects of the derived classes are forwarded to the
112 parent window and so on recursively by default. Using this flag for the
113 given window allows to block this propagation at this window, i.e. prevent
114 the events from being propagated further upwards. Dialogs have this
115 flag on by default.}
116 \twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{Don't use this window as an implicit parent for the other windows: this must
117 be used with transient windows as otherwise there is the risk of creating a
118 dialog/frame with this window as a parent which would lead to a crash if the
119 parent is destroyed before the child.}
120 \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
121 if the mode set by \helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} is wxIDLE\_PROCESS\_SPECIFIED.}
122 \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
123 even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} is wxUPDATE\_UI\_PROCESS\_SPECIFIED.}
124 \end{twocollist}
125
126 \wxheading{See also}
127
128 \helpref{Event handling overview}{eventhandlingoverview}\\
129 \helpref{Window sizing overview}{windowsizingoverview}
130
131 \latexignore{\rtfignore{\wxheading{Members}}}
132
133
134 \membersection{wxWindow::wxWindow}\label{wxwindowctor}
135
136 \func{}{wxWindow}{\void}
137
138 Default constructor.
139
140 \func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
141 \param{const wxPoint\& }{pos = wxDefaultPosition},
142 \param{const wxSize\& }{size = wxDefaultSize},
143 \param{long }{style = 0},
144 \param{const wxString\& }{name = wxPanelNameStr}}
145
146 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
147
148 \wxheading{Parameters}
149
150 \docparam{parent}{Pointer to a parent window.}
151
152 \docparam{id}{Window identifier. If wxID\_ANY, will automatically create an identifier.}
153
154 \docparam{pos}{Window position. wxDefaultPosition indicates that wxWidgets
155 should generate a default position for the window. If using the wxWindow class directly, supply
156 an actual position.}
157
158 \docparam{size}{Window size. wxDefaultSize indicates that wxWidgets
159 should generate a default size for the window. If no suitable size can be found, the
160 window will be sized to 20x20 pixels so that the window is visible but obviously not
161 correctly sized. }
162
163 \docparam{style}{Window style. For generic window styles, please see \helpref{wxWindow}{wxwindow}.}
164
165 \docparam{name}{Window name.}
166
167
168 \membersection{wxWindow::\destruct{wxWindow}}\label{wxwindowdtor}
169
170 \func{}{\destruct{wxWindow}}{\void}
171
172 Destructor. Deletes all subwindows, then deletes itself. Instead of using
173 the {\bf delete} operator explicitly, you should normally
174 use \helpref{wxWindow::Destroy}{wxwindowdestroy} so that wxWidgets
175 can delete a window only when it is safe to do so, in idle time.
176
177 \wxheading{See also}
178
179 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
180 \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
181 \helpref{wxCloseEvent}{wxcloseevent}
182
183
184 \membersection{wxWindow::AcceptsFocus}\label{wxwindowacceptsfocus}
185
186 \constfunc{bool}{AcceptsFocus}{\void}
187
188 This method may be overridden in the derived classes to return \false to
189 indicate that this control doesn't accept input at all (i.e. behaves like e.g.
190 \helpref{wxStaticText}{wxstatictext}) and so doesn't need focus.
191
192 \wxheading{See also}
193
194 \helpref{AcceptsFocusFromKeyboard}{wxwindowacceptsfocusfromkeyboard}
195
196
197 \membersection{wxWindow::AcceptsFocusFromKeyboard}\label{wxwindowacceptsfocusfromkeyboard}
198
199 \constfunc{bool}{AcceptsFocusFromKeyboard}{\void}
200
201 This method may be overridden in the derived classes to return \false to
202 indicate that while this control can, in principle, have focus if the user
203 clicks it with the mouse, it shouldn't be included in the TAB traversal chain
204 when using the keyboard.
205
206
207 \membersection{wxWindow::AddChild}\label{wxwindowaddchild}
208
209 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}
210
211 Adds a child window. This is called automatically by window creation
212 functions so should not be required by the application programmer.
213
214 Notice that this function is mostly internal to wxWidgets and shouldn't be
215 called by the user code.
216
217 \wxheading{Parameters}
218
219 \docparam{child}{Child window to add.}
220
221
222 \membersection{wxWindow::AlwaysShowScrollbars}\label{wxwindowalwaysshowscrollbars}
223
224 \func{void}{AlwaysShowScrollbars}{\param{bool}{ hflag}, \param{bool}{ vflag}}
225
226 Call this function to force one or both scrollbars to be always shown, even if
227 the window is big enough to show its entire contents without scrolling.
228
229 \newsince{2.9.0}
230
231 \wxheading{Parameters}
232
233 \docparam{hflag}{Whether the horizontal scroll bar should always be visible.}
234
235 \docparam{vflag}{Whether the vertical scroll bar should always be visible.}
236
237 \wxheading{Remarks}
238
239 This function is currently only implemented under Mac/Carbon.
240
241
242 \membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
243
244 \constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}
245
246 Sets the cached best size value.
247
248
249 \membersection{wxWindow::CanSetTransparent}\label{wxwindowcansettransparent}
250
251 \func{bool}{CanSetTransparent}{\void}
252
253 Returns \true if the system supports transparent windows and calling
254 \helpref{SetTransparent}{wxwindowsettransparent} may succeed. If this function
255 returns \false, transparent windows are definitely not supported by the current
256 system.
257
258
259 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
260
261 \func{virtual void}{CaptureMouse}{\void}
262
263 Directs all mouse input to this window. Call \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse} to
264 release the capture.
265
266 Note that wxWidgets maintains the stack of windows having captured the mouse
267 and when the mouse is released the capture returns to the window which had had
268 captured it previously and it is only really released if there were no previous
269 window. In particular, this means that you must release the mouse as many times
270 as you capture it, unless the window receives
271 the \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} event.
272
273 Any application which captures the mouse in the beginning of some operation
274 {\em must} handle \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
275 and cancel this operation when it receives the event. The event handler must
276 not recapture mouse.
277
278 \wxheading{See also}
279
280 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}
281 \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
282
283
284 \membersection{wxWindow::Center}\label{wxwindowcenter}
285
286 \func{void}{Center}{\param{int}{ direction}}
287
288 A synonym for \helpref{Centre}{wxwindowcentre}.
289
290
291 \membersection{wxWindow::CenterOnParent}\label{wxwindowcenteronparent}
292
293 \func{void}{CenterOnParent}{\param{int}{ direction}}
294
295 A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}.
296
297
298 \membersection{wxWindow::CenterOnScreen}\label{wxwindowcenteronscreen}
299
300 \func{void}{CenterOnScreen}{\param{int}{ direction}}
301
302 A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}.
303
304
305 \membersection{wxWindow::Centre}\label{wxwindowcentre}
306
307 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
308
309 Centres the window.
310
311 \wxheading{Parameters}
312
313 \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
314 or {\tt wxBOTH}. It may also include {\tt wxCENTRE\_ON\_SCREEN} flag
315 if you want to center the window on the entire screen and not on its
316 parent window.}
317
318 The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer
319 (it has no effect).
320
321 \wxheading{Remarks}
322
323 If the window is a top level one (i.e. doesn't have a parent), it will be
324 centered relative to the screen anyhow.
325
326 \wxheading{See also}
327
328 \helpref{wxWindow::Center}{wxwindowcenter}
329
330
331 \membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent}
332
333 \func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
334
335 Centres the window on its parent. This is a more readable synonym for
336 \helpref{Centre}{wxwindowcentre}.
337
338 \wxheading{Parameters}
339
340 \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
341 or {\tt wxBOTH}.}
342
343 \wxheading{Remarks}
344
345 This methods provides for a way to center top level windows over their
346 parents instead of the entire screen. If there is no parent or if the
347 window is not a top level window, then behaviour is the same as
348 \helpref{wxWindow::Centre}{wxwindowcentre}.
349
350 \wxheading{See also}
351
352 \helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen}
353
354
355 \membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen}
356
357 \func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
358
359 Centres the window on screen. This only works for top level windows -
360 otherwise, the window will still be centered on its parent.
361
362 \wxheading{Parameters}
363
364 \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
365 or {\tt wxBOTH}.}
366
367 \wxheading{See also}
368
369 \helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent}
370
371
372 \membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground}
373
374 \func{void}{ClearBackground}{\void}
375
376 Clears the window by filling it with the current background colour. Does not
377 cause an erase background event to be generated.
378
379
380 \membersection{wxWindow::ClientToScreen}\label{wxwindowclienttoscreen}
381
382 \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
383
384 \perlnote{In wxPerl this method returns a 2-element list instead of
385 modifying its parameters.}
386
387 \constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}}
388
389 Converts to screen coordinates from coordinates relative to this window.
390
391 \docparam{x}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
392 a screen coordinate will be passed out.}
393
394 \docparam{y}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
395 a screen coordinate will be passed out.}
396
397 \docparam{pt}{The client position for the second form of the function.}
398
399 \pythonnote{In place of a single overloaded method name, wxPython
400 implements the following methods:\par
401 \indented{2cm}{\begin{twocollist}
402 \twocolitem{{\bf ClientToScreen(point)}}{Accepts and returns a wxPoint}
403 \twocolitem{{\bf ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)}
404 \end{twocollist}}
405 }
406
407
408 \membersection{wxWindow::Close}\label{wxwindowclose}
409
410 \func{bool}{Close}{\param{bool}{ force = {\tt false}}}
411
412 This function simply generates a \helpref{wxCloseEvent}{wxcloseevent} whose
413 handler usually tries to close the window. It doesn't close the window itself,
414 however.
415
416 \wxheading{Parameters}
417
418 \docparam{force}{{\tt false} if the window's close handler should be able to veto the destruction
419 of this window, {\tt true} if it cannot.}
420
421 \wxheading{Remarks}
422
423 Close calls the \helpref{close handler}{wxcloseevent} for the window, providing
424 an opportunity for the window to choose whether to destroy the window.
425 Usually it is only used with the top level windows (wxFrame and wxDialog
426 classes) as the others are not supposed to have any special OnClose() logic.
427
428 The close handler should check whether the window is being deleted forcibly,
429 using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}, in which case it
430 should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
431
432 {\it Note} that calling Close does not guarantee that the window will be
433 destroyed; but it provides a way to simulate a manual close of a window, which
434 may or may not be implemented by destroying the window. The default
435 implementation of wxDialog::OnCloseWindow does not necessarily delete the
436 dialog, since it will simply simulate an wxID\_CANCEL event which is handled by
437 the appropriate button event handler and may do anything at all.
438
439 To guarantee that the window will be destroyed, call
440 \helpref{wxWindow::Destroy}{wxwindowdestroy} instead
441
442 \wxheading{See also}
443
444 \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
445 \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
446 \helpref{wxCloseEvent}{wxcloseevent}
447
448
449 \membersection{wxWindow::ConvertDialogToPixels}\label{wxwindowconvertdialogtopixels}
450
451 \func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}}
452
453 \func{wxSize}{ConvertDialogToPixels}{\param{const wxSize\&}{ sz}}
454
455 Converts a point or size from dialog units to pixels.
456
457 For the x dimension, the dialog units are multiplied by the average character width
458 and then divided by 4.
459
460 For the y dimension, the dialog units are multiplied by the average character height
461 and then divided by 8.
462
463 \wxheading{Remarks}
464
465 Dialog units are used for maintaining a dialog's proportions even if the font changes.
466
467 You can also use these functions programmatically. A convenience macro is defined:
468
469 {\small
470 \begin{verbatim}
471 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
472 \end{verbatim}
473 }
474
475 \wxheading{See also}
476
477 \helpref{wxWindow::ConvertPixelsToDialog}{wxwindowconvertpixelstodialog}
478
479 \pythonnote{In place of a single overloaded method name, wxPython
480 implements the following methods:\par
481 \indented{2cm}{\begin{twocollist}
482 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
483 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
484 \end{twocollist}}
485
486 Additionally, the following helper functions are defined:\par
487 \indented{2cm}{\begin{twocollist}
488 \twocolitem{{\bf wxDLG\_PNT(win, point)}}{Converts a wxPoint from dialog
489 units to pixels}
490 \twocolitem{{\bf wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog
491 units to pixels}
492 \end{twocollist}}
493 }
494
495
496
497 \membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog}
498
499 \func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}}
500
501 \func{wxSize}{ConvertPixelsToDialog}{\param{const wxSize\&}{ sz}}
502
503 Converts a point or size from pixels to dialog units.
504
505 For the x dimension, the pixels are multiplied by 4 and then divided by the average
506 character width.
507
508 For the y dimension, the pixels are multiplied by 8 and then divided by the average
509 character height.
510
511 \wxheading{Remarks}
512
513 Dialog units are used for maintaining a dialog's proportions even if the font changes.
514
515 \wxheading{See also}
516
517 \helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
518
519 \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par
520 \indented{2cm}{\begin{twocollist}
521 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
522 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
523 \end{twocollist}}
524 }
525
526
527 \membersection{wxWindow::Destroy}\label{wxwindowdestroy}
528
529 \func{virtual bool}{Destroy}{\void}
530
531 Destroys the window safely. Use this function instead of the delete operator, since
532 different window classes can be destroyed differently. Frames and dialogs
533 are not destroyed immediately when this function is called -- they are added
534 to a list of windows to be deleted on idle time, when all the window's events
535 have been processed. This prevents problems with events being sent to non-existent
536 windows.
537
538 \wxheading{Return value}
539
540 {\tt true} if the window has either been successfully deleted, or it has been added
541 to the list of windows pending real deletion.
542
543
544 \membersection{wxWindow::DestroyChildren}\label{wxwindowdestroychildren}
545
546 \func{virtual void}{DestroyChildren}{\void}
547
548 Destroys all children of a window. Called automatically by the destructor.
549
550
551 \membersection{wxWindow::Disable}\label{wxwindowdisable}
552
553 \func{bool}{Disable}{\void}
554
555 Disables the window, same as \helpref{Enable({\tt false})}{wxwindowenable}.
556
557 \wxheading{Return value}
558
559 Returns {\tt true} if the window has been disabled, {\tt false} if it had been
560 already disabled before the call to this function.
561
562
563 \membersection{wxWindow::DoGetBestSize}\label{wxwindowdogetbestsize}
564
565 \constfunc{virtual wxSize}{DoGetBestSize}{\void}
566
567 Gets the size which best suits the window: for a control, it would be
568 the minimal size which doesn't truncate the control, for a panel - the
569 same size as it would have after a call to \helpref{Fit()}{wxwindowfit}.
570
571
572 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
573
574 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}
575
576 Does the window-specific updating after processing the update event.
577 This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui}
578 in order to check return values in the \helpref{wxUpdateUIEvent}{wxupdateuievent} and
579 act appropriately. For example, to allow frame and dialog title updating, wxWidgets
580 implements this function as follows:
581
582 \begin{verbatim}
583 // do the window-specific processing after processing the update event
584 void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
585 {
586 if ( event.GetSetEnabled() )
587 Enable(event.GetEnabled());
588
589 if ( event.GetSetText() )
590 {
591 if ( event.GetText() != GetTitle() )
592 SetTitle(event.GetText());
593 }
594 }
595 \end{verbatim}
596
597
598
599 \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
600
601 \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
602
603 Enables or disables eligibility for drop file events (OnDropFiles).
604
605 \wxheading{Parameters}
606
607 \docparam{accept}{If {\tt true}, the window is eligible for drop file events. If {\tt false}, the window
608 will not accept drop file events.}
609
610 \wxheading{Remarks}
611
612 Windows only.
613
614
615 \membersection{wxWindow::Enable}\label{wxwindowenable}
616
617 \func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}}
618
619 Enable or disable the window for user input. Note that when a parent window is
620 disabled, all of its children are disabled as well and they are reenabled again
621 when the parent is.
622
623 \wxheading{Parameters}
624
625 \docparam{enable}{If {\tt true}, enables the window for input. If {\tt false}, disables the window.}
626
627 \wxheading{Return value}
628
629 Returns {\tt true} if the window has been enabled or disabled, {\tt false} if
630 nothing was done, i.e. if the window had already been in the specified state.
631
632 \wxheading{See also}
633
634 \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
635 \helpref{wxWindow::Disable}{wxwindowdisable},\rtfsp
636 \helpref{wxRadioBox::Enable}{wxradioboxenable}
637
638
639 \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus}
640
641 \func{static wxWindow*}{FindFocus}{\void}
642
643 Finds the window or control which currently has the keyboard focus.
644
645 \wxheading{Remarks}
646
647 Note that this is a static function, so it can be called without needing a wxWindow pointer.
648
649 \wxheading{See also}
650
651 \helpref{wxWindow::SetFocus}{wxwindowsetfocus}
652
653
654
655 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
656
657 \constfunc{wxWindow*}{FindWindow}{\param{long}{ id}}
658
659 Find a child of this window, by identifier.
660
661 \constfunc{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
662
663 Find a child of this window, by name.
664
665 \pythonnote{In place of a single overloaded method name, wxPython
666 implements the following methods:\par
667 \indented{2cm}{\begin{twocollist}
668 \twocolitem{{\bf FindWindowById(id)}}{Accepts an integer}
669 \twocolitem{{\bf FindWindowByName(name)}}{Accepts a string}
670 \end{twocollist}}
671 }
672
673
674 \membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid}
675
676 \func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}}
677
678 Find the first window with the given {\it id}.
679
680 If {\it parent} is NULL, the search will start from all top-level
681 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
682 The search is recursive in both cases.
683
684 \wxheading{See also}
685
686 \helpref{FindWindow}{wxwindowfindwindow}
687
688
689 \membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel}
690
691 \func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}}
692
693 Find a window by its label. Depending on the type of window, the label may be a window title
694 or panel item label. If {\it parent} is NULL, the search will start from all top-level
695 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
696 The search is recursive in both cases.
697
698 \wxheading{See also}
699
700 \helpref{FindWindow}{wxwindowfindwindow}
701
702
703 \membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname}
704
705 \func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}}
706
707 Find a window by its name (as given in a window constructor or {\bf Create} function call).
708 If {\it parent} is NULL, the search will start from all top-level
709 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
710 The search is recursive in both cases.
711
712 If no window with such name is found,
713 \helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called.
714
715 \wxheading{See also}
716
717 \helpref{FindWindow}{wxwindowfindwindow}
718
719
720 \membersection{wxWindow::Fit}\label{wxwindowfit}
721
722 \func{virtual void}{Fit}{\void}
723
724 Sizes the window so that it fits around its subwindows. This function won't do
725 anything if there are no subwindows and will only really work correctly if
726 sizers are used for the subwindows layout. Also, if the window has exactly one
727 subwindow it is better (faster and the result is more precise as Fit adds some
728 margin to account for fuzziness of its calculations) to call
729
730 \begin{verbatim}
731 window->SetClientSize(child->GetSize());
732 \end{verbatim}
733
734 instead of calling Fit.
735
736
737 \membersection{wxWindow::FitInside}\label{wxwindowfitinside}
738
739 \func{virtual void}{FitInside}{\void}
740
741 Similar to \helpref{Fit}{wxwindowfit}, but sizes the interior (virtual) size
742 of a window. Mainly useful with scrolled windows to reset scrollbars after
743 sizing changes that do not trigger a size event, and/or scrolled windows without
744 an interior sizer. This function similarly won't do anything if there are no
745 subwindows.
746
747
748 \membersection{wxWindow::Freeze}\label{wxwindowfreeze}
749
750 \func{virtual void}{Freeze}{\void}
751
752 Freezes the window or, in other words, prevents any updates from taking place
753 on screen, the window is not redrawn at all. \helpref{Thaw}{wxwindowthaw} must
754 be called to reenable window redrawing. Calls to these two functions may be
755 nested.
756
757 This method is useful for visual appearance optimization (for example, it
758 is a good idea to use it before doing many large text insertions in a row into
759 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
760 controls so it is mostly just a hint to wxWidgets and not a mandatory
761 directive.
762
763 \wxheading{See also}
764
765 \helpref{wxWindowUpdateLocker}{wxwindowupdatelocker}
766
767
768 \membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable}
769
770 \constfunc{wxAcceleratorTable*}{GetAcceleratorTable}{\void}
771
772 Gets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}.
773
774
775 \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible}
776
777 \func{wxAccessible*}{GetAccessible}{\void}
778
779 Returns the accessible object for this window, if any.
780
781 See also \helpref{wxAccessible}{wxaccessible}.
782
783
784 \membersection{wxWindow::GetAdjustedBestSize}\label{wxwindowgetadjustedbestsize}
785
786 \constfunc{wxSize}{GetAdjustedBestSize}{\void}
787
788 This method is deprecated, use \helpref{GetEffectiveMinSize}{wxwindowgeteffectiveminsize}
789 instead.
790
791
792 \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}
793
794 \constfunc{virtual wxColour}{GetBackgroundColour}{\void}
795
796 Returns the background colour of the window.
797
798 \wxheading{See also}
799
800 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
801 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
802 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
803
804 \membersection{wxWindow::GetBackgroundStyle}\label{wxwindowgetbackgroundstyle}
805
806 \constfunc{virtual wxBackgroundStyle}{GetBackgroundStyle}{\void}
807
808 Returns the background style of the window. The background style can be one of:
809 \begin{twocollist}\itemsep=0pt
810 \twocolitem{wxBG\_STYLE\_SYSTEM}{Use the default background, as determined by
811 the system or the current theme.}
812 \twocolitem{wxBG\_STYLE\_COLOUR}{Use a solid colour for the background, this
813 style is set automatically if you call
814 \helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour} so you only need to
815 set it explicitly if you had changed the background style to something else
816 before.}
817 \twocolitem{wxBG\_STYLE\_CUSTOM}{Don't draw the background at all, it's
818 supposed that it is drawn by the user-defined erase background event handler.
819 This style should be used to avoid flicker when the background is entirely
820 custom-drawn.}
821 \twocolitem{wxBG\_STYLE\_TRANSPARET}{The background is (partially) transparent,
822 this style is automatically set if you call
823 \helpref{SetTransparent}{wxwindowsettransparent} which is used to set the
824 transparency level.}
825 \end{twocollist}
826
827 \wxheading{See also}
828
829 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
830 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
831 \helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle},\rtfsp
832 \helpref{wxWindow::SetTransparent}{wxwindowsettransparent}
833
834
835 \membersection{wxWindow::GetEffectiveMinSize}\label{wxwindowgeteffectiveminsize}
836
837 \constfunc{wxSize}{GetEffectiveMinSize}{\void}
838
839 Merges the window's best size into the min size and returns the
840 result. This is the value used by sizers to determine the appropriate
841 ammount of sapce to allocate for the widget.
842
843 \wxheading{See also}
844
845 \helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
846 \helpref{wxWindow::SetInitialSize}{wxwindowsetinitialsize}
847
848
849 \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
850
851 \constfunc{wxSize}{GetBestSize}{\void}
852
853 This functions returns the best acceptable minimal size for the window. For
854 example, for a static control, it will be the minimal size such that the
855 control label is not truncated. For windows containing subwindows (typically
856 \helpref{wxPanel}{wxpanel}), the size returned by this function will be the
857 same as the size the window would have had after calling
858 \helpref{Fit}{wxwindowfit}.
859
860
861 \membersection{wxWindow::GetCapture}\label{wxwindowgetcapture}
862
863 \func{static wxWindow *}{GetCapture}{\void}
864
865 Returns the currently captured window.
866
867 \wxheading{See also}
868
869 \helpref{wxWindow::HasCapture}{wxwindowhascapture},
870 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
871 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
872 \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
873 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
874
875
876 \membersection{wxWindow::GetCaret}\label{wxwindowgetcaret}
877
878 \constfunc{wxCaret *}{GetCaret}{\void}
879
880 Returns the \helpref{caret}{wxcaret} associated with the window.
881
882
883 \membersection{wxWindow::GetCharHeight}\label{wxwindowgetcharheight}
884
885 \constfunc{virtual int}{GetCharHeight}{\void}
886
887 Returns the character height for this window.
888
889
890 \membersection{wxWindow::GetCharWidth}\label{wxwindowgetcharwidth}
891
892 \constfunc{virtual int}{GetCharWidth}{\void}
893
894 Returns the average character width for this window.
895
896
897 \membersection{wxWindow::GetChildren}\label{wxwindowgetchildren}
898
899 \func{wxWindowList\&}{GetChildren}{\void}
900
901 \constfunc{const wxWindowList\&}{GetChildren}{\void}
902
903 Returns a reference to the list of the window's children. \texttt{wxWindowList}
904 is a type-safe \helpref{wxList}{wxlist}-like class whose elements are of type
905 \texttt{wxWindow *}.
906
907
908 \membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}
909
910 \func{static wxVisualAttributes}{GetClassDefaultAttributes}{\param{wxWindowVariant}{ variant = \texttt{wxWINDOW\_VARIANT\_NORMAL}}}
911
912 Returns the default font and colours which are used by the control. This is
913 useful if you want to use the same font or colour in your own control as in a
914 standard control -- which is a much better idea than hard coding specific
915 colours or fonts which might look completely out of place on the users
916 system, especially if it uses themes.
917
918 The \arg{variant} parameter is only relevant under Mac currently and is
919 ignore under other platforms. Under Mac, it will change the size of the
920 returned font. See \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}
921 for more about this.
922
923 This static method is ``overridden'' in many derived classes and so calling,
924 for example, \helpref{wxButton}{wxbutton}::GetClassDefaultAttributes() will typically
925 return the values appropriate for a button which will be normally different
926 from those returned by, say, \helpref{wxListCtrl}{wxlistctrl}::GetClassDefaultAttributes().
927
928 The \texttt{wxVisualAttributes} structure has at least the fields
929 \texttt{font}, \texttt{colFg} and \texttt{colBg}. All of them may be invalid
930 if it was not possible to determine the default control appearance or,
931 especially for the background colour, if the field doesn't make sense as is
932 the case for \texttt{colBg} for the controls with themed background.
933
934 \wxheading{See also}
935
936 \helpref{InheritAttributes}{wxwindowinheritattributes}
937
938
939 \membersection{wxWindow::GetClientSize}\label{wxwindowgetclientsize}
940
941 \constfunc{void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}}
942
943 \perlnote{In wxPerl this method takes no parameter and returns
944 a 2-element list {\tt (width, height)}.}
945
946 \constfunc{wxSize}{GetClientSize}{\void}
947
948 Returns the size of the window `client area' in pixels. The client area is the
949 area which may be drawn on by the programmer, excluding title bar, border,
950 scrollbars, etc.
951
952 Note that if this window is a top-level one and it is currently minimized, the
953 return size is empty (both width and height are $0$).
954
955 \wxheading{Parameters}
956
957 \docparam{width}{Receives the client width in pixels.}
958
959 \docparam{height}{Receives the client height in pixels.}
960
961 \pythonnote{In place of a single overloaded method name, wxPython
962 implements the following methods:\par
963 \indented{2cm}{\begin{twocollist}
964 \twocolitem{{\bf GetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
965 \twocolitem{{\bf GetClientSize()}}{Returns a wxSize object}
966 \end{twocollist}}
967 }
968
969 \wxheading{See also}
970
971 \helpref{GetSize}{wxwindowgetsize},\rtfsp
972 \helpref{GetVirtualSize}{wxwindowgetvirtualsize}
973
974
975
976 \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
977
978 \constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
979
980 Returns a pointer to the window's layout constraints, or NULL if there are none.
981
982
983 \membersection{wxWindow::GetContainingSizer}\label{wxwindowgetcontainingsizer}
984
985 \constfunc{const wxSizer *}{GetContainingSizer}{\void}
986
987 Return the sizer that this window is a member of, if any, otherwise
988 {\tt NULL}.
989
990
991 \membersection{wxWindow::GetCursor}\label{wxwindowgetcursor}
992
993 \constfunc{const wxCursor\&}{GetCursor}{\void}
994
995 Return the cursor associated with this window.
996
997 \wxheading{See also}
998
999 \helpref{wxWindow::SetCursor}{wxwindowsetcursor}
1000
1001
1002 \membersection{wxWindow::GetDefaultAttributes}\label{wxwindowgetdefaultattributes}
1003
1004 \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void}
1005
1006 Currently this is the same as calling
1007 \helpref{GetClassDefaultAttributes}{wxwindowgetclassdefaultattributes}(\helpref{GetWindowVariant}{wxwindowgetwindowvariant}()).
1008
1009 One advantage of using this function compared to the static version is that
1010 the call is automatically dispatched to the correct class (as usual with
1011 virtual functions) and you don't have to specify the class name explicitly.
1012
1013 The other one is that in the future this function could return different
1014 results, for example it might return a different font for an ``Ok'' button
1015 than for a generic button if the users GUI is configured to show such buttons
1016 in bold font. Of course, the down side is that it is impossible to call this
1017 function without actually having an object to apply it to whereas the static
1018 version can be used without having to create an object first.
1019
1020
1021 \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget}
1022
1023 \constfunc{wxDropTarget*}{GetDropTarget}{\void}
1024
1025 Returns the associated drop target, which may be NULL.
1026
1027 \wxheading{See also}
1028
1029 \helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
1030 \helpref{Drag and drop overview}{wxdndoverview}
1031
1032
1033 \membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
1034
1035 \constfunc{wxEvtHandler*}{GetEventHandler}{\void}
1036
1037 Returns the event handler for this window. By default, the window is its
1038 own event handler.
1039
1040 \wxheading{See also}
1041
1042 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
1043 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
1044 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
1045 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
1046 \helpref{wxEvtHandler}{wxevthandler}\rtfsp
1047
1048
1049 \membersection{wxWindow::GetExtraStyle}\label{wxwindowgetextrastyle}
1050
1051 \constfunc{long}{GetExtraStyle}{\void}
1052
1053 Returns the extra style bits for the window.
1054
1055
1056 \membersection{wxWindow::GetFont}\label{wxwindowgetfont}
1057
1058 \constfunc{wxFont}{GetFont}{\void}
1059
1060 Returns the font for this window.
1061
1062 \wxheading{See also}
1063
1064 \helpref{wxWindow::SetFont}{wxwindowsetfont}
1065
1066
1067 \membersection{wxWindow::GetForegroundColour}\label{wxwindowgetforegroundcolour}
1068
1069 \func{virtual wxColour}{GetForegroundColour}{\void}
1070
1071 Returns the foreground colour of the window.
1072
1073 \wxheading{Remarks}
1074
1075 The interpretation of foreground colour is open to interpretation according
1076 to the window class; it may be the text colour or other colour, or it may not
1077 be used at all.
1078
1079 \wxheading{See also}
1080
1081 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
1082 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
1083 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
1084
1085
1086 \membersection{wxWindow::GetGrandParent}\label{wxwindowgetgrandparent}
1087
1088 \constfunc{wxWindow*}{GetGrandParent}{\void}
1089
1090 Returns the grandparent of a window, or NULL if there isn't one.
1091
1092
1093 \membersection{wxWindow::GetHandle}\label{wxwindowgethandle}
1094
1095 \constfunc{void*}{GetHandle}{\void}
1096
1097 Returns the platform-specific handle of the physical window. Cast it to an appropriate
1098 handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif, {\bf GtkWidget} for GTK or {\bf WinHandle} for PalmOS.
1099
1100 \pythonnote{This method will return an integer in wxPython.}
1101
1102 \perlnote{This method will return an integer in wxPerl.}
1103
1104
1105 \membersection{wxWindow::GetHelpTextAtPoint}\label{wxwindowgethelptextatpoint}
1106
1107 \constfunc{virtual wxString}{GetHelpTextAtPoint}{\param{const wxPoint &}{point}, \param{wxHelpEvent::Origin }{origin}}
1108
1109 Gets the help text to be used as context-sensitive help for this window. This
1110 method should be overridden if the help message depends on the position inside
1111 the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used.
1112
1113 \wxheading{Parameters}
1114
1115 \docparam{point}{Coordinates of the mouse at the moment of help event emission.}
1116
1117 \docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.}
1118
1119 \newsince{2.7.0}
1120
1121
1122 \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
1123
1124 \constfunc{virtual wxString}{GetHelpText}{\void}
1125
1126 Gets the help text to be used as context-sensitive help for this window.
1127
1128 Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation,
1129 and not in the window object itself.
1130
1131 \wxheading{See also}
1132
1133 \helpref{SetHelpText}{wxwindowsethelptext}, \helpref{GetHelpTextAtPoint}{wxwindowgethelptextatpoint}, \helpref{wxHelpProvider}{wxhelpprovider}
1134
1135
1136 \membersection{wxWindow::GetId}\label{wxwindowgetid}
1137
1138 \constfunc{int}{GetId}{\void}
1139
1140 Returns the identifier of the window.
1141
1142 \wxheading{Remarks}
1143
1144 Each window has an integer identifier. If the application has not provided one
1145 (or the default wxID\_ANY) an unique identifier with a negative value will be generated.
1146
1147 \wxheading{See also}
1148
1149 \helpref{wxWindow::SetId}{wxwindowsetid},\rtfsp
1150 \helpref{Window identifiers}{windowids}
1151
1152
1153 \membersection{wxWindow::GetLabel}\label{wxwindowgetlabel}
1154
1155 \constfunc{virtual wxString }{GetLabel}{\void}
1156
1157 Generic way of getting a label from any window, for
1158 identification purposes.
1159
1160 \wxheading{Remarks}
1161
1162 The interpretation of this function differs from class to class.
1163 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
1164 the button text. This function can be useful for meta-programs (such as testing
1165 tools or special-needs access programs) which need to identify windows
1166 by name.
1167
1168 \membersection{wxWindow::GetMaxSize}\label{wxwindowgetmaxsize}
1169
1170 \constfunc{wxSize}{GetMaxSize}{\void}
1171
1172 Returns the maximum size of the window, an indication to the sizer layout mechanism
1173 that this is the maximum possible size.
1174
1175 \membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
1176
1177 \constfunc{virtual wxSize}{GetMinSize}{\void}
1178
1179 Returns the minimum size of the window, an indication to the sizer layout mechanism
1180 that this is the minimum required size. It normally just returns the value set
1181 by \helpref{SetMinSize}{wxwindowsetminsize}, but it can be overridden to do the
1182 calculation on demand.
1183
1184 \membersection{wxWindow::GetName}\label{wxwindowgetname}
1185
1186 \constfunc{virtual wxString }{GetName}{\void}
1187
1188 Returns the window's name.
1189
1190 \wxheading{Remarks}
1191
1192 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
1193 name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetname}.
1194
1195 \wxheading{See also}
1196
1197 \helpref{wxWindow::SetName}{wxwindowsetname}
1198
1199
1200 \membersection{wxWindow::GetParent}\label{wxwindowgetparent}
1201
1202 \constfunc{virtual wxWindow*}{GetParent}{\void}
1203
1204 Returns the parent of the window, or NULL if there is no parent.
1205
1206
1207 \membersection{wxWindow::GetPopupMenuSelectionFromUser}\label{wxwindowgetpopupmenuselectionfromuser}
1208
1209 \func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{const wxPoint\&}{ pos}}
1210
1211 \func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{int}{ x}, \param{int}{ y}}
1212
1213 This function shows a popup menu at the given position in this window and
1214 returns the selected id. It can be more convenient than the general purpose
1215 \helpref{PopupMenu}{wxwindowpopupmenu} function for simple menus proposing a
1216 choice in a list of strings to the user.
1217
1218 \wxheading{Parameters}
1219
1220 \docparam{menu}{The menu to show}
1221
1222 \docparam{pos}{The position at which to show the menu in client coordinates}
1223
1224 \docparam{x}{The horizontal position of the menu}
1225
1226 \docparam{y}{The vertical position of the menu}
1227
1228 \wxheading{Return value}
1229
1230 The selected menu item id or \texttt{wxID\_NONE} if none selected or an error
1231 occurred.
1232
1233
1234 \membersection{wxWindow::GetPosition}\label{wxwindowgetposition}
1235
1236 \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}
1237
1238 \constfunc{wxPoint}{GetPosition}{\void}
1239
1240 This gets the position of the window in pixels, relative to the parent window
1241 for the child windows or relative to the display origin for the top level
1242 windows.
1243
1244 \wxheading{Parameters}
1245
1246 \docparam{x}{Receives the x position of the window if non-\NULL.}
1247
1248 \docparam{y}{Receives the y position of the window if non-\NULL.}
1249
1250 \pythonnote{In place of a single overloaded method name, wxPython
1251 implements the following methods:\par
1252 \indented{2cm}{\begin{twocollist}
1253 \twocolitem{{\bf GetPosition()}}{Returns a wxPoint}
1254 \twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)}
1255 \end{twocollist}}
1256 }
1257
1258 \perlnote{In wxPerl there are two methods instead of a single overloaded
1259 method:\par
1260 \indented{2cm}{\begin{twocollist}
1261 \twocolitem{{\bf GetPosition()}}{Returns a Wx::Point}
1262 \twocolitem{{\bf GetPositionXY()}}{Returns a 2-element list
1263 {\tt ( x, y )}}
1264 \end{twocollist}
1265 }}
1266
1267
1268 \wxheading{See also}
1269
1270 \helpref{GetScreenPosition}{wxwindowgetscreenposition}
1271
1272
1273 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
1274
1275 \constfunc{virtual wxRect}{GetRect}{\void}
1276
1277 Returns the position and size of the window as a \helpref{wxRect}{wxrect} object.
1278
1279 \wxheading{See also}
1280
1281 \helpref{GetScreenRect}{wxwindowgetscreenrect}
1282
1283
1284 \membersection{wxWindow::GetScreenPosition}\label{wxwindowgetscreenposition}
1285
1286 \constfunc{virtual void}{GetScreenPosition}{\param{int* }{x}, \param{int* }{y}}
1287
1288 \constfunc{wxPoint}{GetScreenPosition}{\void}
1289
1290 Returns the window position in screen coordinates, whether the window is a
1291 child window or a top level one.
1292
1293 \wxheading{Parameters}
1294
1295 \docparam{x}{Receives the x position of the window on the screen if non-\NULL.}
1296
1297 \docparam{y}{Receives the y position of the window on the screen if non-\NULL.}
1298
1299 \wxheading{See also}
1300
1301 \helpref{GetPosition}{wxwindowgetposition}
1302
1303
1304 \membersection{wxWindow::GetScreenRect}\label{wxwindowgetscreenrect}
1305
1306 \constfunc{virtual wxRect}{GetScreenRect}{\void}
1307
1308 Returns the position and size of the window on the screen as a
1309 \helpref{wxRect}{wxrect} object.
1310
1311 \wxheading{See also}
1312
1313 \helpref{GetRect}{wxwindowgetrect}
1314
1315
1316 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
1317
1318 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}
1319
1320 Returns the built-in scrollbar position.
1321
1322 \wxheading{See also}
1323
1324 See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
1325
1326
1327 \membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange}
1328
1329 \func{virtual int}{GetScrollRange}{\param{int }{orientation}}
1330
1331 Returns the built-in scrollbar range.
1332
1333 \wxheading{See also}
1334
1335 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
1336
1337
1338 \membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
1339
1340 \func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
1341
1342 Returns the built-in scrollbar thumb size.
1343
1344 \wxheading{See also}
1345
1346 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
1347
1348
1349 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
1350
1351 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
1352
1353 \constfunc{wxSize}{GetSize}{\void}
1354
1355 Returns the size of the entire window in pixels, including title bar, border,
1356 scrollbars, etc.
1357
1358 Note that if this window is a top-level one and it is currently minimized, the
1359 returned size is the restored window size, not the size of the window icon.
1360
1361 \wxheading{Parameters}
1362
1363 \docparam{width}{Receives the window width.}
1364
1365 \docparam{height}{Receives the window height.}
1366
1367 \pythonnote{In place of a single overloaded method name, wxPython
1368 implements the following methods:\par
1369 \indented{2cm}{\begin{twocollist}
1370 \twocolitem{{\bf GetSize()}}{Returns a wxSize}
1371 \twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
1372 \end{twocollist}}
1373 }
1374
1375 \perlnote{In wxPerl there are two methods instead of a single overloaded
1376 method:\par
1377 \indented{2cm}{\begin{twocollist}
1378 \twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
1379 \twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
1380 {\tt ( width, height )}}
1381 \end{twocollist}
1382 }}
1383
1384 \wxheading{See also}
1385
1386 \helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp
1387 \helpref{GetVirtualSize}{wxwindowgetvirtualsize}
1388
1389
1390 \membersection{wxWindow::GetSizer}\label{wxwindowgetsizer}
1391
1392 \constfunc{wxSizer *}{GetSizer}{\void}
1393
1394 Return the sizer associated with the window by a previous call to
1395 \helpref{SetSizer()}{wxwindowsetsizer} or {\tt NULL}.
1396
1397
1398 \membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent}
1399
1400 \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{w}, \param{int* }{h},
1401 \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
1402 \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt false}}}
1403
1404 \constfunc{wxSize}{GetTextExtent}{\param{const wxString\& }{string}}
1405
1406 Gets the dimensions of the string as it would be drawn on the
1407 window with the currently selected font.
1408
1409 The text extent is returned in \arg{w} and \arg{h} pointers (first form) or as a
1410 \helpref{wxSize}{wxsize} object (second form).
1411
1412 \wxheading{Parameters}
1413
1414 \docparam{string}{String whose extent is to be measured.}
1415
1416 \docparam{w}{Return value for width.}
1417
1418 \docparam{h}{Return value for height.}
1419
1420 \docparam{descent}{Return value for descent (optional).}
1421
1422 \docparam{externalLeading}{Return value for external leading (optional).}
1423
1424 \docparam{font}{Font to use instead of the current window font (optional).}
1425
1426 \docparam{use16}{If {\tt true}, {\it string} contains 16-bit characters. The default is {\tt false}.}
1427
1428 \pythonnote{In place of a single overloaded method name, wxPython
1429 implements the following methods:\par
1430 \indented{2cm}{\begin{twocollist}
1431 \twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
1432 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a
1433 4-tuple, (width, height, descent, externalLeading) }
1434 \end{twocollist}}
1435 }
1436
1437 \perlnote{In wxPerl this method takes only the {\tt string} and optionally
1438 {\tt font} parameters, and returns a 4-element list
1439 {\tt ( x, y, descent, externalLeading )}.}
1440
1441
1442 \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
1443
1444 \constfunc{wxToolTip*}{GetToolTip}{\void}
1445
1446 Get the associated tooltip or NULL if none.
1447
1448
1449 \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
1450
1451 \constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
1452
1453 Returns the region specifying which parts of the window have been damaged. Should
1454 only be called within an \helpref{wxPaintEvent}{wxpaintevent} handler.
1455
1456 \wxheading{See also}
1457
1458 \helpref{wxRegion}{wxregion},\rtfsp
1459 \helpref{wxRegionIterator}{wxregioniterator}
1460
1461
1462 \membersection{wxWindow::GetValidator}\label{wxwindowgetvalidator}
1463
1464 \constfunc{wxValidator*}{GetValidator}{\void}
1465
1466 Returns a pointer to the current validator for the window, or NULL if there is none.
1467
1468
1469 \membersection{wxWindow::GetVirtualSize}\label{wxwindowgetvirtualsize}
1470
1471 \constfunc{void}{GetVirtualSize}{\param{int* }{width}, \param{int* }{height}}
1472
1473 \constfunc{wxSize}{GetVirtualSize}{\void}
1474
1475 This gets the virtual size of the window in pixels. By default it
1476 returns the client size of the window, but after a call to
1477 \helpref{SetVirtualSize}{wxwindowsetvirtualsize} it will return
1478 that size.
1479
1480 \wxheading{Parameters}
1481
1482 \docparam{width}{Receives the window virtual width.}
1483
1484 \docparam{height}{Receives the window virtual height.}
1485
1486 \helpref{GetSize}{wxwindowgetsize},\rtfsp
1487 \helpref{GetClientSize}{wxwindowgetclientsize}
1488
1489
1490 \membersection{wxWindow::GetWindowBorderSize}\label{wxwindowgetwindowbordersize}
1491
1492 \constfunc{wxSize}{GetWindowBorderSize}{\void}
1493
1494 Returns the size of the left/right and top/bottom borders of this window in x
1495 and y components of the result respectively.
1496
1497
1498 \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
1499
1500 \constfunc{long}{GetWindowStyleFlag}{\void}
1501
1502 Gets the window style that was passed to the constructor or {\bf Create}
1503 method. {\bf GetWindowStyle()} is another name for the same function.
1504
1505
1506 \membersection{wxWindow::GetWindowVariant}\label{wxwindowgetwindowvariant}
1507
1508 \constfunc{wxWindowVariant}{GetWindowVariant}{\void}
1509
1510 Returns the value previously passed to
1511 \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
1512
1513
1514 \membersection{wxWindow::HasCapture}\label{wxwindowhascapture}
1515
1516 \constfunc{virtual bool}{HasCapture}{\void}
1517
1518 Returns {\tt true} if this window has the current mouse capture.
1519
1520 \wxheading{See also}
1521
1522 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
1523 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
1524 \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
1525 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
1526
1527
1528 \membersection{wxWindow::HasExtraStyle}\label{wxwindowhasextrastyle}
1529
1530 \constfunc{bool}{HasExtraStyle}{\param{int }{exFlag}}
1531
1532 Returns \texttt{true} if the window has the given \arg{exFlag} bit set in its
1533 extra styles.
1534
1535 \wxheading{See also}
1536
1537 \helpref{SetExtraStyle}{wxwindowsetextrastyle}
1538
1539
1540 \membersection{wxWindow::HasFlag}\label{wxwindowhasflag}
1541
1542 \constfunc{bool}{HasFlag}{\param{int }{flag}}
1543
1544 Returns \texttt{true} if the window has the given \arg{flag} bit set.
1545
1546
1547 \membersection{wxWindow::HasMultiplePages}\label{wxwindowhasmultiplepages}
1548
1549 \constfunc{virtual bool}{HasMultiplePages}{\void}
1550
1551 This method should be overridden to return \texttt{true} if this window has
1552 multiple pages. All standard class with multiple pages such as
1553 \helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook} and
1554 \helpref{wxTreebook}{wxtreebook} already override it to return \texttt{true}
1555 and user-defined classes with similar behaviour should do it as well to allow
1556 the library to handle such windows appropriately.
1557
1558
1559 \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
1560
1561 \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
1562
1563 Returns {\tt true} if this window has a scroll bar for this orientation.
1564
1565 \wxheading{Parameters}
1566
1567 \docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
1568
1569
1570 \membersection{wxWindow::HasTransparentBackground}\label{wxwindowhastransparentbackground}
1571
1572 \constfunc{virtual bool}{HasTransparentBackground}{\void}
1573
1574 Returns \true if this window background is transparent (as, for example, for
1575 wxStaticText) and should show the parent window background.
1576
1577 This method is mostly used internally by the library itself and you normally
1578 shouldn't have to call it. You may, however, have to override it in your
1579 wxWindow-derived class to ensure that background is painted correctly.
1580
1581
1582 \membersection{wxWindow::Hide}\label{wxwindowhide}
1583
1584 \func{bool}{Hide}{\void}
1585
1586 Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}).
1587
1588
1589 \membersection{wxWindow::InheritAttributes}\label{wxwindowinheritattributes}
1590
1591 \func{void}{InheritAttributes}{\void}
1592
1593 This function is (or should be, in case of custom controls) called during
1594 window creation to intelligently set up the window visual attributes, that is
1595 the font and the foreground and background colours.
1596
1597 By ``intelligently'' the following is meant: by default, all windows use their
1598 own \helpref{default}{wxwindowgetclassdefaultattributes} attributes. However
1599 if some of the parents attributes are explicitly (that is, using
1600 \helpref{SetFont}{wxwindowsetfont} and not
1601 \helpref{SetOwnFont}{wxwindowsetownfont}) changed \emph{and} if the
1602 corresponding attribute hadn't been explicitly set for this window itself,
1603 then this window takes the same value as used by the parent. In addition, if
1604 the window overrides \helpref{ShouldInheritColours}{wxwindowshouldinheritcolours}
1605 to return \false, the colours will not be changed no matter what and only the
1606 font might.
1607
1608 This rather complicated logic is necessary in order to accommodate the
1609 different usage scenarios. The most common one is when all default attributes
1610 are used and in this case, nothing should be inherited as in modern GUIs
1611 different controls use different fonts (and colours) than their siblings so
1612 they can't inherit the same value from the parent. However it was also deemed
1613 desirable to allow to simply change the attributes of all children at once by
1614 just changing the font or colour of their common parent, hence in this case we
1615 do inherit the parents attributes.
1616
1617
1618 \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
1619
1620 \func{void}{InitDialog}{\void}
1621
1622 Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data
1623 to the dialog via validators.
1624
1625
1626 \membersection{wxWindow::InvalidateBestSize}\label{wxwindowinvalidatebestsize}
1627
1628 \func{void}{InvalidateBestSize}{\void}
1629
1630 Resets the cached best size value so it will be recalculated the next time it is needed.
1631
1632
1633 \membersection{wxWindow::IsDoubleBuffered}\label{wxwindowisdoublebuffered}
1634
1635 \constfunc{virtual bool}{IsDoubleBuffered}{\void}
1636
1637 Returns \true if the window contents is double-buffered by the system, i.e. if
1638 any drawing done on the window is really done on a temporary backing surface
1639 and transferred to the screen all at once later.
1640
1641 \wxheading{See also}
1642
1643 \helpref{wxBufferedDC}{wxbuffereddc}
1644
1645
1646 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
1647
1648 \constfunc{virtual bool}{IsEnabled}{\void}
1649
1650 Returns \true if the window is enabled, i.e. if it accepts user input, \false
1651 otherwise.
1652
1653 Notice that this method can return \false even if this window itself hadn't
1654 been explicitly disabled when one of its parent windows is disabled. To get the
1655 intrinsic status of this window, use
1656 \helpref{IsThisEnabled}{wxwindowisthisenabled}
1657
1658 \wxheading{See also}
1659
1660 \helpref{wxWindow::Enable}{wxwindowenable}
1661
1662
1663 \membersection{wxWindow::IsExposed}\label{wxwindowisexposed}
1664
1665 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
1666
1667 \constfunc{bool}{IsExposed}{\param{wxPoint }{\&pt}}
1668
1669 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, \param{int }{w}, \param{int }{h}}
1670
1671 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
1672
1673 Returns {\tt true} if the given point or rectangle area has been exposed since the
1674 last repaint. Call this in an paint event handler to optimize redrawing by
1675 only redrawing those areas, which have been exposed.
1676
1677 \pythonnote{In place of a single overloaded method name, wxPython
1678 implements the following methods:\par
1679 \indented{2cm}{\begin{twocollist}
1680 \twocolitem{{\bf IsExposed(x,y, w=0,h=0)}}{}
1681 \twocolitem{{\bf IsExposedPoint(pt)}}{}
1682 \twocolitem{{\bf IsExposedRect(rect)}}{}
1683 \end{twocollist}}}
1684
1685
1686 \membersection{wxWindow::IsFrozen}\label{wxwindowisfrozen}
1687
1688 \constfunc{virtual bool}{IsFrozen}{\void}
1689
1690 Returns \true if the window is currently frozen by a call to
1691 \helpref{Freeze()}{wxwindowfreeze}.
1692
1693 \wxheading{See also}
1694
1695 \helpref{Thaw()}{wxwindowthaw}
1696
1697
1698 \membersection{wxWindow::IsRetained}\label{wxwindowisretained}
1699
1700 \constfunc{virtual bool}{IsRetained}{\void}
1701
1702 Returns {\tt true} if the window is retained, {\tt false} otherwise.
1703
1704 \wxheading{Remarks}
1705
1706 Retained windows are only available on X platforms.
1707
1708
1709 \membersection{wxWindow::IsScrollbarAlwaysShown}\label{wxwindowisscrollbaralwaysshown}
1710
1711 \func{bool}{IsScrollbarAlwaysShown}{\param{int}{ orient}}
1712
1713 Return whether a scrollbar is always shown.
1714
1715 \wxheading{Parameters}
1716
1717 \docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
1718
1719 \wxheading{See also}
1720
1721 \helpref{wxWindow::AlwaysShowScrollbars}{wxwindowalwaysshowscrollbars}
1722
1723
1724 \membersection{wxWindow::IsShown}\label{wxwindowisshown}
1725
1726 \constfunc{virtual bool}{IsShown}{\void}
1727
1728 Returns {\tt true} if the window is shown, {\tt false} if it has been hidden.
1729
1730 \wxheading{See also}
1731
1732 \helpref{wxWindow::IsShownOnScreen}{wxwindowisshownonscreen}
1733
1734
1735 \membersection{wxWindow::IsShownOnScreen}\label{wxwindowisshownonscreen}
1736
1737 \constfunc{virtual bool}{IsShownOnScreen}{\void}
1738
1739 Returns {\tt true} if the window is physically visible on the screen, i.e. it
1740 is shown and all its parents up to the toplevel window are shown as well.
1741
1742 \wxheading{See also}
1743
1744 \helpref{wxWindow::IsShown}{wxwindowisshown}
1745
1746
1747 \membersection{wxWindow::IsThisEnabled}\label{wxwindowisthisenabled}
1748
1749 \constfunc{bool}{IsThisEnabled}{\void}
1750
1751 Returns \true if this window is intrinsically enabled, \false otherwise, i.e.
1752 if \helpref{Enable(false)}{wxwindowenable} had been called. This method is
1753 mostly used for wxWidgets itself, user code should normally use
1754 \helpref{IsEnabled}{wxwindowisenabled} instead.
1755
1756
1757 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
1758
1759 \constfunc{bool}{IsTopLevel}{\void}
1760
1761 Returns {\tt true} if the given window is a top-level one. Currently all frames and
1762 dialogs are considered to be top-level windows (even if they have a parent
1763 window).
1764
1765
1766 \membersection{wxWindow::Layout}\label{wxwindowlayout}
1767
1768 \func{void}{Layout}{\void}
1769
1770 Invokes the constraint-based layout algorithm or the sizer-based algorithm
1771 for this window.
1772
1773 See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}: when auto
1774 layout is on, this function gets called automatically when the window is resized.
1775
1776
1777 \membersection{wxWindow::LineDown}\label{wxwindowlinedown}
1778
1779 This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(1)$.
1780
1781
1782 \membersection{wxWindow::LineUp}\label{wxwindowlineup}
1783
1784 This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$.
1785
1786
1787 \membersection{wxWindow::Lower}\label{wxwindowlower}
1788
1789 \func{void}{Lower}{\void}
1790
1791 Lowers the window to the bottom of the window hierarchy (z-order).
1792
1793 \wxheading{See also}
1794
1795 \helpref{Raise}{wxwindowraise}
1796
1797
1798 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}
1799
1800 \func{virtual void}{MakeModal}{\param{bool }{flag}}
1801
1802 Disables all other windows in the application so that
1803 the user can only interact with this window.
1804
1805 \wxheading{Parameters}
1806
1807 \docparam{flag}{If {\tt true}, this call disables all other windows in the application so that
1808 the user can only interact with this window. If {\tt false}, the effect is reversed.}
1809
1810
1811 \membersection{wxWindow::Move}\label{wxwindowmove}
1812
1813 \func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
1814
1815 \func{void}{Move}{\param{const wxPoint\&}{ pt}}
1816
1817 Moves the window to the given position.
1818
1819 \wxheading{Parameters}
1820
1821 \docparam{x}{Required x position.}
1822
1823 \docparam{y}{Required y position.}
1824
1825 \docparam{pt}{\helpref{wxPoint}{wxpoint} object representing the position.}
1826
1827 \wxheading{Remarks}
1828
1829 Implementations of SetSize can also implicitly implement the
1830 wxWindow::Move function, which is defined in the base wxWindow class
1831 as the call:
1832
1833 \begin{verbatim}
1834 SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
1835 \end{verbatim}
1836
1837 \wxheading{See also}
1838
1839 \helpref{wxWindow::SetSize}{wxwindowsetsize}
1840
1841 \pythonnote{In place of a single overloaded method name, wxPython
1842 implements the following methods:\par
1843 \indented{2cm}{\begin{twocollist}
1844 \twocolitem{{\bf Move(point)}}{Accepts a wxPoint}
1845 \twocolitem{{\bf MoveXY(x, y)}}{Accepts a pair of integers}
1846 \end{twocollist}}
1847 }
1848
1849
1850 \membersection{wxWindow::MoveAfterInTabOrder}\label{wxwindowmoveafterintaborder}
1851
1852 \func{void}{MoveAfterInTabOrder}{\param{wxWindow *}{win}}
1853
1854 Moves this window in the tab navigation order after the specified \arg{win}.
1855 This means that when the user presses \texttt{TAB} key on that other window,
1856 the focus switches to this window.
1857
1858 Default tab order is the same as creation order, this function and
1859 \helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change
1860 it after creating all the windows.
1861
1862 \wxheading{Parameters}
1863
1864 \docparam{win}{A sibling of this window which should precede it in tab order,
1865 must not be NULL}
1866
1867
1868 \membersection{wxWindow::MoveBeforeInTabOrder}\label{wxwindowmovebeforeintaborder}
1869
1870 \func{void}{MoveBeforeInTabOrder}{\param{wxWindow *}{win}}
1871
1872 Same as \helpref{MoveAfterInTabOrder}{wxwindowmoveafterintaborder} except that
1873 it inserts this window just before \arg{win} instead of putting it right after
1874 it.
1875
1876
1877 \membersection{wxWindow::Navigate}\label{wxwindownavigate}
1878
1879 \func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
1880
1881 Performs a keyboard navigation action starting from this window. This method is
1882 equivalent to calling \helpref{NavigateIn()}{wxwindownavigatein} method on the
1883 parent window.
1884
1885 \wxheading{Parameters}
1886
1887 \docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.}
1888
1889 \wxheading{Return value}
1890
1891 Returns \true if the focus was moved to another window or \false if nothing
1892 changed.
1893
1894 \wxheading{Remarks}
1895
1896 You may wish to call this from a text control custom keypress handler to do the default
1897 navigation behaviour for the tab key, since the standard default behaviour for
1898 a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab
1899 and not navigate to the next control. See also \helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}.
1900
1901
1902 \membersection{wxWindow::NavigateIn}\label{wxwindownavigatein}
1903
1904 \func{bool}{NavigateIn}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
1905
1906 Performs a keyboard navigation action inside this window.
1907
1908 See \helpref{Navigate}{wxwindownavigate} for more information.
1909
1910
1911 \membersection{wxWindow::NextControlId}\label{wxwindownextcontrolid}
1912
1913 \func{static int}{NextControlId}{\param{int }{winid}}
1914
1915 If two controls are created consecutively using \texttt{wxID\_ANY} id, this
1916 function allows to retrieve the effective id of the latter control from the id
1917 of the former. This is useful for example to find the control following its
1918 \helpref{wxStaticText}{wxstatictext} label if only the id of or pointer to the
1919 label is available to the caller but it is known that the two controls were
1920 created together.
1921
1922 \wxheading{See also}
1923
1924 \helpref{PrevControlId}{wxwindowprevcontrolid}
1925
1926
1927 %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving
1928 %% the old docs here in case we want to move any still needed bits to
1929 %% the right location (i.e. probably the corresponding events docs)
1930 %%
1931 %% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
1932 %%
1933 %% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
1934 %%
1935 %% Called when a window is activated or deactivated.
1936 %%
1937 %% \wxheading{Parameters}
1938 %%
1939 %% \docparam{event}{Object containing activation information.}
1940 %%
1941 %% \wxheading{Remarks}
1942 %%
1943 %% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt true},
1944 %% otherwise it returns {\tt false} (it is being deactivated).
1945 %%
1946 %% \wxheading{See also}
1947 %%
1948 %% \helpref{wxActivateEvent}{wxactivateevent},\rtfsp
1949 %% \helpref{Event handling overview}{eventhandlingoverview}
1950 %%
1951 %% \membersection{wxWindow::OnChar}\label{wxwindowonchar}
1952 %%
1953 %% \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
1954 %%
1955 %% Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
1956 %%
1957 %% \wxheading{Parameters}
1958 %%
1959 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1960 %% details about this class.}
1961 %%
1962 %% \wxheading{Remarks}
1963 %%
1964 %% This member function is called in response to a keypress. To intercept this event,
1965 %% use the EVT\_CHAR macro in an event table definition. Your {\bf OnChar} handler may call this
1966 %% default function to achieve default keypress functionality.
1967 %%
1968 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1969 %% values.
1970 %%
1971 %% Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1972 %% keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1973 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1974 %%
1975 %% Most, but not all, windows allow keypresses to be intercepted.
1976 %%
1977 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1978 %% otherwise menu shortcuts may cease to work under Windows.
1979 %%
1980 %% \wxheading{See also}
1981 %%
1982 %% \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1983 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1984 %% \helpref{Event handling overview}{eventhandlingoverview}
1985 %%
1986 %% \membersection{wxWindow::OnCharHook}\label{wxwindowoncharhook}
1987 %%
1988 %% \func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
1989 %%
1990 %% This member is called to allow the window to intercept keyboard events
1991 %% before they are processed by child windows.
1992 %%
1993 %% \wxheading{Parameters}
1994 %%
1995 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1996 %% details about this class.}
1997 %%
1998 %% \wxheading{Remarks}
1999 %%
2000 %% This member function is called in response to a keypress, if the window is active. To intercept this event,
2001 %% use the EVT\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
2002 %% keypress, call \helpref{wxEvent::Skip}{wxeventskip} to allow default processing.
2003 %%
2004 %% An example of using this function is in the implementation of escape-character processing for wxDialog,
2005 %% where pressing ESC dismisses the dialog by {\bf OnCharHook} 'forging' a cancel button press event.
2006 %%
2007 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
2008 %% values.
2009 %%
2010 %% This function is only relevant to top-level windows (frames and dialogs), and under
2011 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
2012 %% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
2013 %% the window won't get the event.
2014 %%
2015 %% \wxheading{See also}
2016 %%
2017 %% \helpref{wxKeyEvent}{wxkeyevent},\rtfsp
2018 %% \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
2019 %% %% GD: OnXXX functions are not documented
2020 %% %%\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp
2021 %% \helpref{Event handling overview}{eventhandlingoverview}
2022 %%
2023 %% \membersection{wxWindow::OnCommand}\label{wxwindowoncommand}
2024 %%
2025 %% \func{virtual void}{OnCommand}{\param{wxEvtHandler\& }{object}, \param{wxCommandEvent\& }{event}}
2026 %%
2027 %% This virtual member function is called if the control does not handle the command event.
2028 %%
2029 %% \wxheading{Parameters}
2030 %%
2031 %% \docparam{object}{Object receiving the command event.}
2032 %%
2033 %% \docparam{event}{Command event}
2034 %%
2035 %% \wxheading{Remarks}
2036 %%
2037 %% This virtual function is provided mainly for backward compatibility. You can also intercept commands
2038 %% from child controls by using an event table, with identifiers or identifier ranges to identify
2039 %% the control(s) in question.
2040 %%
2041 %% \wxheading{See also}
2042 %%
2043 %% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
2044 %% \helpref{Event handling overview}{eventhandlingoverview}
2045 %%
2046 %% \membersection{wxWindow::OnClose}\label{wxwindowonclose}
2047 %%
2048 %% \func{virtual bool}{OnClose}{\void}
2049 %%
2050 %% Called when the user has tried to close a a frame
2051 %% or dialog box using the window manager (X) or system menu (Windows).
2052 %%
2053 %% {\bf Note:} This is an obsolete function.
2054 %% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
2055 %% handler.
2056 %%
2057 %% \wxheading{Return value}
2058 %%
2059 %% If {\tt true} is returned by OnClose, the window will be deleted by the system, otherwise the
2060 %% attempt will be ignored. Do not delete the window from within this handler, although
2061 %% you may delete other windows.
2062 %%
2063 %% \wxheading{See also}
2064 %%
2065 %% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
2066 %% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
2067 %% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
2068 %% \helpref{wxCloseEvent}{wxcloseevent}
2069 %%
2070 %% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
2071 %%
2072 %% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
2073 %%
2074 %% Called when the user has pressed a key, before it is translated into an ASCII value using other
2075 %% modifier keys that might be pressed at the same time.
2076 %%
2077 %% \wxheading{Parameters}
2078 %%
2079 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
2080 %% details about this class.}
2081 %%
2082 %% \wxheading{Remarks}
2083 %%
2084 %% This member function is called in response to a key down event. To intercept this event,
2085 %% use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this
2086 %% default function to achieve default keypress functionality.
2087 %%
2088 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
2089 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
2090 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
2091 %%
2092 %% Most, but not all, windows allow keypresses to be intercepted.
2093 %%
2094 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
2095 %% otherwise menu shortcuts may cease to work under Windows.
2096 %%
2097 %% \wxheading{See also}
2098 %%
2099 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
2100 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
2101 %% \helpref{Event handling overview}{eventhandlingoverview}
2102 %%
2103 %% \membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup}
2104 %%
2105 %% \func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}}
2106 %%
2107 %% Called when the user has released a key.
2108 %%
2109 %% \wxheading{Parameters}
2110 %%
2111 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
2112 %% details about this class.}
2113 %%
2114 %% \wxheading{Remarks}
2115 %%
2116 %% This member function is called in response to a key up event. To intercept this event,
2117 %% use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this
2118 %% default function to achieve default keypress functionality.
2119 %%
2120 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
2121 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
2122 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
2123 %%
2124 %% Most, but not all, windows allow key up events to be intercepted.
2125 %%
2126 %% \wxheading{See also}
2127 %%
2128 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp
2129 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
2130 %% \helpref{Event handling overview}{eventhandlingoverview}
2131 %%
2132 %% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
2133 %%
2134 %% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
2135 %%
2136 %% Default handler for the wxEVT\_INIT\_DIALOG event. Calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
2137 %%
2138 %% \wxheading{Parameters}
2139 %%
2140 %% \docparam{event}{Dialog initialisation event.}
2141 %%
2142 %% \wxheading{Remarks}
2143 %%
2144 %% Gives the window the default behaviour of transferring data to child controls via
2145 %% the validator that each control has.
2146 %%
2147 %% \wxheading{See also}
2148 %%
2149 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
2150 %%
2151 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
2152 %%
2153 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
2154 %%
2155 %% Called when a menu select is received from a menu bar: that is, the
2156 %% mouse cursor is over a menu item, but the left mouse button has not been
2157 %% pressed.
2158 %%
2159 %% \wxheading{Parameters}
2160 %%
2161 %% \docparam{event}{The menu highlight event. For more information, see \helpref{wxMenuEvent}{wxmenuevent}.}
2162 %%
2163 %% \wxheading{Remarks}
2164 %%
2165 %% You can choose any member function to receive
2166 %% menu select events, using the EVT\_MENU\_HIGHLIGHT macro for individual menu items or EVT\_MENU\_HIGHLIGHT\_ALL macro
2167 %% for all menu items.
2168 %%
2169 %% The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
2170 %% text in the first field of the status bar.
2171 %%
2172 %% This function was known as {\bf OnMenuSelect} in earlier versions of wxWidgets, but this was confusing
2173 %% since a selection is normally a left-click action.
2174 %%
2175 %% \wxheading{See also}
2176 %%
2177 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
2178 %% \helpref{Event handling overview}{eventhandlingoverview}
2179 %%
2180 %%
2181 %% \membersection{wxWindow::OnMouseEvent}\label{wxwindowonmouseevent}
2182 %%
2183 %% \func{void}{OnMouseEvent}{\param{wxMouseEvent\&}{ event}}
2184 %%
2185 %% Called when the user has initiated an event with the
2186 %% mouse.
2187 %%
2188 %% \wxheading{Parameters}
2189 %%
2190 %% \docparam{event}{The mouse event. See \helpref{wxMouseEvent}{wxmouseevent} for
2191 %% more details.}
2192 %%
2193 %% \wxheading{Remarks}
2194 %%
2195 %% Most, but not all, windows respond to this event.
2196 %%
2197 %% To intercept this event, use the EVT\_MOUSE\_EVENTS macro in an event table definition, or individual
2198 %% mouse event macros such as EVT\_LEFT\_DOWN.
2199 %%
2200 %% \wxheading{See also}
2201 %%
2202 %% \helpref{wxMouseEvent}{wxmouseevent},\rtfsp
2203 %% \helpref{Event handling overview}{eventhandlingoverview}
2204 %%
2205 %% \membersection{wxWindow::OnMove}\label{wxwindowonmove}
2206 %%
2207 %% \func{void}{OnMove}{\param{wxMoveEvent\& }{event}}
2208 %%
2209 %% Called when a window is moved.
2210 %%
2211 %% \wxheading{Parameters}
2212 %%
2213 %% \docparam{event}{The move event. For more information, see \helpref{wxMoveEvent}{wxmoveevent}.}
2214 %%
2215 %% \wxheading{Remarks}
2216 %%
2217 %% Use the EVT\_MOVE macro to intercept move events.
2218 %%
2219 %% \wxheading{Remarks}
2220 %%
2221 %% Not currently implemented.
2222 %%
2223 %% \wxheading{See also}
2224 %%
2225 %% \helpref{wxMoveEvent}{wxmoveevent},\rtfsp
2226 %% \helpref{wxFrame::OnSize}{wxframeonsize},\rtfsp
2227 %% \helpref{Event handling overview}{eventhandlingoverview}
2228 %%
2229 %% \membersection{wxWindow::OnPaint}\label{wxwindowonpaint}
2230 %%
2231 %% \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
2232 %%
2233 %% Sent to the event handler when the window must be refreshed.
2234 %%
2235 %% \wxheading{Parameters}
2236 %%
2237 %% \docparam{event}{Paint event. For more information, see \helpref{wxPaintEvent}{wxpaintevent}.}
2238 %%
2239 %% \wxheading{Remarks}
2240 %%
2241 %% Use the EVT\_PAINT macro in an event table definition to intercept paint events.
2242 %%
2243 %% Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
2244 %% even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
2245 %%
2246 %% For example:
2247 %%
2248 %% \small{%
2249 %% \begin{verbatim}
2250 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2251 %% {
2252 %% wxPaintDC dc(this);
2253 %%
2254 %% DrawMyDocument(dc);
2255 %% }
2256 %% \end{verbatim}
2257 %% }%
2258 %%
2259 %% You can optimize painting by retrieving the rectangles
2260 %% that have been damaged and only repainting these. The rectangles are in
2261 %% terms of the client area, and are unscrolled, so you will need to do
2262 %% some calculations using the current view position to obtain logical,
2263 %% scrolled units.
2264 %%
2265 %% Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
2266 %%
2267 %% {\small%
2268 %% \begin{verbatim}
2269 %% // Called when window needs to be repainted.
2270 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2271 %% {
2272 %% wxPaintDC dc(this);
2273 %%
2274 %% // Find Out where the window is scrolled to
2275 %% int vbX,vbY; // Top left corner of client
2276 %% GetViewStart(&vbX,&vbY);
2277 %%
2278 %% int vX,vY,vW,vH; // Dimensions of client area in pixels
2279 %% wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
2280 %%
2281 %% while (upd)
2282 %% {
2283 %% vX = upd.GetX();
2284 %% vY = upd.GetY();
2285 %% vW = upd.GetW();
2286 %% vH = upd.GetH();
2287 %%
2288 %% // Alternatively we can do this:
2289 %% // wxRect rect;
2290 %% // upd.GetRect(&rect);
2291 %%
2292 %% // Repaint this rectangle
2293 %% ...some code...
2294 %%
2295 %% upd ++ ;
2296 %% }
2297 %% }
2298 %% \end{verbatim}
2299 %% }%
2300 %%
2301 %% \wxheading{See also}
2302 %%
2303 %% \helpref{wxPaintEvent}{wxpaintevent},\rtfsp
2304 %% \helpref{wxPaintDC}{wxpaintdc},\rtfsp
2305 %% \helpref{Event handling overview}{eventhandlingoverview}
2306 %%
2307 %% \membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
2308 %%
2309 %% \func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
2310 %%
2311 %% Called when a scroll window event is received from one of the window's built-in scrollbars.
2312 %%
2313 %% \wxheading{Parameters}
2314 %%
2315 %% \docparam{event}{Command event. Retrieve the new scroll position by
2316 %% calling \helpref{wxScrollEvent::GetPosition}{wxscrolleventgetposition}, and the
2317 %% scrollbar orientation by calling \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}.}
2318 %%
2319 %% \wxheading{Remarks}
2320 %%
2321 %% Note that it is not possible to distinguish between horizontal and vertical scrollbars
2322 %% until the function is executing (you can't have one function for vertical, another
2323 %% for horizontal events).
2324 %%
2325 %% \wxheading{See also}
2326 %%
2327 %% \helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp
2328 %% \helpref{Event handling overview}{eventhandlingoverview}
2329 %%
2330 %% \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus}
2331 %%
2332 %% \func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
2333 %%
2334 %% Called when a window's focus is being set.
2335 %%
2336 %% \wxheading{Parameters}
2337 %%
2338 %% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
2339 %%
2340 %% \wxheading{Remarks}
2341 %%
2342 %% To intercept this event, use the macro EVT\_SET\_FOCUS in an event table definition.
2343 %%
2344 %% Most, but not all, windows respond to this event.
2345 %%
2346 %% \wxheading{See also}
2347 %%
2348 %% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
2349 %% \helpref{Event handling overview}{eventhandlingoverview}
2350 %%
2351 %% \membersection{wxWindow::OnSize}\label{wxwindowonsize}
2352 %%
2353 %% \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
2354 %%
2355 %% Called when the window has been resized. This is not a virtual function; you should
2356 %% provide your own non-virtual OnSize function and direct size events to it using EVT\_SIZE
2357 %% in an event table definition.
2358 %%
2359 %% \wxheading{Parameters}
2360 %%
2361 %% \docparam{event}{Size event. For more information, see \helpref{wxSizeEvent}{wxsizeevent}.}
2362 %%
2363 %% \wxheading{Remarks}
2364 %%
2365 %% You may wish to use this for frames to resize their child windows as appropriate.
2366 %%
2367 %% Note that the size passed is of
2368 %% the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
2369 %% used by the application.
2370 %%
2371 %% When a window is resized, usually only a small part of the window is damaged and you
2372 %% may only need to repaint that area. However, if your drawing depends on the size of the window,
2373 %% you may need to clear the DC explicitly and repaint the whole window. In which case, you
2374 %% may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
2375 %%
2376 %% \wxheading{See also}
2377 %%
2378 %% \helpref{wxSizeEvent}{wxsizeevent},\rtfsp
2379 %% \helpref{Event handling overview}{eventhandlingoverview}
2380 %%
2381 %% \membersection{wxWindow::OnSysColourChanged}\label{wxwindowonsyscolourchanged}
2382 %%
2383 %% \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}}
2384 %%
2385 %% Called when the user has changed the system colours. Windows only.
2386 %%
2387 %% \wxheading{Parameters}
2388 %%
2389 %% \docparam{event}{System colour change event. For more information, see \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}.}
2390 %%
2391 %% \wxheading{See also}
2392 %%
2393 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
2394 %% \helpref{Event handling overview}{eventhandlingoverview}
2395
2396
2397 \membersection{wxWindow::OnInternalIdle}\label{wxwindowoninternalidle}
2398
2399 \func{virtual void}{OnInternalIdle}{\void}
2400
2401 This virtual function is normally only used internally, but
2402 sometimes an application may need it to implement functionality
2403 that should not be disabled by an application defining an OnIdle
2404 handler in a derived class.
2405
2406 This function may be used to do delayed painting, for example,
2407 and most implementations call \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui}
2408 in order to send update events to the window in idle time.
2409
2410
2411 \membersection{wxWindow::PageDown}\label{wxwindowpagedown}
2412
2413 This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(1)$.
2414
2415
2416 \membersection{wxWindow::PageUp}\label{wxwindowpageup}
2417
2418 This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(-1)$.
2419
2420
2421 \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
2422
2423 \constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt false}}}
2424
2425 Removes and returns the top-most event handler on the event handler stack.
2426
2427 \wxheading{Parameters}
2428
2429 \docparam{deleteHandler}{If this is {\tt true}, the handler will be deleted after it is removed. The
2430 default value is {\tt false}.}
2431
2432 \wxheading{See also}
2433
2434 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
2435 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
2436 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
2437 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
2438 \helpref{wxEvtHandler}{wxevthandler}\rtfsp
2439
2440
2441 \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
2442
2443 \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
2444
2445 \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
2446
2447 Pops up the given menu at the specified coordinates, relative to this
2448 window, and returns control when the user has dismissed the menu. If a
2449 menu item is selected, the corresponding menu event is generated and will be
2450 processed as usually. If the coordinates are not specified, current mouse
2451 cursor position is used.
2452
2453 \wxheading{Parameters}
2454
2455 \docparam{menu}{Menu to pop up.}
2456
2457 \docparam{pos}{The position where the menu will appear.}
2458
2459 \docparam{x}{Required x position for the menu to appear.}
2460
2461 \docparam{y}{Required y position for the menu to appear.}
2462
2463 \wxheading{See also}
2464
2465 \helpref{wxMenu}{wxmenu}
2466
2467 \wxheading{Remarks}
2468
2469 Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui}
2470 is called to ensure that the menu items are in the correct state. The menu does
2471 not get deleted by the window.
2472
2473 It is recommended to not explicitly specify coordinates when calling PopupMenu
2474 in response to mouse click, because some of the ports (namely, wxGTK) can do
2475 a better job of positioning the menu in that case.
2476
2477 \pythonnote{In place of a single overloaded method name, wxPython
2478 implements the following methods:\par
2479 \indented{2cm}{\begin{twocollist}
2480 \twocolitem{{\bf PopupMenu(menu, point)}}{Specifies position with a wxPoint}
2481 \twocolitem{{\bf PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)}
2482 \end{twocollist}}
2483 }
2484
2485
2486 \membersection{wxWindow::PrevControlId}\label{wxwindowprevcontrolid}
2487
2488 \func{static int}{PrevControlId}{\param{int }{winid}}
2489
2490 This is similar to \helpref{NextControlId}{wxwindownextcontrolid} but returns
2491 the id of the control created just before the one with the given \arg{winid}.
2492
2493
2494 \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler}
2495
2496 \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}
2497
2498 Pushes this event handler onto the event stack for the window.
2499
2500 \wxheading{Parameters}
2501
2502 \docparam{handler}{Specifies the handler to be pushed.}
2503
2504 \wxheading{Remarks}
2505
2506 An event handler is an object that is capable of processing the events
2507 sent to a window. By default, the window is its own event handler, but
2508 an application may wish to substitute another, for example to allow
2509 central implementation of event-handling for a variety of different
2510 window classes.
2511
2512 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} allows
2513 an application to set up a chain of event handlers, where an event not handled by one event handler is
2514 handed to the next one in the chain. Use \helpref{wxWindow::PopEventHandler}{wxwindowpopeventhandler} to
2515 remove the event handler.
2516
2517 \wxheading{See also}
2518
2519 \helpref{wxWindow::SetEventHandler}{wxwindowseteventhandler},\rtfsp
2520 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
2521 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
2522 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
2523 \helpref{wxEvtHandler}{wxevthandler}
2524
2525
2526 \membersection{wxWindow::Raise}\label{wxwindowraise}
2527
2528 \func{void}{Raise}{\void}
2529
2530 Raises the window to the top of the window hierarchy (z-order).
2531
2532 In current version of wxWidgets this works both for managed and child windows.
2533
2534 \wxheading{See also}
2535
2536 \helpref{Lower}{wxwindowlower}
2537
2538
2539 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
2540
2541 \func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}}
2542
2543 Causes this window, and all of its children recursively (except under wxGTK1
2544 where this is not implemented), to be repainted. Note that repainting doesn't
2545 happen immediately but only during the next event loop iteration, if you need
2546 to update the window immediately you should use \helpref{Update}{wxwindowupdate}
2547 instead.
2548
2549 \wxheading{Parameters}
2550
2551 \docparam{eraseBackground}{If {\tt true}, the background will be
2552 erased.}
2553
2554 \docparam{rect}{If non-NULL, only the given rectangle will
2555 be treated as damaged.}
2556
2557 \wxheading{See also}
2558
2559 \helpref{wxWindow::RefreshRect}{wxwindowrefreshrect}
2560
2561
2562 \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
2563
2564 \func{void}{RefreshRect}{\param{const wxRect\& }{rect}, \param{bool }{eraseBackground = \true}}
2565
2566 Redraws the contents of the given rectangle: only the area inside it will be
2567 repainted.
2568
2569 This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax
2570 as it can be called with a temporary wxRect object as argument like this
2571 \texttt{RefreshRect(wxRect(x, y, w, h))}.
2572
2573
2574 \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey}
2575
2576 \func{bool}{RegisterHotKey}{\param{int}{ hotkeyId}, \param{int}{ modifiers}, \param{int}{ virtualKeyCode}}
2577
2578 Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window
2579 will receive a hotkey event. It will receive the event even if the application is in the background
2580 and does not have the input focus because the user is working with some other application.
2581
2582 \wxheading{Parameters}
2583
2584 \docparam{hotkeyId}{Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If
2585 this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF.
2586 This is a MSW specific detail.}
2587
2588 \docparam{modifiers}{A bitwise combination of {\tt wxMOD\_SHIFT}, {\tt wxMOD\_CONTROL}, {\tt wxMOD\_ALT}
2589 or {\tt wxMOD\_WIN} specifying the modifier keys that have to be pressed along with the key.}
2590
2591 \docparam{virtualKeyCode}{The virtual key code of the hotkey.}
2592
2593 \wxheading{Return value}
2594
2595 {\tt true} if the hotkey was registered successfully. {\tt false} if some other application already registered a
2596 hotkey with this modifier/virtualKeyCode combination.
2597
2598 \wxheading{Remarks}
2599
2600 Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
2601 This function is currently only implemented under Windows. It is used
2602 in the \helpref{Windows CE port}{wxwince} for detecting hardware button presses.
2603
2604 \wxheading{See also}
2605
2606 \helpref{wxWindow::UnregisterHotKey}{wxwindowunregisterhotkey}
2607
2608
2609 \membersection{wxWindow::ReleaseMouse}\label{wxwindowreleasemouse}
2610
2611 \func{virtual void}{ReleaseMouse}{\void}
2612
2613 Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}.
2614
2615 \wxheading{See also}
2616
2617 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
2618 \helpref{wxWindow::HasCapture}{wxwindowhascapture},
2619 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
2620 \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
2621 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
2622
2623
2624 \membersection{wxWindow::RemoveChild}\label{wxwindowremovechild}
2625
2626 \func{virtual void}{RemoveChild}{\param{wxWindow* }{child}}
2627
2628 Removes a child window. This is called automatically by window deletion
2629 functions so should not be required by the application programmer.
2630
2631 Notice that this function is mostly internal to wxWidgets and shouldn't be
2632 called by the user code.
2633
2634 \wxheading{Parameters}
2635
2636 \docparam{child}{Child window to remove.}
2637
2638
2639 \membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler}
2640
2641 \func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}
2642
2643 Find the given {\it handler} in the windows event handler chain and remove (but
2644 not delete) it from it.
2645
2646 \wxheading{Parameters}
2647
2648 \docparam{handler}{The event handler to remove, must be non-{\tt NULL} and
2649 must be present in this windows event handlers chain}
2650
2651 \wxheading{Return value}
2652
2653 Returns {\tt true} if it was found and {\tt false} otherwise (this also results
2654 in an assert failure so this function should only be called when the
2655 handler is supposed to be there).
2656
2657 \wxheading{See also}
2658
2659 \helpref{PushEventHandler}{wxwindowpusheventhandler},\rtfsp
2660 \helpref{PopEventHandler}{wxwindowpopeventhandler}
2661
2662
2663 \membersection{wxWindow::Reparent}\label{wxwindowreparent}
2664
2665 \func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}}
2666
2667 Reparents the window, i.e the window will be removed from its
2668 current parent window (e.g. a non-standard toolbar in a wxFrame)
2669 and then re-inserted into another.
2670
2671 \wxheading{Parameters}
2672
2673 \docparam{newParent}{New parent.}
2674
2675
2676 \membersection{wxWindow::ScreenToClient}\label{wxwindowscreentoclient}
2677
2678 \constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* }{y}}
2679
2680 \constfunc{virtual wxPoint}{ScreenToClient}{\param{const wxPoint\& }{pt}}
2681
2682 Converts from screen to client window coordinates.
2683
2684 \wxheading{Parameters}
2685
2686 \docparam{x}{Stores the screen x coordinate and receives the client x coordinate.}
2687
2688 \docparam{y}{Stores the screen x coordinate and receives the client x coordinate.}
2689
2690 \docparam{pt}{The screen position for the second form of the function.}
2691
2692 \pythonnote{In place of a single overloaded method name, wxPython
2693 implements the following methods:\par
2694 \indented{2cm}{\begin{twocollist}
2695 \twocolitem{{\bf ScreenToClient(point)}}{Accepts and returns a wxPoint}
2696 \twocolitem{{\bf ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)}
2697 \end{twocollist}}
2698 }
2699
2700
2701 \membersection{wxWindow::ScrollLines}\label{wxwindowscrolllines}
2702
2703 \func{virtual bool}{ScrollLines}{\param{int }{lines}}
2704
2705 Scrolls the window by the given number of lines down (if {\it lines} is
2706 positive) or up.
2707
2708 \wxheading{Return value}
2709
2710 Returns {\tt true} if the window was scrolled, {\tt false} if it was already
2711 on top/bottom and nothing was done.
2712
2713 \wxheading{Remarks}
2714
2715 This function is currently only implemented under MSW and wxTextCtrl under
2716 wxGTK (it also works for wxScrolledWindow derived classes under all
2717 platforms).
2718
2719 \wxheading{See also}
2720
2721 \helpref{ScrollPages}{wxwindowscrollpages}
2722
2723
2724 \membersection{wxWindow::ScrollPages}\label{wxwindowscrollpages}
2725
2726 \func{virtual bool}{ScrollPages}{\param{int }{pages}}
2727
2728 Scrolls the window by the given number of pages down (if {\it pages} is
2729 positive) or up.
2730
2731 \wxheading{Return value}
2732
2733 Returns {\tt true} if the window was scrolled, {\tt false} if it was already
2734 on top/bottom and nothing was done.
2735
2736 \wxheading{Remarks}
2737
2738 This function is currently only implemented under MSW and wxGTK.
2739
2740 \wxheading{See also}
2741
2742 \helpref{ScrollLines}{wxwindowscrolllines}
2743
2744
2745 \membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
2746
2747 \func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
2748
2749 Physically scrolls the pixels in the window and move child windows accordingly.
2750
2751 \wxheading{Parameters}
2752
2753 \docparam{dx}{Amount to scroll horizontally.}
2754
2755 \docparam{dy}{Amount to scroll vertically.}
2756
2757 \docparam{rect}{Rectangle to scroll, if it is \NULL, the whole window is
2758 scrolled (this is always the case under wxGTK which doesn't support this
2759 parameter)}
2760
2761 \wxheading{Remarks}
2762
2763 Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow}
2764 instead of using this function directly.
2765
2766
2767 \membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable}
2768
2769 \func{virtual void}{SetAcceleratorTable}{\param{const wxAcceleratorTable\&}{ accel}}
2770
2771 Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}.
2772
2773
2774 \membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible}
2775
2776 \func{void}{SetAccessible}{\param{wxAccessible*}{ accessible}}
2777
2778 Sets the accessible for this window. Any existing accessible for this window
2779 will be deleted first, if not identical to {\it accessible}.
2780
2781 See also \helpref{wxAccessible}{wxaccessible}.
2782
2783
2784 \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout}
2785
2786 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
2787
2788 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
2789 be called automatically when the window is resized. Please note that this only
2790 happens for the windows usually used to contain children, namely
2791 \helpref{wxPanel}{wxpanel} and \helpref{wxTopLevelWindow}{wxtoplevelwindow}
2792 (and the classes deriving from them).
2793
2794 This method is called implicitly by
2795 \helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use
2796 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
2797 manually or otherwise the window layout won't be correctly updated when its
2798 size changes.
2799
2800 \wxheading{Parameters}
2801
2802 \docparam{autoLayout}{Set this to \true if you wish the Layout function to be
2803 called automatically when the window is resized.}
2804
2805 \wxheading{See also}
2806
2807 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
2808
2809
2810 \membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour}
2811
2812 \func{virtual bool}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
2813
2814 Sets the background colour of the window.
2815
2816 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
2817 explanation of the difference between this method and
2818 \helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}.
2819
2820 \wxheading{Parameters}
2821
2822 \docparam{colour}{The colour to be used as the background colour, pass
2823 {\tt wxNullColour} to reset to the default colour.}
2824
2825 \wxheading{Remarks}
2826
2827 The background colour is usually painted by the default\rtfsp
2828 \helpref{wxEraseEvent}{wxeraseevent} event handler function
2829 under Windows and automatically under GTK.
2830
2831 Note that setting the background colour does not cause an immediate refresh, so you
2832 may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
2833 calling this function.
2834
2835 Using this function will disable attempts to use themes for this
2836 window, if the system supports them. Use with care since usually the
2837 themes represent the appearance chosen by the user to be used for all
2838 applications on the system.
2839
2840
2841 \wxheading{See also}
2842
2843 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp
2844 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
2845 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
2846 \helpref{wxWindow::ClearBackground}{wxwindowclearbackground},\rtfsp
2847 \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
2848 \helpref{wxEraseEvent}{wxeraseevent}
2849
2850 \membersection{wxWindow::SetBackgroundStyle}\label{wxwindowsetbackgroundstyle}
2851
2852 \func{virtual void}{SetBackgroundStyle}{\param{wxBackgroundStyle}{ style}}
2853
2854 Sets the background style of the window. see
2855 \helpref{GetBackgroundStyle()}{wxwindowgetbackgroundstyle} for the description
2856 of the possible style values.
2857
2858 \wxheading{See also}
2859
2860 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
2861 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
2862 \helpref{wxWindow::SetTransparent}{wxwindowsettransparent}
2863
2864
2865
2866 \membersection{wxWindow::SetCanFocus}\label{wxwindowsetcanfocus}
2867
2868 \func{virtual void}{SetCanFocus}{\param{bool}{ canFocus}}
2869
2870 This method is only implemented by ports which have support for
2871 native TAB traversal (such as GTK+ 2.0). It is called by wxWidgets'
2872 container control code to give the native system a hint when
2873 doing TAB traversal. A call to this does not disable or change
2874 the effect of programmatically calling
2875 \helpref{wxWindow::SetFocus}{wxwindowsetfocus}.
2876
2877 \wxheading{See also}
2878
2879 \helpref{wxFocusEvent}{wxfocusevent}
2880 \helpref{wxPanel::SetFocus}{wxpanelsetfocus}
2881 \helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}
2882
2883
2884 \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
2885
2886 \constfunc{void}{SetCaret}{\param{wxCaret *}{caret}}
2887
2888 Sets the \helpref{caret}{wxcaret} associated with the window.
2889
2890
2891 \membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize}
2892
2893 \func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}}
2894
2895 \func{virtual void}{SetClientSize}{\param{const wxSize\&}{ size}}
2896
2897 This sets the size of the window client area in pixels. Using this function to size a window
2898 tends to be more device-independent than \helpref{wxWindow::SetSize}{wxwindowsetsize}, since the application need not
2899 worry about what dimensions the border or title bar have when trying to fit the window
2900 around panel items, for example.
2901
2902 \wxheading{Parameters}
2903
2904 \docparam{width}{The required client area width.}
2905
2906 \docparam{height}{The required client area height.}
2907
2908 \docparam{size}{The required client size.}
2909
2910 \pythonnote{In place of a single overloaded method name, wxPython
2911 implements the following methods:\par
2912 \indented{2cm}{\begin{twocollist}
2913 \twocolitem{{\bf SetClientSize(size)}}{Accepts a wxSize}
2914 \twocolitem{{\bf SetClientSizeWH(width, height)}}{}
2915 \end{twocollist}}
2916 }
2917
2918
2919 \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
2920
2921 \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}
2922
2923 Sets the window to have the given layout constraints. The window
2924 will then own the object, and will take care of its deletion.
2925 If an existing layout constraints object is already owned by the
2926 window, it will be deleted.
2927
2928 \wxheading{Parameters}
2929
2930 \docparam{constraints}{The constraints to set. Pass NULL to disassociate and delete the window's
2931 constraints.}
2932
2933 \wxheading{Remarks}
2934
2935 You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use
2936 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
2937 explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
2938 sizer will have effect.
2939
2940 \membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer}
2941
2942 \func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}}
2943
2944 This normally does not need to be called by user code. It is called
2945 when a window is added to a sizer, and is used so the window can
2946 remove itself from the sizer when it is destroyed.
2947
2948
2949 \membersection{wxWindow::SetCursor}\label{wxwindowsetcursor}
2950
2951 \func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
2952
2953 % VZ: the docs are correct, if the code doesn't behave like this, it must be
2954 % changed
2955 Sets the window's cursor. Notice that the window cursor also sets it for the
2956 children of the window implicitly.
2957
2958 The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will
2959 be reset back to default.
2960
2961 \wxheading{Parameters}
2962
2963 \docparam{cursor}{Specifies the cursor that the window should normally display.}
2964
2965 \wxheading{See also}
2966
2967 \helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor}
2968
2969
2970 \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget}
2971
2972 \func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}}
2973
2974 Associates a drop target with this window.
2975
2976 If the window already has a drop target, it is deleted.
2977
2978 \wxheading{See also}
2979
2980 \helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
2981 \helpref{Drag and drop overview}{wxdndoverview}
2982
2983
2984
2985 \membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler}
2986
2987 \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
2988
2989 Sets the event handler for this window.
2990
2991 \wxheading{Parameters}
2992
2993 \docparam{handler}{Specifies the handler to be set.}
2994
2995 \wxheading{Remarks}
2996
2997 An event handler is an object that is capable of processing the events
2998 sent to a window. By default, the window is its own event handler, but
2999 an application may wish to substitute another, for example to allow
3000 central implementation of event-handling for a variety of different
3001 window classes.
3002
3003 It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler}
3004 since this sets up a chain of event handlers, where an event not handled by
3005 one event handler is handed to the next one in the chain.
3006
3007 \wxheading{See also}
3008
3009 \helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
3010 \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
3011 \helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
3012 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
3013 \helpref{wxEvtHandler}{wxevthandler}
3014
3015
3016 \membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle}
3017
3018 \func{void}{SetExtraStyle}{\param{long }{exStyle}}
3019
3020 Sets the extra style bits for the window. The currently defined extra style
3021 bits are:
3022
3023 \twocolwidtha{5cm}%
3024 \begin{twocollist}\itemsep=0pt
3025 \twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
3026 and Validate() methods will recursively descend into all children of the
3027 window if it has this style flag set.}
3028 \twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{Normally, the command
3029 events are propagated upwards to the window parent recursively until a handler
3030 for them is found. Using this style allows to prevent them from being
3031 propagated beyond this window. Notice that wxDialog has this style on by
3032 default for the reasons explained in the
3033 \helpref{event processing overview}{eventprocessing}.}
3034 \twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{This can be used to prevent a
3035 window from being used as an implicit parent for the dialogs which were
3036 created without a parent. It is useful for the windows which can disappear at
3037 any moment as creating children of such windows results in fatal problems.}
3038 \twocolitem{\windowstyle{wxWS\_EX\_CONTEXTHELP}}{Under Windows, puts a query
3039 button on the caption. When pressed, Windows will go into a context-sensitive
3040 help mode and wxWidgets will send a wxEVT\_HELP event if the user clicked on an
3041 application window.
3042 This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
3043 these two styles are automatically turned of if this one is used.}
3044 \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
3045 if the mode set by \helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} is wxIDLE\_PROCESS\_SPECIFIED.}
3046 \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
3047 even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} is wxUPDATE\_UI\_PROCESS\_SPECIFIED.}
3048 \end{twocollist}
3049
3050
3051 \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
3052
3053 \func{virtual void}{SetFocus}{\void}
3054
3055 This sets the window to receive keyboard input.
3056
3057 \wxheading{See also}
3058
3059 \helpref{wxFocusEvent}{wxfocusevent}
3060 \helpref{wxPanel::SetFocus}{wxpanelsetfocus}
3061 \helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}
3062
3063
3064 \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
3065
3066 \func{virtual void}{SetFocusFromKbd}{\void}
3067
3068 This function is called by wxWidgets keyboard navigation code when the user
3069 gives the focus to this window from keyboard (e.g. using {\tt TAB} key).
3070 By default this method simply calls \helpref{SetFocus}{wxwindowsetfocus} but
3071 can be overridden to do something in addition to this in the derived classes.
3072
3073
3074 \membersection{wxWindow::SetFont}\label{wxwindowsetfont}
3075
3076 \func{bool}{SetFont}{\param{const wxFont\& }{font}}
3077
3078 Sets the font for this window. This function should not be called for the
3079 parent window if you don't want its font to be inherited by its children,
3080 use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and
3081 see \helpref{InheritAttributes}{wxwindowinheritattributes} for more
3082 explanations.
3083
3084 Please notice that the given font is \emph{not} automatically used for
3085 \helpref{wxPaintDC}{wxpaintdc} objects associated with this window, you need to
3086 call \helpref{wxDC::SetFont()}{wxdcsetfont} too. However this font is used by
3087 any standard controls for drawing their text as well as by
3088 \helpref{wxWindow::GetTextExtent()}{wxwindowgettextextent}.
3089
3090 \wxheading{Parameters}
3091
3092 \docparam{font}{Font to associate with this window, pass
3093 {\tt wxNullFont} to reset to the default font.}
3094
3095 \wxheading{Return value}
3096
3097 \true if the want was really changed, \false if it was already set to this
3098 \arg{font} and so nothing was done.
3099
3100 \wxheading{See also}
3101
3102 \helpref{wxWindow::GetFont}{wxwindowgetfont},\\
3103 \helpref{InheritAttributes}{wxwindowinheritattributes}
3104
3105
3106 \membersection{wxWindow::SetForegroundColour}\label{wxwindowsetforegroundcolour}
3107
3108 \func{virtual void}{SetForegroundColour}{\param{const wxColour\& }{colour}}
3109
3110 Sets the foreground colour of the window.
3111
3112 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
3113 explanation of the difference between this method and
3114 \helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}.
3115
3116 \wxheading{Parameters}
3117
3118 \docparam{colour}{The colour to be used as the foreground colour, pass
3119 {\tt wxNullColour} to reset to the default colour.}
3120
3121 \wxheading{Remarks}
3122
3123 The interpretation of foreground colour is open to interpretation according
3124 to the window class; it may be the text colour or other colour, or it may not
3125 be used at all.
3126
3127 Using this function will disable attempts to use themes for this
3128 window, if the system supports them. Use with care since usually the
3129 themes represent the appearance chosen by the user to be used for all
3130 applications on the system.
3131
3132 \wxheading{See also}
3133
3134 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
3135 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
3136 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp
3137 \helpref{wxWindow::ShouldInheritColours}{wxwindowshouldinheritcolours}
3138
3139
3140 \membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext}
3141
3142 \func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}}
3143
3144 Sets the help text to be used as context-sensitive help for this window.
3145
3146 Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation,
3147 and not in the window object itself.
3148
3149 \wxheading{See also}
3150
3151 \helpref{GetHelpText}{wxwindowgethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
3152
3153
3154 \membersection{wxWindow::SetId}\label{wxwindowsetid}
3155
3156 \func{void}{SetId}{\param{int}{ id}}
3157
3158 Sets the identifier of the window.
3159
3160 \wxheading{Remarks}
3161
3162 Each window has an integer identifier. If the application has not provided one,
3163 an identifier will be generated. Normally, the identifier should be provided
3164 on creation and should not be modified subsequently.
3165
3166 \wxheading{See also}
3167
3168 \helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp
3169 \helpref{Window identifiers}{windowids}
3170
3171
3172
3173 \membersection{wxWindow::SetInitialBestSize}\label{wxwindowsetinitialbestsize}
3174
3175 \func{virtual void}{SetInitialBestSize}{\param{const wxSize\& }{size}}
3176
3177 Sets the initial window size if none is given (i.e. at least one of the
3178 components of the size passed to ctor/Create() is wxDefaultCoord).
3179
3180
3181 \membersection{wxWindow::SetInitialSize}\label{wxwindowsetinitialsize}
3182
3183 \func{void}{SetInitialSize}{\param{const wxSize\& }{size = wxDefaultSize}}
3184
3185 A {\it smart} SetSize that will fill in default size components with the
3186 window's {\it best} size values. Also sets the window's minsize to
3187 the value passed in for use with sizers. This means that if a full or
3188 partial size is passed to this function then the sizers will use that
3189 size instead of the results of GetBestSize to determine the minimum
3190 needs of the window for layout.
3191
3192 Most controls will use this to set their initial size, and their min
3193 size to the passed in value (if any.)
3194
3195
3196 \wxheading{See also}
3197
3198 \helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp
3199 \helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
3200 \helpref{wxWindow::GetEffectiveMinSize}{wxwindowgeteffectiveminsize}
3201
3202
3203 \membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
3204
3205 \func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
3206
3207 Sets the window's label.
3208
3209 \wxheading{Parameters}
3210
3211 \docparam{label}{The window label.}
3212
3213 \wxheading{See also}
3214
3215 \helpref{wxWindow::GetLabel}{wxwindowgetlabel}
3216
3217
3218 \membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize}
3219
3220 \func{void}{SetMaxSize}{\param{const wxSize\& }{size}}
3221
3222 Sets the maximum size of the window, to indicate to the sizer layout mechanism
3223 that this is the maximum possible size.
3224
3225 \membersection{wxWindow::SetMinSize}\label{wxwindowsetminsize}
3226
3227 \func{void}{SetMinSize}{\param{const wxSize\& }{size}}
3228
3229 Sets the minimum size of the window, to indicate to the sizer layout mechanism
3230 that this is the minimum required size. You may need to call this
3231 if you change the window size after construction and before adding
3232 to its parent sizer.
3233
3234 \membersection{wxWindow::SetName}\label{wxwindowsetname}
3235
3236 \func{virtual void}{SetName}{\param{const wxString\& }{name}}
3237
3238 Sets the window's name.
3239
3240 \wxheading{Parameters}
3241
3242 \docparam{name}{A name to set for the window.}
3243
3244 \wxheading{See also}
3245
3246 \helpref{wxWindow::GetName}{wxwindowgetname}
3247
3248
3249 \membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour}
3250
3251 \func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}}
3252
3253 Sets the background colour of the window but prevents it from being inherited
3254 by the children of this window.
3255
3256 \wxheading{See also}
3257
3258 \helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
3259 \helpref{InheritAttributes}{wxwindowinheritattributes}
3260
3261
3262 \membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
3263
3264 \func{void}{SetOwnFont}{\param{const wxFont\& }{font}}
3265
3266 Sets the font of the window but prevents it from being inherited by the
3267 children of this window.
3268
3269 \wxheading{See also}
3270
3271 \helpref{SetFont}{wxwindowsetfont},\rtfsp
3272 \helpref{InheritAttributes}{wxwindowinheritattributes}
3273
3274
3275 \membersection{wxWindow::SetOwnForegroundColour}\label{wxwindowsetownforegroundcolour}
3276
3277 \func{void}{SetOwnForegroundColour}{\param{const wxColour\& }{colour}}
3278
3279 Sets the foreground colour of the window but prevents it from being inherited
3280 by the children of this window.
3281
3282 \wxheading{See also}
3283
3284 \helpref{SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
3285 \helpref{InheritAttributes}{wxwindowinheritattributes}
3286
3287
3288 \membersection{wxWindow::SetPalette}\label{wxwindowsetpalette}
3289
3290 \func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}
3291
3292 Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead.
3293
3294
3295 \membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar}
3296
3297 \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
3298 \param{int }{thumbSize}, \param{int }{range},\rtfsp
3299 \param{bool }{refresh = {\tt true}}}
3300
3301 Sets the scrollbar properties of a built-in scrollbar.
3302
3303 \wxheading{Parameters}
3304
3305 \docparam{orientation}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.}
3306
3307 \docparam{position}{The position of the scrollbar in scroll units.}
3308
3309 \docparam{thumbSize}{The size of the thumb, or visible portion of the scrollbar, in scroll units.}
3310
3311 \docparam{range}{The maximum position of the scrollbar.}
3312
3313 \docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}
3314
3315 \wxheading{Remarks}
3316
3317 Let's say you wish to display 50 lines of text, using the same font.
3318 The window is sized so that you can only see 16 lines at a time.
3319
3320 You would use:
3321
3322 {\small%
3323 \begin{verbatim}
3324 SetScrollbar(wxVERTICAL, 0, 16, 50);
3325 \end{verbatim}
3326 }
3327
3328 Note that with the window at this size, the thumb position can never go
3329 above 50 minus 16, or 34.
3330
3331 You can determine how many lines are currently visible by dividing the current view
3332 size by the character height in pixels.
3333
3334 When defining your own scrollbar behaviour, you will always need to recalculate
3335 the scrollbar settings when the window size changes. You could therefore put your
3336 scrollbar calculations and SetScrollbar
3337 call into a function named AdjustScrollbars, which can be called initially and also
3338 from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
3339
3340 \wxheading{See also}
3341
3342 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
3343 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow},\rtfsp
3344 \helpref{wxScrollWinEvent}{wxscrollwinevent}
3345
3346 \begin{comment}
3347
3348
3349 \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
3350
3351 \func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt true}}}
3352
3353 Sets the page size of one of the built-in scrollbars.
3354
3355 \wxheading{Parameters}
3356
3357 \docparam{orientation}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.}
3358
3359 \docparam{pageSize}{Page size in scroll units.}
3360
3361 \docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}
3362
3363 \wxheading{Remarks}
3364
3365 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
3366 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
3367 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
3368 value has to be adjusted when the window is resized, since the page size will have changed.
3369
3370 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
3371 the thumb changes size to reflect the page size relative to the length of the document. When the
3372 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
3373 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
3374 disappear.
3375
3376 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
3377 handling of pages and ranges.
3378
3379 \wxheading{See also}
3380
3381 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
3382 \helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
3383 \helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp
3384 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
3385 \end{comment}
3386
3387
3388 \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
3389
3390 \func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt true}}}
3391
3392 Sets the position of one of the built-in scrollbars.
3393
3394 \wxheading{Parameters}
3395
3396 \docparam{orientation}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.}
3397
3398 \docparam{pos}{Position in scroll units.}
3399
3400 \docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}
3401
3402 \wxheading{Remarks}
3403
3404 This function does not directly affect the contents of the window: it is up to the
3405 application to take note of scrollbar attributes and redraw contents accordingly.
3406
3407 \wxheading{See also}
3408
3409 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp
3410 \helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
3411 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
3412 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
3413
3414 \begin{comment}
3415
3416
3417 \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
3418
3419 \func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt true}}}
3420
3421 Sets the range of one of the built-in scrollbars.
3422
3423 \wxheading{Parameters}
3424
3425 \docparam{orientation}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.}
3426
3427 \docparam{range}{Scroll range.}
3428
3429 \docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}
3430
3431 \wxheading{Remarks}
3432
3433 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
3434 object length of the scrollbar. If you are implementing a scrolling window, for example, you
3435 would adjust the scroll range when the window is resized, by subtracting the window view size from the
3436 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
3437 and usually the scrollbar will be automatically hidden.
3438
3439 \wxheading{See also}
3440
3441 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
3442 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp
3443 \helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
3444 \helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp
3445 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
3446 \end{comment}
3447
3448
3449 \membersection{wxWindow::SetSize}\label{wxwindowsetsize}
3450
3451 \func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
3452 \param{int}{ sizeFlags = wxSIZE\_AUTO}}
3453
3454 \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
3455
3456 Sets the position and size of the window in pixels.
3457
3458 \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
3459
3460 \func{virtual void}{SetSize}{\param{const wxSize\&}{ size}}
3461
3462 Sets the size of the window in pixels.
3463
3464 \wxheading{Parameters}
3465
3466 \docparam{x}{Required x position in pixels, or wxDefaultCoord to indicate that the existing
3467 value should be used.}
3468
3469 \docparam{y}{Required y position in pixels, or wxDefaultCoord to indicate that the existing
3470 value should be used.}
3471
3472 \docparam{width}{Required width in pixels, or wxDefaultCoord to indicate that the existing
3473 value should be used.}
3474
3475 \docparam{height}{Required height position in pixels, or wxDefaultCoord to indicate that the existing
3476 value should be used.}
3477
3478 \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}
3479
3480 \docparam{rect}{\helpref{wxRect}{wxrect} object for setting the position and size.}
3481
3482 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
3483
3484 {\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
3485 a wxWidgets-supplied default width.\\
3486 {\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
3487 a wxWidgets-supplied default height.\\
3488 {\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
3489 a wxWidgets-supplied default size.\\
3490 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
3491 if $wxDefaultCoord$ values are supplied.\\
3492 {\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted
3493 as real dimensions, not default values.
3494 {\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are
3495 already the same as the parameters of this function, nothing is done. but with
3496 this flag a window resize may be forced even in this case (supported in wx
3497 2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
3498 }
3499
3500 \wxheading{Remarks}
3501
3502 The second form is a convenience for calling the first form with default
3503 x and y parameters, and must be used with non-default width and height values.
3504
3505 The first form sets the position and optionally size, of the window.
3506 Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied
3507 by wxWidgets, or that the current value of the dimension should be used.
3508
3509 \wxheading{See also}
3510
3511 \helpref{wxWindow::Move}{wxwindowmove}
3512
3513 \pythonnote{In place of a single overloaded method name, wxPython
3514 implements the following methods:\par
3515 \indented{2cm}{\begin{twocollist}
3516 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE\_AUTO)}}{}
3517 \twocolitem{{\bf SetSize(size)}}{}
3518 \twocolitem{{\bf SetPosition(point)}}{}
3519 \end{twocollist}}
3520 }
3521
3522
3523 \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
3524
3525 Use of this function for windows which are not toplevel windows
3526 (such as wxDialog or wxFrame) is discouraged. Please use
3527 \helpref{SetMinSize}{wxwindowsetminsize} and \helpref{SetMaxSize}{wxwindowsetmaxsize}
3528 instead.
3529
3530 \wxheading{See also}
3531
3532 \helpref{wxTopLevelWindow::SetSizeHints}{wxtoplevelwindowsetsizehints}.
3533
3534
3535 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
3536
3537 \func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
3538
3539 Sets the window to have the given layout sizer. The window
3540 will then own the object, and will take care of its deletion.
3541 If an existing layout constraints object is already owned by the
3542 window, it will be deleted if the deleteOld parameter is true.
3543
3544 Note that this function will also call
3545 \helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt true}
3546 parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise.
3547
3548 \wxheading{Parameters}
3549
3550 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
3551 the window's sizer. See below.}
3552
3553 \docparam{deleteOld}{If true (the default), this will delete any pre-existing sizer.
3554 Pass false if you wish to handle deleting the old sizer yourself.}
3555
3556 \wxheading{Remarks}
3557
3558 SetSizer now enables and disables Layout automatically, but prior to wxWidgets 2.3.3
3559 the following applied:
3560
3561 You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use
3562 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
3563 explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints},
3564 only the sizer will have effect.
3565
3566
3567 \membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit}
3568
3569 \func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
3570
3571 The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints
3572 for the window based on the sizer's minimum size.
3573
3574
3575 \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}
3576
3577 \func{virtual void}{SetThemeEnabled}{\param{bool }{enable}}
3578
3579 This function tells a window if it should use the system's "theme" code
3580 to draw the windows' background instead if its own background drawing
3581 code. This does not always have any effect since the underlying platform
3582 obviously needs to support the notion of themes in user defined windows.
3583 One such platform is GTK+ where windows can have (very colourful) backgrounds
3584 defined by a user's selected theme.
3585
3586 Dialogs, notebook pages and the status bar have this flag set to true
3587 by default so that the default look and feel is simulated best.
3588
3589
3590 \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
3591
3592 \func{void}{SetToolTip}{\param{const wxString\& }{tip}}
3593
3594 \func{void}{SetToolTip}{\param{wxToolTip* }{tip}}
3595
3596 Attach a tooltip to the window.
3597
3598 See also: \helpref{GetToolTip}{wxwindowgettooltip},
3599 \helpref{wxToolTip}{wxtooltip}
3600
3601
3602 \membersection{wxWindow::SetTransparent}\label{wxwindowsettransparent}
3603
3604 \func{bool}{SetTransparent}{\param{wxByte }{alpha}}
3605
3606 Set the transparency of the window. If the system supports transparent windows,
3607 returns \true, otherwise returns \false and the window remains fully opaque.
3608 See also \helpref{CanSetTransparent}{wxwindowcansettransparent}.
3609
3610 The parameter \arg{alpha} is in the range $0..255$ where $0$ corresponds to a
3611 fully transparent window and $255$ to the fully opaque one. The constants
3612 \texttt{wxIMAGE\_ALPHA\_TRANSPARENT} and \texttt{wxIMAGE\_ALPHA\_OPAQUE} can be
3613 used.
3614
3615
3616 \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
3617
3618 \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}
3619
3620 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
3621 create a new validator of this type.
3622
3623
3624 \membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
3625
3626 \func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}}
3627
3628 \func{void}{SetVirtualSize}{\param{const wxSize\&}{ size}}
3629
3630 Sets the virtual size of the window in pixels.
3631
3632
3633 \membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
3634
3635 \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}
3636
3637 \func{void}{SetVirtualSizeHints}{\param{const wxSize\&}{ minSize=wxDefaultSize},
3638 \param{const wxSize\&}{ maxSize=wxDefaultSize}}
3639
3640
3641 Allows specification of minimum and maximum virtual window sizes.
3642 If a pair of values is not set (or set to -1), the default values
3643 will be used.
3644
3645 \wxheading{Parameters}
3646
3647 \docparam{minW}{Specifies the minimum width allowable.}
3648
3649 \docparam{minH}{Specifies the minimum height allowable.}
3650
3651 \docparam{maxW}{Specifies the maximum width allowable.}
3652
3653 \docparam{maxH}{Specifies the maximum height allowable.}
3654
3655 \docparam{minSize}{Minimum size.}
3656
3657 \docparam{maxSize}{Maximum size.}
3658
3659 \wxheading{Remarks}
3660
3661 If this function is called, the user will not be able to size the virtual area
3662 of the window outside the given bounds.
3663
3664
3665 \membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
3666
3667 \func{void}{SetWindowStyle}{\param{long}{ style}}
3668
3669 Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}.
3670
3671
3672 \membersection{wxWindow::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag}
3673
3674 \func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}}
3675
3676 Sets the style of the window. Please note that some styles cannot be changed
3677 after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might
3678 need to be be called after changing the others for the change to take place
3679 immediately.
3680
3681 See \helpref{Window styles}{windowstyles} for more information about flags.
3682
3683 \wxheading{See also}
3684
3685 \helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag}
3686
3687
3688 \membersection{wxWindow::SetWindowVariant}\label{wxwindowsetwindowvariant}
3689
3690 \func{void}{SetWindowVariant}{\param{wxWindowVariant}{variant}}
3691
3692 This function can be called under all platforms but only does anything under
3693 Mac OS X 10.3+ currently. Under this system, each of the standard control can
3694 exist in several sizes which correspond to the elements of wxWindowVariant
3695 enum:
3696 \begin{verbatim}
3697 enum wxWindowVariant
3698 {
3699 wxWINDOW_VARIANT_NORMAL, // Normal size
3700 wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal )
3701 wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal )
3702 wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal )
3703 };
3704 \end{verbatim}
3705
3706 By default the controls use the normal size, of course, but this function can
3707 be used to change this.
3708
3709
3710 \membersection{wxWindow::ShouldInheritColours}\label{wxwindowshouldinheritcolours}
3711
3712 \func{virtual bool}{ShouldInheritColours}{\void}
3713
3714 Return \true from here to allow the colours of this window to be changed by
3715 \helpref{InheritAttributes}{wxwindowinheritattributes}, returning \false
3716 forbids inheriting them from the parent window.
3717
3718 The base class version returns \false, but this method is overridden in
3719 \helpref{wxControl}{wxcontrol} where it returns \true.
3720
3721
3722 \membersection{wxWindow::Show}\label{wxwindowshow}
3723
3724 \func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}}
3725
3726 Shows or hides the window. You may need to call \helpref{Raise}{wxwindowraise}
3727 for a top level window if you want to bring it to top, although this is not
3728 needed if Show() is called immediately after the frame creation.
3729
3730 \wxheading{Parameters}
3731
3732 \docparam{show}{If {\tt true} displays the window. Otherwise, hides it.}
3733
3734 \wxheading{Return value}
3735
3736 {\tt true} if the window has been shown or hidden or {\tt false} if nothing was
3737 done because it already was in the requested state.
3738
3739 \wxheading{See also}
3740
3741 \helpref{wxWindow::IsShown}{wxwindowisshown},\rtfsp
3742 \helpref{wxWindow::Hide}{wxwindowhide},\rtfsp
3743 \helpref{wxRadioBox::Show}{wxradioboxshow}
3744
3745
3746 \membersection{wxWindow::Thaw}\label{wxwindowthaw}
3747
3748 \func{virtual void}{Thaw}{\void}
3749
3750 Reenables window updating after a previous call to
3751 \helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called
3752 exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}.
3753
3754 \wxheading{See also}
3755
3756 \helpref{wxWindowUpdateLocker}{wxwindowupdatelocker}
3757
3758
3759 \membersection{wxWindow::ToggleWindowStyle}\label{wxwindowtogglewindowstyle}
3760
3761 \func{bool}{ToggleWindowStyle}{\param{int }{flag}}
3762
3763 Turns the given \arg{flag} on if it's currently turned off and vice versa.
3764 This function cannot be used if the value of the flag is $0$ (which is often
3765 the case for default flags).
3766
3767 Also, please notice that not all styles can be changed after the control
3768 creation.
3769
3770 \wxheading{Return value}
3771
3772 Returns \true if the style was turned on by this function, \false if it was
3773 switched off.
3774
3775 \wxheading{See also}
3776
3777 \helpref{wxWindow::SetWindowStyleFlag}{wxwindowsetwindowstyleflag},\rtfsp
3778 \helpref{wxWindow::HasFlag}{wxwindowhasflag}
3779
3780
3781 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
3782
3783 \func{virtual bool}{TransferDataFromWindow}{\void}
3784
3785 Transfers values from child controls to data areas specified by their validators. Returns
3786 {\tt false} if a transfer failed.
3787
3788 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3789 the method will also call TransferDataFromWindow() of all child windows.
3790
3791 \wxheading{See also}
3792
3793 \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
3794 \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
3795
3796
3797 \membersection{wxWindow::TransferDataToWindow}\label{wxwindowtransferdatatowindow}
3798
3799 \func{virtual bool}{TransferDataToWindow}{\void}
3800
3801 Transfers values to child controls from data areas specified by their validators.
3802
3803 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3804 the method will also call TransferDataToWindow() of all child windows.
3805
3806 \wxheading{Return value}
3807
3808 Returns {\tt false} if a transfer failed.
3809
3810 \wxheading{See also}
3811
3812 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
3813 \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
3814
3815
3816 \membersection{wxWindow::UnregisterHotKey}\label{wxwindowunregisterhotkey}
3817
3818 \func{bool}{UnregisterHotKey}{\param{int}{ hotkeyId}}
3819
3820 Unregisters a system wide hotkey.
3821
3822 \wxheading{Parameters}
3823
3824 \docparam{hotkeyId}{Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey.}
3825
3826 \wxheading{Return value}
3827
3828 {\tt true} if the hotkey was unregistered successfully, {\tt false} if the id was invalid.
3829
3830 \wxheading{Remarks}
3831
3832 This function is currently only implemented under MSW.
3833
3834 \wxheading{See also}
3835
3836 \helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey}
3837
3838
3839 \membersection{wxWindow::Update}\label{wxwindowupdate}
3840
3841 \func{virtual void}{Update}{\void}
3842
3843 Calling this method immediately repaints the invalidated area of the window and
3844 all of its children recursively while this would usually only happen when the
3845 flow of control returns to the event loop.
3846 Notice that this function doesn't invalidate any area of the window so
3847 nothing happens if nothing has been invalidated (i.e. marked as requiring
3848 a redraw). Use \helpref{Refresh}{wxwindowrefresh} first if you want to
3849 immediately redraw the window unconditionally.
3850
3851
3852 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}
3853
3854 \func{virtual void}{UpdateWindowUI}{\param{long}{ flags = wxUPDATE\_UI\_NONE}}
3855
3856 This function sends \helpref{wxUpdateUIEvents}{wxupdateuievent} to
3857 the window. The particular implementation depends on the window; for
3858 example a wxToolBar will send an update UI event for each toolbar button,
3859 and a wxFrame will send an update UI event for each menubar menu item.
3860 You can call this function from your application to ensure that your
3861 UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers
3862 are concerned). This may be necessary if you have called
3863 \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} or
3864 \helpref{wxUpdateUIEvent::SetUpdateInterval}{wxupdateuieventsetupdateinterval} to
3865 limit the overhead that wxWidgets incurs by sending update UI events in idle time.
3866
3867 {\it flags} should be a bitlist of one or more of the following values.
3868
3869 \begin{verbatim}
3870 enum wxUpdateUI
3871 {
3872 wxUPDATE_UI_NONE = 0x0000, // No particular value
3873 wxUPDATE_UI_RECURSE = 0x0001, // Call the function for descendants
3874 wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle
3875 };
3876 \end{verbatim}
3877
3878 If you are calling this function from an OnInternalIdle or OnIdle
3879 function, make sure you pass the wxUPDATE\_UI\_FROMIDLE flag, since
3880 this tells the window to only update the UI elements that need
3881 to be updated in idle time. Some windows update their elements
3882 only when necessary, for example when a menu is about to be shown.
3883 The following is an example of how to call UpdateWindowUI from
3884 an idle function.
3885
3886 \begin{verbatim}
3887 void MyWindow::OnInternalIdle()
3888 {
3889 if (wxUpdateUIEvent::CanUpdate(this))
3890 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
3891 }
3892 \end{verbatim}
3893
3894 \wxheading{See also}
3895
3896 \helpref{wxUpdateUIEvent}{wxupdateuievent},
3897 \helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui},
3898 \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle}
3899
3900
3901 \membersection{wxWindow::Validate}\label{wxwindowvalidate}
3902
3903 \func{virtual bool}{Validate}{\void}
3904
3905 Validates the current values of the child controls using their validators.
3906
3907 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3908 the method will also call Validate() of all child windows.
3909
3910 \wxheading{Return value}
3911
3912 Returns {\tt false} if any of the validations failed.
3913
3914 \wxheading{See also}
3915
3916 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
3917 \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
3918 \helpref{wxValidator}{wxvalidator}
3919
3920
3921 \membersection{wxWindow::WarpPointer}\label{wxwindowwarppointer}
3922
3923 \func{void}{WarpPointer}{\param{int}{ x}, \param{int}{ y}}
3924
3925 Moves the pointer to the given position on the window.
3926
3927 {\bf NB: } This function is not supported under Mac because Apple Human
3928 Interface Guidelines forbid moving the mouse cursor programmatically.
3929
3930 \wxheading{Parameters}
3931
3932 \docparam{x}{The new x position for the cursor.}
3933
3934 \docparam{y}{The new y position for the cursor.}
3935