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