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