1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: wxWindow documentation
4 %% Author: wxWidgets Team
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxWindow
}}\label{wxwindow
}
14 wxWindow is the base class for all windows and represents any visible object on
15 screen. All controls, top level windows and so on are windows. Sizers and
16 device contexts are not, however, as they don't appear on screen themselves.
18 Please note that all children of the window will be deleted automatically by
19 the destructor before the window itself is deleted which means that you don't
20 have to worry about deleting them manually. Please see the
\helpref{window
21 deletion overview
}{windowdeletionoverview
} for more information.
23 Also note that in this, and many others, wxWidgets classes some
24 \texttt{GetXXX()
} methods may be overloaded (as, for example,
25 \helpref{GetSize
}{wxwindowgetsize
} or
26 \helpref{GetClientSize
}{wxwindowgetclientsize
}). In this case, the overloads
27 are non-virtual because having multiple virtual functions with the same name
28 results in a virtual function name hiding at the derived class level (in
29 English, this means that the derived class has to override all overloaded
30 variants if it overrides any of them). To allow overriding them in the derived
31 class, wxWidgets uses a unique protected virtual
\texttt{DoGetXXX()
} method
32 and all
\texttt{GetXXX()
} ones are forwarded to it, so overriding the former
33 changes the behaviour of the latter.
35 \wxheading{Derived from
}
37 \helpref{wxEvtHandler
}{wxevthandler
}\\
38 \helpref{wxObject
}{wxobject
}
40 \wxheading{Include files
}
44 \wxheading{Window styles
}
46 The following styles can apply to all windows, although they will not always make sense for a particular
47 window class or on all platforms.
50 \begin{twocollist
}\itemsep=
0pt
51 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
53 \twocolitem{\windowstyle{wxDOUBLE
\_BORDER}}{Displays a double border. Windows and Mac only.
}
54 \twocolitem{\windowstyle{wxSUNKEN
\_BORDER}}{Displays a sunken border.
}
55 \twocolitem{\windowstyle{wxRAISED
\_BORDER}}{Displays a raised border.
}
56 \twocolitem{\windowstyle{wxSTATIC
\_BORDER}}{Displays a border suitable for a static control. Windows only.
}
57 \twocolitem{\windowstyle{wxNO
\_BORDER}}{Displays no border, overriding the default border style for the window.
}
58 \twocolitem{\windowstyle{wxTRANSPARENT
\_WINDOW}}{The window is transparent, that is, it will not receive paint
59 events. Windows only.
}
60 \twocolitem{\windowstyle{wxTAB
\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.
}
61 \twocolitem{\windowstyle{wxWANTS
\_CHARS}}{Use this to indicate that
62 the window wants to get all char/key events for all keys - even for
63 keys like TAB or ENTER which are usually used for dialog navigation
64 and which wouldn't be generated without this style. If you need to
65 use this style in order to get the arrows or etc., but would still like to have
66 normal keyboard navigation take place, you should create and send a
67 wxNavigationKeyEvent in response to the key events for Tab and
69 \twocolitem{\windowstyle{wxNO
\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting
70 the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete
71 and no longer has an effect.
}
72 \twocolitem{\windowstyle{wxVSCROLL
}}{Use this style to enable a vertical scrollbar.
}
73 \twocolitem{\windowstyle{wxHSCROLL
}}{Use this style to enable a horizontal scrollbar.
}
74 \twocolitem{\windowstyle{wxALWAYS
\_SHOW\_SB}}{If a window has scrollbars,
75 disable them instead of hiding them when they are not needed (i.e. when the
76 size of the window is big enough to not require the scrollbars to navigate it).
77 This style is currently implemented for wxMSW, wxGTK and wxUniversal and does
78 nothing on the other platforms.
}
79 \twocolitem{\windowstyle{wxCLIP
\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
80 repainted, then children being painted over them. Windows only.
}
81 \twocolitem{\windowstyle{wxFULL
\_REPAINT\_ON\_RESIZE}}{Use this style to force
82 a complete redraw of the window whenever it is resized instead of redrawing
83 just the part of the window affected by resizing. Note that this was the
84 behaviour by default before
2.5.1 release and that if you experience redraw
85 problems with code which previously used to work you may want to try this.
86 Currently this style applies on GTK+
2 and Windows only, and full repainting is always
87 done on other platforms.
}
90 See also
\helpref{window styles overview
}{windowstyles
}.
92 \wxheading{Extra window styles
}
94 The following are extra styles, set using
\helpref{wxWindow::SetExtraStyle
}{wxwindowsetextrastyle
}.
97 \begin{twocollist
}\itemsep=
0pt
98 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{By default, Validate/TransferDataTo/FromWindow()
99 only work on direct children of the window (compatible behaviour). Set this flag to make them recursively
100 descend into all subwindows.
}
101 \twocolitem{\windowstyle{wxWS
\_EX\_BLOCK\_EVENTS}}{wxCommandEvents and the objects of the derived classes are forwarded to the
102 parent window and so on recursively by default. Using this flag for the
103 given window allows to block this propagation at this window, i.e. prevent
104 the events from being propagated further upwards. Dialogs have this
106 \twocolitem{\windowstyle{wxWS
\_EX\_TRANSIENT}}{Don't use this window as an implicit parent for the other windows: this must
107 be used with transient windows as otherwise there is the risk of creating a
108 dialog/frame with this window as a parent which would lead to a crash if the
109 parent is destroyed before the child.
}
110 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
111 if the mode set by
\helpref{wxIdleEvent::SetMode
}{wxidleeventsetmode
} is wxIDLE
\_PROCESS\_SPECIFIED.
}
112 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
113 even if the mode set by
\helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} is wxUPDATE
\_UI\_PROCESS\_SPECIFIED.
}
118 \helpref{Event handling overview
}{eventhandlingoverview
}\\
119 \helpref{Window sizing overview
}{windowsizingoverview
}
121 \latexignore{\rtfignore{\wxheading{Members
}}}
124 \membersection{wxWindow::wxWindow
}\label{wxwindowctor
}
126 \func{}{wxWindow
}{\void}
130 \func{}{wxWindow
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
131 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
132 \param{const wxSize\&
}{size = wxDefaultSize
},
133 \param{long
}{style =
0},
134 \param{const wxString\&
}{name = wxPanelNameStr
}}
136 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
138 \wxheading{Parameters
}
140 \docparam{parent
}{Pointer to a parent window.
}
142 \docparam{id
}{Window identifier. If wxID
\_ANY, will automatically create an identifier.
}
144 \docparam{pos
}{Window position. wxDefaultPosition indicates that wxWidgets
145 should generate a default position for the window. If using the wxWindow class directly, supply
148 \docparam{size
}{Window size. wxDefaultSize indicates that wxWidgets
149 should generate a default size for the window. If no suitable size can be found, the
150 window will be sized to
20x20 pixels so that the window is visible but obviously not
153 \docparam{style
}{Window style. For generic window styles, please see
\helpref{wxWindow
}{wxwindow
}.
}
155 \docparam{name
}{Window name.
}
158 \membersection{wxWindow::
\destruct{wxWindow
}}\label{wxwindowdtor
}
160 \func{}{\destruct{wxWindow
}}{\void}
162 Destructor. Deletes all subwindows, then deletes itself. Instead of using
163 the
{\bf delete
} operator explicitly, you should normally
164 use
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} so that wxWidgets
165 can delete a window only when it is safe to do so, in idle time.
169 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
170 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
171 \helpref{wxCloseEvent
}{wxcloseevent
}
174 \membersection{wxWindow::AddChild
}\label{wxwindowaddchild
}
176 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
178 Adds a child window. This is called automatically by window creation
179 functions so should not be required by the application programmer.
181 Notice that this function is mostly internal to wxWidgets and shouldn't be
182 called by the user code.
184 \wxheading{Parameters
}
186 \docparam{child
}{Child window to add.
}
189 \membersection{wxWindow::CacheBestSize
}\label{wxwindowcachebestsize
}
191 \constfunc{void
}{CacheBestSize
}{\param{const wxSize\&
}{size
}}
193 Sets the cached best size value.
196 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
198 \func{virtual void
}{CaptureMouse
}{\void}
200 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
203 Note that wxWidgets maintains the stack of windows having captured the mouse
204 and when the mouse is released the capture returns to the window which had had
205 captured it previously and it is only really released if there were no previous
206 window. In particular, this means that you must release the mouse as many times
207 as you capture it, unless the window receives
208 the
\helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
} event.
210 Any application which captures the mouse in the beginning of some operation
211 {\em must
} handle
\helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
212 and cancel this operation when it receives the event. The event handler must
217 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
218 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
221 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
223 \func{void
}{Center
}{\param{int
}{ direction
}}
225 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
228 \membersection{wxWindow::CenterOnParent
}\label{wxwindowcenteronparent
}
230 \func{void
}{CenterOnParent
}{\param{int
}{ direction
}}
232 A synonym for
\helpref{CentreOnParent
}{wxwindowcentreonparent
}.
235 \membersection{wxWindow::CenterOnScreen
}\label{wxwindowcenteronscreen
}
237 \func{void
}{CenterOnScreen
}{\param{int
}{ direction
}}
239 A synonym for
\helpref{CentreOnScreen
}{wxwindowcentreonscreen
}.
242 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
244 \func{void
}{Centre
}{\param{int
}{ direction = wxBOTH
}}
248 \wxheading{Parameters
}
250 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
251 or
{\tt wxBOTH
}. It may also include
{\tt wxCENTRE
\_ON\_SCREEN} flag
252 if you want to center the window on the entire screen and not on its
255 The flag
{\tt wxCENTRE
\_FRAME} is obsolete and should not be used any longer
260 If the window is a top level one (i.e. doesn't have a parent), it will be
261 centered relative to the screen anyhow.
265 \helpref{wxWindow::Center
}{wxwindowcenter
}
268 \membersection{wxWindow::CentreOnParent
}\label{wxwindowcentreonparent
}
270 \func{void
}{CentreOnParent
}{\param{int
}{ direction = wxBOTH
}}
272 Centres the window on its parent. This is a more readable synonym for
273 \helpref{Centre
}{wxwindowcentre
}.
275 \wxheading{Parameters
}
277 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
282 This methods provides for a way to center top level windows over their
283 parents instead of the entire screen. If there is no parent or if the
284 window is not a top level window, then behaviour is the same as
285 \helpref{wxWindow::Centre
}{wxwindowcentre
}.
289 \helpref{wxWindow::CentreOnScreen
}{wxwindowcenteronscreen
}
292 \membersection{wxWindow::CentreOnScreen
}\label{wxwindowcentreonscreen
}
294 \func{void
}{CentreOnScreen
}{\param{int
}{ direction = wxBOTH
}}
296 Centres the window on screen. This only works for top level windows -
297 otherwise, the window will still be centered on its parent.
299 \wxheading{Parameters
}
301 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
306 \helpref{wxWindow::CentreOnParent
}{wxwindowcenteronparent
}
309 \membersection{wxWindow::ClearBackground
}\label{wxwindowclearbackground
}
311 \func{void
}{ClearBackground
}{\void}
313 Clears the window by filling it with the current background colour. Does not
314 cause an erase background event to be generated.
317 \membersection{wxWindow::ClientToScreen
}\label{wxwindowclienttoscreen
}
319 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
321 \perlnote{In wxPerl this method returns a
2-element list instead of
322 modifying its parameters.
}
324 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
326 Converts to screen coordinates from coordinates relative to this window.
328 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
329 a screen coordinate will be passed out.
}
331 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
332 a screen coordinate will be passed out.
}
334 \docparam{pt
}{The client position for the second form of the function.
}
336 \pythonnote{In place of a single overloaded method name, wxPython
337 implements the following methods:
\par
338 \indented{2cm
}{\begin{twocollist
}
339 \twocolitem{{\bf ClientToScreen(point)
}}{Accepts and returns a wxPoint
}
340 \twocolitem{{\bf ClientToScreenXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
345 \membersection{wxWindow::Close
}\label{wxwindowclose
}
347 \func{bool
}{Close
}{\param{bool
}{ force =
{\tt false
}}}
349 This function simply generates a
\helpref{wxCloseEvent
}{wxcloseevent
} whose
350 handler usually tries to close the window. It doesn't close the window itself,
353 \wxheading{Parameters
}
355 \docparam{force
}{{\tt false
} if the window's close handler should be able to veto the destruction
356 of this window,
{\tt true
} if it cannot.
}
360 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing
361 an opportunity for the window to choose whether to destroy the window.
362 Usually it is only used with the top level windows (wxFrame and wxDialog
363 classes) as the others are not supposed to have any special OnClose() logic.
365 The close handler should check whether the window is being deleted forcibly,
366 using
\helpref{wxCloseEvent::CanVeto
}{wxcloseeventcanveto
}, in which case it
367 should destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
369 {\it Note
} that calling Close does not guarantee that the window will be
370 destroyed; but it provides a way to simulate a manual close of a window, which
371 may or may not be implemented by destroying the window. The default
372 implementation of wxDialog::OnCloseWindow does not necessarily delete the
373 dialog, since it will simply simulate an wxID
\_CANCEL event which is handled by
374 the appropriate button event handler and may do anything at all.
376 To guarantee that the window will be destroyed, call
377 \helpref{wxWindow::Destroy
}{wxwindowdestroy
} instead
381 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
382 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
383 \helpref{wxCloseEvent
}{wxcloseevent
}
386 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
388 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
390 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
392 Converts a point or size from dialog units to pixels.
394 For the x dimension, the dialog units are multiplied by the average character width
395 and then divided by
4.
397 For the y dimension, the dialog units are multiplied by the average character height
398 and then divided by
8.
402 Dialog units are used for maintaining a dialog's proportions even if the font changes.
404 You can also use these functions programmatically. A convenience macro is defined:
408 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
414 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
416 \pythonnote{In place of a single overloaded method name, wxPython
417 implements the following methods:
\par
418 \indented{2cm
}{\begin{twocollist
}
419 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
420 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
423 Additionally, the following helper functions are defined:
\par
424 \indented{2cm
}{\begin{twocollist
}
425 \twocolitem{{\bf wxDLG
\_PNT(win, point)
}}{Converts a wxPoint from dialog
427 \twocolitem{{\bf wxDLG
\_SZE(win, size)
}}{Converts a wxSize from dialog
434 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
436 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
438 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
440 Converts a point or size from pixels to dialog units.
442 For the x dimension, the pixels are multiplied by
4 and then divided by the average
445 For the y dimension, the pixels are multiplied by
8 and then divided by the average
450 Dialog units are used for maintaining a dialog's proportions even if the font changes.
454 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
456 \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:
\par
457 \indented{2cm
}{\begin{twocollist
}
458 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
459 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
464 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
466 \func{virtual bool
}{Destroy
}{\void}
468 Destroys the window safely. Use this function instead of the delete operator, since
469 different window classes can be destroyed differently. Frames and dialogs
470 are not destroyed immediately when this function is called -- they are added
471 to a list of windows to be deleted on idle time, when all the window's events
472 have been processed. This prevents problems with events being sent to non-existent
475 \wxheading{Return value
}
477 {\tt true
} if the window has either been successfully deleted, or it has been added
478 to the list of windows pending real deletion.
481 \membersection{wxWindow::DestroyChildren
}\label{wxwindowdestroychildren
}
483 \func{virtual void
}{DestroyChildren
}{\void}
485 Destroys all children of a window. Called automatically by the destructor.
488 \membersection{wxWindow::Disable
}\label{wxwindowdisable
}
490 \func{bool
}{Disable
}{\void}
492 Disables the window, same as
\helpref{Enable(
{\tt false
})
}{wxwindowenable
}.
494 \wxheading{Return value
}
496 Returns
{\tt true
} if the window has been disabled,
{\tt false
} if it had been
497 already disabled before the call to this function.
500 \membersection{wxWindow::DoGetBestSize
}\label{wxwindowdogetbestsize
}
502 \constfunc{virtual wxSize
}{DoGetBestSize
}{\void}
504 Gets the size which best suits the window: for a control, it would be
505 the minimal size which doesn't truncate the control, for a panel - the
506 same size as it would have after a call to
\helpref{Fit()
}{wxwindowfit
}.
509 \membersection{wxWindow::DoUpdateWindowUI
}\label{wxwindowdoupdatewindowui
}
511 \func{virtual void
}{DoUpdateWindowUI
}{\param{wxUpdateUIEvent\&
}{ event
}}
513 Does the window-specific updating after processing the update event.
514 This function is called by
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
515 in order to check return values in the
\helpref{wxUpdateUIEvent
}{wxupdateuievent
} and
516 act appropriately. For example, to allow frame and dialog title updating, wxWidgets
517 implements this function as follows:
520 // do the window-specific processing after processing the update event
521 void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
523 if ( event.GetSetEnabled() )
524 Enable(event.GetEnabled());
526 if ( event.GetSetText() )
528 if ( event.GetText() != GetTitle() )
529 SetTitle(event.GetText());
536 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
538 \func{virtual void
}{DragAcceptFiles
}{\param{bool
}{ accept
}}
540 Enables or disables eligibility for drop file events (OnDropFiles).
542 \wxheading{Parameters
}
544 \docparam{accept
}{If
{\tt true
}, the window is eligible for drop file events. If
{\tt false
}, the window
545 will not accept drop file events.
}
552 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
554 \func{virtual bool
}{Enable
}{\param{bool
}{ enable =
{\tt true
}}}
556 Enable or disable the window for user input. Note that when a parent window is
557 disabled, all of its children are disabled as well and they are reenabled again
560 \wxheading{Parameters
}
562 \docparam{enable
}{If
{\tt true
}, enables the window for input. If
{\tt false
}, disables the window.
}
564 \wxheading{Return value
}
566 Returns
{\tt true
} if the window has been enabled or disabled,
{\tt false
} if
567 nothing was done, i.e. if the window had already been in the specified state.
571 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
},
\rtfsp
572 \helpref{wxWindow::Disable
}{wxwindowdisable
},
\rtfsp
573 \helpref{wxRadioBox::Enable
}{wxradioboxenable
}
576 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
578 \func{static wxWindow*
}{FindFocus
}{\void}
580 Finds the window or control which currently has the keyboard focus.
584 Note that this is a static function, so it can be called without needing a wxWindow pointer.
588 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
592 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
594 \constfunc{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
596 Find a child of this window, by identifier.
598 \constfunc{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
600 Find a child of this window, by name.
602 \pythonnote{In place of a single overloaded method name, wxPython
603 implements the following methods:
\par
604 \indented{2cm
}{\begin{twocollist
}
605 \twocolitem{{\bf FindWindowById(id)
}}{Accepts an integer
}
606 \twocolitem{{\bf FindWindowByName(name)
}}{Accepts a string
}
611 \membersection{wxWindow::FindWindowById
}\label{wxwindowfindwindowbyid
}
613 \func{static wxWindow*
}{FindWindowById
}{\param{long
}{ id
},
\param{wxWindow*
}{ parent = NULL
}}
615 Find the first window with the given
{\it id
}.
617 If
{\it parent
} is NULL, the search will start from all top-level
618 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
619 The search is recursive in both cases.
623 \helpref{FindWindow
}{wxwindowfindwindow
}
626 \membersection{wxWindow::FindWindowByLabel
}\label{wxwindowfindwindowbylabel
}
628 \func{static wxWindow*
}{FindWindowByLabel
}{\param{const wxString\&
}{ label
},
\param{wxWindow*
}{ parent = NULL
}}
630 Find a window by its label. Depending on the type of window, the label may be a window title
631 or panel item label. If
{\it parent
} is NULL, the search will start from all top-level
632 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
633 The search is recursive in both cases.
637 \helpref{FindWindow
}{wxwindowfindwindow
}
640 \membersection{wxWindow::FindWindowByName
}\label{wxwindowfindwindowbyname
}
642 \func{static wxWindow*
}{FindWindowByName
}{\param{const wxString\&
}{ name
},
\param{wxWindow*
}{ parent = NULL
}}
644 Find a window by its name (as given in a window constructor or
{\bf Create
} function call).
645 If
{\it parent
} is NULL, the search will start from all top-level
646 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
647 The search is recursive in both cases.
649 If no window with such name is found,
650 \helpref{FindWindowByLabel
}{wxwindowfindwindowbylabel
} is called.
654 \helpref{FindWindow
}{wxwindowfindwindow
}
657 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
659 \func{virtual void
}{Fit
}{\void}
661 Sizes the window so that it fits around its subwindows. This function won't do
662 anything if there are no subwindows and will only really work correctly if the
663 sizers are used for the subwindows layout. Also, if the window has exactly one
664 subwindow it is better (faster and the result is more precise as Fit adds some
665 margin to account for fuzziness of its calculations) to call
668 window->SetClientSize(child->GetSize());
671 instead of calling Fit.
674 \membersection{wxWindow::FitInside
}\label{wxwindowfitinside
}
676 \func{virtual void
}{FitInside
}{\void}
678 Similar to
\helpref{Fit
}{wxwindowfit
}, but sizes the interior (virtual) size
679 of a window. Mainly useful with scrolled windows to reset scrollbars after
680 sizing changes that do not trigger a size event, and/or scrolled windows without
681 an interior sizer. This function similarly won't do anything if there are no
685 \membersection{wxWindow::Freeze
}\label{wxwindowfreeze
}
687 \func{virtual void
}{Freeze
}{\void}
689 Freezes the window or, in other words, prevents any updates from taking place
690 on screen, the window is not redrawn at all.
\helpref{Thaw
}{wxwindowthaw
} must
691 be called to reenable window redrawing. Calls to these two functions may be
694 This method is useful for visual appearance optimization (for example, it
695 is a good idea to use it before doing many large text insertions in a row into
696 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
697 controls so it is mostly just a hint to wxWidgets and not a mandatory
702 \helpref{wxWindowUpdateLocker
}{wxwindowupdatelocker
}
705 \membersection{wxWindow::GetAcceleratorTable
}\label{wxwindowgetacceleratortable
}
707 \constfunc{wxAcceleratorTable*
}{GetAcceleratorTable
}{\void}
709 Gets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
712 \membersection{wxWindow::GetAccessible
}\label{wxwindowgetaccessible
}
714 \func{wxAccessible*
}{GetAccessible
}{\void}
716 Returns the accessible object for this window, if any.
718 See also
\helpref{wxAccessible
}{wxaccessible
}.
721 \membersection{wxWindow::GetAdjustedBestSize
}\label{wxwindowgetadjustedbestsize
}
723 \constfunc{wxSize
}{GetAdjustedBestSize
}{\void}
725 This method is deprecated, use
\helpref{GetEffectiveMinSize
}{wxwindowgeteffectiveminsize
}
729 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
731 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
733 Returns the background colour of the window.
737 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
738 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
739 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
}
741 \membersection{wxWindow::GetBackgroundStyle
}\label{wxwindowgetbackgroundstyle
}
743 \constfunc{virtual wxBackgroundStyle
}{GetBackgroundStyle
}{\void}
745 Returns the background style of the window. The background style indicates
746 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
747 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
748 application to implement (wxBG
\_STYLE\_CUSTOM).
750 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
751 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
755 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
756 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
757 \helpref{wxWindow::SetBackgroundStyle
}{wxwindowsetbackgroundstyle
}
759 \membersection{wxWindow::GetEffectiveMinSize
}\label{wxwindowgeteffectiveminsize
}
761 \constfunc{wxSize
}{GetEffectiveMinSize
}{\void}
763 Merges the window's best size into the min size and returns the
764 result. This is the value used by sizers to determine the appropriate
765 ammount of sapce to allocate for the widget.
769 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
770 \helpref{wxWindow::SetInitialSize
}{wxwindowsetinitialsize
}
773 \membersection{wxWindow::GetBestSize
}\label{wxwindowgetbestsize
}
775 \constfunc{wxSize
}{GetBestSize
}{\void}
777 This functions returns the best acceptable minimal size for the window. For
778 example, for a static control, it will be the minimal size such that the
779 control label is not truncated. For windows containing subwindows (typically
780 \helpref{wxPanel
}{wxpanel
}), the size returned by this function will be the
781 same as the size the window would have had after calling
782 \helpref{Fit
}{wxwindowfit
}.
785 \membersection{wxWindow::GetCapture
}\label{wxwindowgetcapture
}
787 \func{static wxWindow *
}{GetCapture
}{\void}
789 Returns the currently captured window.
793 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
794 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
795 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
796 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
797 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
800 \membersection{wxWindow::GetCaret
}\label{wxwindowgetcaret
}
802 \constfunc{wxCaret *
}{GetCaret
}{\void}
804 Returns the
\helpref{caret
}{wxcaret
} associated with the window.
807 \membersection{wxWindow::GetCharHeight
}\label{wxwindowgetcharheight
}
809 \constfunc{virtual int
}{GetCharHeight
}{\void}
811 Returns the character height for this window.
814 \membersection{wxWindow::GetCharWidth
}\label{wxwindowgetcharwidth
}
816 \constfunc{virtual int
}{GetCharWidth
}{\void}
818 Returns the average character width for this window.
821 \membersection{wxWindow::GetChildren
}\label{wxwindowgetchildren
}
823 \func{wxWindowList\&
}{GetChildren
}{\void}
825 \constfunc{const wxWindowList\&
}{GetChildren
}{\void}
827 Returns a reference to the list of the window's children.
\texttt{wxWindowList
}
828 is a type-safe
\helpref{wxList
}{wxlist
}-like class whose elements are of type
832 \membersection{wxWindow::GetClassDefaultAttributes
}\label{wxwindowgetclassdefaultattributes
}
834 \func{static wxVisualAttributes
}{GetClassDefaultAttributes
}{\param{wxWindowVariant
}{ variant =
\texttt{wxWINDOW
\_VARIANT\_NORMAL}}}
836 Returns the default font and colours which are used by the control. This is
837 useful if you want to use the same font or colour in your own control as in a
838 standard control -- which is a much better idea than hard coding specific
839 colours or fonts which might look completely out of place on the users
840 system, especially if it uses themes.
842 The
\arg{variant
} parameter is only relevant under Mac currently and is
843 ignore under other platforms. Under Mac, it will change the size of the
844 returned font. See
\helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}
847 This static method is ``overridden'' in many derived classes and so calling,
848 for example,
\helpref{wxButton
}{wxbutton
}::GetClassDefaultAttributes() will typically
849 return the values appropriate for a button which will be normally different
850 from those returned by, say,
\helpref{wxListCtrl
}{wxlistctrl
}::GetClassDefaultAttributes().
852 The
\texttt{wxVisualAttributes
} structure has at least the fields
853 \texttt{font
},
\texttt{colFg
} and
\texttt{colBg
}. All of them may be invalid
854 if it was not possible to determine the default control appearance or,
855 especially for the background colour, if the field doesn't make sense as is
856 the case for
\texttt{colBg
} for the controls with themed background.
860 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
863 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
865 \constfunc{void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
867 \perlnote{In wxPerl this method takes no parameter and returns
868 a
2-element list
{\tt (width, height)
}.
}
870 \constfunc{wxSize
}{GetClientSize
}{\void}
872 Returns the size of the window `client area' in pixels. The client area is the
873 area which may be drawn on by the programmer, excluding title bar, border,
876 \wxheading{Parameters
}
878 \docparam{width
}{Receives the client width in pixels.
}
880 \docparam{height
}{Receives the client height in pixels.
}
882 \pythonnote{In place of a single overloaded method name, wxPython
883 implements the following methods:
\par
884 \indented{2cm
}{\begin{twocollist
}
885 \twocolitem{{\bf GetClientSizeTuple()
}}{Returns a
2-tuple of (width, height)
}
886 \twocolitem{{\bf GetClientSize()
}}{Returns a wxSize object
}
892 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
893 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
897 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
899 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
901 Returns a pointer to the window's layout constraints, or NULL if there are none.
904 \membersection{wxWindow::GetContainingSizer
}\label{wxwindowgetcontainingsizer
}
906 \constfunc{const wxSizer *
}{GetContainingSizer
}{\void}
908 Return the sizer that this window is a member of, if any, otherwise
912 \membersection{wxWindow::GetCursor
}\label{wxwindowgetcursor
}
914 \constfunc{const wxCursor\&
}{GetCursor
}{\void}
916 Return the cursor associated with this window.
920 \helpref{wxWindow::SetCursor
}{wxwindowsetcursor
}
923 \membersection{wxWindow::GetDefaultAttributes
}\label{wxwindowgetdefaultattributes
}
925 \constfunc{virtual wxVisualAttributes
}{GetDefaultAttributes
}{\void}
927 Currently this is the same as calling
928 \helpref{GetClassDefaultAttributes
}{wxwindowgetclassdefaultattributes
}(
\helpref{GetWindowVariant
}{wxwindowgetwindowvariant
}()).
930 One advantage of using this function compared to the static version is that
931 the call is automatically dispatched to the correct class (as usual with
932 virtual functions) and you don't have to specify the class name explicitly.
934 The other one is that in the future this function could return different
935 results, for example it might return a different font for an ``Ok'' button
936 than for a generic button if the users GUI is configured to show such buttons
937 in bold font. Of course, the down side is that it is impossible to call this
938 function without actually having an object to apply it to whereas the static
939 version can be used without having to create an object first.
942 \membersection{wxWindow::GetDropTarget
}\label{wxwindowgetdroptarget
}
944 \constfunc{wxDropTarget*
}{GetDropTarget
}{\void}
946 Returns the associated drop target, which may be NULL.
950 \helpref{wxWindow::SetDropTarget
}{wxwindowsetdroptarget
},
951 \helpref{Drag and drop overview
}{wxdndoverview
}
954 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
956 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
958 Returns the event handler for this window. By default, the window is its
963 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
964 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
965 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
966 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
967 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
970 \membersection{wxWindow::GetExtraStyle
}\label{wxwindowgetextrastyle
}
972 \constfunc{long
}{GetExtraStyle
}{\void}
974 Returns the extra style bits for the window.
977 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
979 \constfunc{wxFont
}{GetFont
}{\void}
981 Returns the font for this window.
985 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
988 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
990 \func{virtual wxColour
}{GetForegroundColour
}{\void}
992 Returns the foreground colour of the window.
996 The interpretation of foreground colour is open to interpretation according
997 to the window class; it may be the text colour or other colour, or it may not
1000 \wxheading{See also
}
1002 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
1003 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
1004 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
1007 \membersection{wxWindow::GetGrandParent
}\label{wxwindowgetgrandparent
}
1009 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
1011 Returns the grandparent of a window, or NULL if there isn't one.
1014 \membersection{wxWindow::GetHandle
}\label{wxwindowgethandle
}
1016 \constfunc{void*
}{GetHandle
}{\void}
1018 Returns the platform-specific handle of the physical window. Cast it to an appropriate
1019 handle, such as
{\bf HWND
} for Windows,
{\bf Widget
} for Motif,
{\bf GtkWidget
} for GTK or
{\bf WinHandle
} for PalmOS.
1021 \pythonnote{This method will return an integer in wxPython.
}
1023 \perlnote{This method will return an integer in wxPerl.
}
1026 \membersection{wxWindow::GetHelpTextAtPoint
}\label{wxwindowgethelptextatpoint
}
1028 \constfunc{virtual wxString
}{GetHelpTextAtPoint
}{\param{const wxPoint &
}{point
},
\param{wxHelpEvent::Origin
}{origin
}}
1030 Gets the help text to be used as context-sensitive help for this window. This
1031 method should be overridden if the help message depends on the position inside
1032 the window, otherwise
\helpref{GetHelpText
}{wxwindowgethelptext
} can be used.
1034 \wxheading{Parameters
}
1036 \docparam{point
}{Coordinates of the mouse at the moment of help event emission.
}
1038 \docparam{origin
}{Help event origin, see also
\helpref{wxHelpEvent::GetOrigin
}{wxhelpeventgetorigin
}.
}
1043 \membersection{wxWindow::GetHelpText
}\label{wxwindowgethelptext
}
1045 \constfunc{virtual wxString
}{GetHelpText
}{\void}
1047 Gets the help text to be used as context-sensitive help for this window.
1049 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
1050 and not in the window object itself.
1052 \wxheading{See also
}
1054 \helpref{SetHelpText
}{wxwindowsethelptext
},
\helpref{GetHelpTextAtPoint
}{wxwindowgethelptextatpoint
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
1057 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
1059 \constfunc{int
}{GetId
}{\void}
1061 Returns the identifier of the window.
1065 Each window has an integer identifier. If the application has not provided one
1066 (or the default wxID
\_ANY) an unique identifier with a negative value will be generated.
1068 \wxheading{See also
}
1070 \helpref{wxWindow::SetId
}{wxwindowsetid
},
\rtfsp
1071 \helpref{Window identifiers
}{windowids
}
1074 \membersection{wxWindow::GetLabel
}\label{wxwindowgetlabel
}
1076 \constfunc{virtual wxString
}{GetLabel
}{\void}
1078 Generic way of getting a label from any window, for
1079 identification purposes.
1083 The interpretation of this function differs from class to class.
1084 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
1085 the button text. This function can be useful for meta-programs (such as testing
1086 tools or special-needs access programs) which need to identify windows
1089 \membersection{wxWindow::GetMaxSize
}\label{wxwindowgetmaxsize
}
1091 \constfunc{wxSize
}{GetMaxSize
}{\void}
1093 Returns the maximum size of the window, an indication to the sizer layout mechanism
1094 that this is the maximum possible size.
1096 \membersection{wxWindow::GetMinSize
}\label{wxwindowgetminsize
}
1098 \constfunc{virtual wxSize
}{GetMinSize
}{\void}
1100 Returns the minimum size of the window, an indication to the sizer layout mechanism
1101 that this is the minimum required size. It normally just returns the value set
1102 by
\helpref{SetMinSize
}{wxwindowsetminsize
}, but it can be overridden to do the
1103 calculation on demand.
1105 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
1107 \constfunc{virtual wxString
}{GetName
}{\void}
1109 Returns the window's name.
1113 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
1114 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
1116 \wxheading{See also
}
1118 \helpref{wxWindow::SetName
}{wxwindowsetname
}
1121 \membersection{wxWindow::GetParent
}\label{wxwindowgetparent
}
1123 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
1125 Returns the parent of the window, or NULL if there is no parent.
1128 \membersection{wxWindow::GetPosition
}\label{wxwindowgetposition
}
1130 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
1132 \constfunc{wxPoint
}{GetPosition
}{\void}
1134 This gets the position of the window in pixels, relative to the parent window
1135 for the child windows or relative to the display origin for the top level
1138 \wxheading{Parameters
}
1140 \docparam{x
}{Receives the x position of the window if non-
\NULL.
}
1142 \docparam{y
}{Receives the y position of the window if non-
\NULL.
}
1144 \pythonnote{In place of a single overloaded method name, wxPython
1145 implements the following methods:
\par
1146 \indented{2cm
}{\begin{twocollist
}
1147 \twocolitem{{\bf GetPosition()
}}{Returns a wxPoint
}
1148 \twocolitem{{\bf GetPositionTuple()
}}{Returns a tuple (x, y)
}
1152 \perlnote{In wxPerl there are two methods instead of a single overloaded
1154 \indented{2cm
}{\begin{twocollist
}
1155 \twocolitem{{\bf GetPosition()
}}{Returns a Wx::Point
}
1156 \twocolitem{{\bf GetPositionXY()
}}{Returns a
2-element list
1162 \wxheading{See also
}
1164 \helpref{GetScreenPosition
}{wxwindowgetscreenposition
}
1167 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
1169 \constfunc{virtual wxRect
}{GetRect
}{\void}
1171 Returns the size and position of the window as a
\helpref{wxRect
}{wxrect
} object.
1173 \wxheading{See also
}
1175 \helpref{GetScreenRect
}{wxwindowgetscreenrect
}
1178 \membersection{wxWindow::GetScreenPosition
}\label{wxwindowgetscreenposition
}
1180 \constfunc{virtual void
}{GetScreenPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
1182 \constfunc{wxPoint
}{GetScreenPosition
}{\void}
1184 Returns the window position in screen coordinates, whether the window is a
1185 child window or a top level one.
1187 \wxheading{Parameters
}
1189 \docparam{x
}{Receives the x position of the window on the screen if non-
\NULL.
}
1191 \docparam{y
}{Receives the y position of the window on the screen if non-
\NULL.
}
1193 \wxheading{See also
}
1195 \helpref{GetPosition
}{wxwindowgetposition
}
1198 \membersection{wxWindow::GetScreenRect
}\label{wxwindowgetscreenrect
}
1200 \constfunc{virtual wxRect
}{GetScreenRect
}{\void}
1202 Returns the size and position of the window on the screen as a
1203 \helpref{wxRect
}{wxrect
} object.
1205 \wxheading{See also
}
1207 \helpref{GetRect
}{wxwindowgetrect
}
1210 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
1212 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
1214 Returns the built-in scrollbar position.
1216 \wxheading{See also
}
1218 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1221 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
1223 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
1225 Returns the built-in scrollbar range.
1227 \wxheading{See also
}
1229 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1232 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
1234 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
1236 Returns the built-in scrollbar thumb size.
1238 \wxheading{See also
}
1240 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1243 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
1245 \constfunc{void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1247 \constfunc{wxSize
}{GetSize
}{\void}
1249 Returns the size of the entire window in pixels, including title bar, border,
1252 Note that if this window is a top-level one and it is currently minimized, the
1253 returned size is the restored window size, not the size of the window icon.
1255 \wxheading{Parameters
}
1257 \docparam{width
}{Receives the window width.
}
1259 \docparam{height
}{Receives the window height.
}
1261 \pythonnote{In place of a single overloaded method name, wxPython
1262 implements the following methods:
\par
1263 \indented{2cm
}{\begin{twocollist
}
1264 \twocolitem{{\bf GetSize()
}}{Returns a wxSize
}
1265 \twocolitem{{\bf GetSizeTuple()
}}{Returns a
2-tuple (width, height)
}
1269 \perlnote{In wxPerl there are two methods instead of a single overloaded
1271 \indented{2cm
}{\begin{twocollist
}
1272 \twocolitem{{\bf GetSize()
}}{Returns a Wx::Size
}
1273 \twocolitem{{\bf GetSizeWH()
}}{Returns a
2-element list
1274 {\tt ( width, height )
}}
1278 \wxheading{See also
}
1280 \helpref{GetClientSize
}{wxwindowgetclientsize
},
\rtfsp
1281 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
1284 \membersection{wxWindow::GetSizer
}\label{wxwindowgetsizer
}
1286 \constfunc{wxSizer *
}{GetSizer
}{\void}
1288 Return the sizer associated with the window by a previous call to
1289 \helpref{SetSizer()
}{wxwindowsetsizer
} or
{\tt NULL
}.
1292 \membersection{wxWindow::GetTextExtent
}\label{wxwindowgettextextent
}
1294 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{x
},
\param{int*
}{y
},
1295 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
1296 \param{const wxFont*
}{font = NULL
},
\param{bool
}{ use16 =
{\tt false
}}}
1298 Gets the dimensions of the string as it would be drawn on the
1299 window with the currently selected font.
1301 \wxheading{Parameters
}
1303 \docparam{string
}{String whose extent is to be measured.
}
1305 \docparam{x
}{Return value for width.
}
1307 \docparam{y
}{Return value for height.
}
1309 \docparam{descent
}{Return value for descent (optional).
}
1311 \docparam{externalLeading
}{Return value for external leading (optional).
}
1313 \docparam{font
}{Font to use instead of the current window font (optional).
}
1315 \docparam{use16
}{If
{\tt true
},
{\it string
} contains
16-bit characters. The default is
{\tt false
}.
}
1317 \pythonnote{In place of a single overloaded method name, wxPython
1318 implements the following methods:
\par
1319 \indented{2cm
}{\begin{twocollist
}
1320 \twocolitem{{\bf GetTextExtent(string)
}}{Returns a
2-tuple, (width, height)
}
1321 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)
}}{Returns a
1322 4-tuple, (width, height, descent, externalLeading)
}
1326 \perlnote{In wxPerl this method takes only the
{\tt string
} and optionally
1327 {\tt font
} parameters, and returns a
4-element list
1328 {\tt ( x, y, descent, externalLeading )
}.
}
1331 \membersection{wxWindow::GetToolTip
}\label{wxwindowgettooltip
}
1333 \constfunc{wxToolTip*
}{GetToolTip
}{\void}
1335 Get the associated tooltip or NULL if none.
1338 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
1340 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
1342 Returns the region specifying which parts of the window have been damaged. Should
1343 only be called within an
\helpref{wxPaintEvent
}{wxpaintevent
} handler.
1345 \wxheading{See also
}
1347 \helpref{wxRegion
}{wxregion
},
\rtfsp
1348 \helpref{wxRegionIterator
}{wxregioniterator
}
1351 \membersection{wxWindow::GetValidator
}\label{wxwindowgetvalidator
}
1353 \constfunc{wxValidator*
}{GetValidator
}{\void}
1355 Returns a pointer to the current validator for the window, or NULL if there is none.
1358 \membersection{wxWindow::GetVirtualSize
}\label{wxwindowgetvirtualsize
}
1360 \constfunc{void
}{GetVirtualSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1362 \constfunc{wxSize
}{GetVirtualSize
}{\void}
1364 This gets the virtual size of the window in pixels. By default it
1365 returns the client size of the window, but after a call to
1366 \helpref{SetVirtualSize
}{wxwindowsetvirtualsize
} it will return
1369 \wxheading{Parameters
}
1371 \docparam{width
}{Receives the window virtual width.
}
1373 \docparam{height
}{Receives the window virtual height.
}
1375 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
1376 \helpref{GetClientSize
}{wxwindowgetclientsize
}
1379 \membersection{wxWindow::GetWindowBorderSize
}\label{wxwindowgetwindowbordersize
}
1381 \constfunc{wxSize
}{GetWindowBorderSize
}{\void}
1383 Returns the size of the left/right and top/bottom borders of this window in x
1384 and y components of the result respectively.
1387 \membersection{wxWindow::GetWindowStyleFlag
}\label{wxwindowgetwindowstyleflag
}
1389 \constfunc{long
}{GetWindowStyleFlag
}{\void}
1391 Gets the window style that was passed to the constructor or
{\bf Create
}
1392 method.
{\bf GetWindowStyle()
} is another name for the same function.
1395 \membersection{wxWindow::GetWindowVariant
}\label{wxwindowgetwindowvariant
}
1397 \constfunc{wxWindowVariant
}{GetWindowVariant
}{\void}
1399 Returns the value previously passed to
1400 \helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}.
1403 \membersection{wxWindow::HasCapture
}\label{wxwindowhascapture
}
1405 \constfunc{virtual bool
}{HasCapture
}{\void}
1407 Returns
{\tt true
} if this window has the current mouse capture.
1409 \wxheading{See also
}
1411 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
1412 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
1413 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
1414 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
1417 \membersection{wxWindow::HasFlag
}\label{wxwindowhasflag
}
1419 \constfunc{bool
}{HasFlag
}{\param{int
}{flag
}}
1421 Returns
\texttt{true
} if the window has the given
\arg{flag
} bit set.
1424 \membersection{wxWindow::HasMultiplePages
}\label{wxwindowhasmultiplepages
}
1426 \constfunc{virtual bool
}{HasMultiplePages
}{\void}
1428 This method should be overridden to return
\texttt{true
} if this window has
1429 multiple pages. All standard class with multiple pages such as
1430 \helpref{wxNotebook
}{wxnotebook
},
\helpref{wxListbook
}{wxlistbook
} and
1431 \helpref{wxTreebook
}{wxtreebook
} already override it to return
\texttt{true
}
1432 and user-defined classes with similar behaviour should do it as well to allow
1433 the library to handle such windows appropriately.
1436 \membersection{wxWindow::HasScrollbar
}\label{wxwindowhasscrollbar
}
1438 \constfunc{virtual bool
}{HasScrollbar
}{\param{int
}{orient
}}
1440 Returns
{\tt true
} if this window has a scroll bar for this orientation.
1442 \wxheading{Parameters
}
1444 \docparam{orient
}{Orientation to check, either
{\tt wxHORIZONTAL
} or
{\tt wxVERTICAL
}.
}
1447 \membersection{wxWindow::HasTransparentBackground
}\label{wxwindowhastransparentbackground
}
1449 \constfunc{virtual bool
}{HasTransparentBackground
}{\void}
1451 Returns
\true if this window background is transparent (as, for example, for
1452 wxStaticText) and should show the parent window background.
1454 This method is mostly used internally by the library itself and you normally
1455 shouldn't have to call it. You may, however, have to override it in your
1456 wxWindow-derived class to ensure that background is painted correctly.
1459 \membersection{wxWindow::Hide
}\label{wxwindowhide
}
1461 \func{bool
}{Hide
}{\void}
1463 Equivalent to calling
\helpref{Show
}{wxwindowshow
}(
{\tt false
}).
1466 \membersection{wxWindow::InheritAttributes
}\label{wxwindowinheritattributes
}
1468 \func{void
}{InheritAttributes
}{\void}
1470 This function is (or should be, in case of custom controls) called during
1471 window creation to intelligently set up the window visual attributes, that is
1472 the font and the foreground and background colours.
1474 By ``intelligently'' the following is meant: by default, all windows use their
1475 own
\helpref{default
}{wxwindowgetclassdefaultattributes
} attributes. However
1476 if some of the parents attributes are explicitly (that is, using
1477 \helpref{SetFont
}{wxwindowsetfont
} and not
1478 \helpref{SetOwnFont
}{wxwindowsetownfont
}) changed
\emph{and
} if the
1479 corresponding attribute hadn't been explicitly set for this window itself,
1480 then this window takes the same value as used by the parent. In addition, if
1481 the window overrides
\helpref{ShouldInheritColours
}{wxwindowshouldinheritcolours
}
1482 to return
\false, the colours will not be changed no matter what and only the
1485 This rather complicated logic is necessary in order to accommodate the
1486 different usage scenarios. The most common one is when all default attributes
1487 are used and in this case, nothing should be inherited as in modern GUIs
1488 different controls use different fonts (and colours) than their siblings so
1489 they can't inherit the same value from the parent. However it was also deemed
1490 desirable to allow to simply change the attributes of all children at once by
1491 just changing the font or colour of their common parent, hence in this case we
1492 do inherit the parents attributes.
1495 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
1497 \func{void
}{InitDialog
}{\void}
1499 Sends an
{\tt wxEVT
\_INIT\_DIALOG} event, whose handler usually transfers data
1500 to the dialog via validators.
1503 \membersection{wxWindow::InvalidateBestSize
}\label{wxwindowinvalidatebestsize
}
1505 \func{void
}{InvalidateBestSize
}{\void}
1507 Resets the cached best size value so it will be recalculated the next time it is needed.
1510 \membersection{wxWindow::IsDoubleBuffered
}\label{wxwindowisdoublebuffered
}
1512 \constfunc{virtual bool
}{IsDoubleBuffered
}{\void}
1514 Returns
\true if the window contents is double-buffered by the system, i.e. if
1515 any drawing done on the window is really done on a temporary backing surface
1516 and transferred to the screen all at once later.
1518 \wxheading{See also
}
1520 \helpref{wxBufferedDC
}{wxbuffereddc
}
1523 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
1525 \constfunc{virtual bool
}{IsEnabled
}{\void}
1527 Returns
{\tt true
} if the window is enabled for input,
{\tt false
} otherwise.
1529 \wxheading{See also
}
1531 \helpref{wxWindow::Enable
}{wxwindowenable
}
1534 \membersection{wxWindow::IsExposed
}\label{wxwindowisexposed
}
1536 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
}}
1538 \constfunc{bool
}{IsExposed
}{\param{wxPoint
}{\&pt
}}
1540 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
},
\param{int
}{w
},
\param{int
}{h
}}
1542 \constfunc{bool
}{IsExposed
}{\param{wxRect
}{\&rect
}}
1544 Returns
{\tt true
} if the given point or rectangle area has been exposed since the
1545 last repaint. Call this in an paint event handler to optimize redrawing by
1546 only redrawing those areas, which have been exposed.
1548 \pythonnote{In place of a single overloaded method name, wxPython
1549 implements the following methods:
\par
1550 \indented{2cm
}{\begin{twocollist
}
1551 \twocolitem{{\bf IsExposed(x,y, w=
0,h=
0)
}}{}
1552 \twocolitem{{\bf IsExposedPoint(pt)
}}{}
1553 \twocolitem{{\bf IsExposedRect(rect)
}}{}
1557 \membersection{wxWindow::IsFrozen
}\label{wxwindowisfrozen
}
1559 \constfunc{virtual bool
}{IsFrozen
}{\void}
1561 Returns
\true if the window is currently frozen by a call to
1562 \helpref{Freeze()
}{wxwindowfreeze
}.
1564 \wxheading{See also
}
1566 \helpref{Thaw()
}{wxwindowthaw
}
1569 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
1571 \constfunc{virtual bool
}{IsRetained
}{\void}
1573 Returns
{\tt true
} if the window is retained,
{\tt false
} otherwise.
1577 Retained windows are only available on X platforms.
1580 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
1582 \constfunc{virtual bool
}{IsShown
}{\void}
1584 Returns
{\tt true
} if the window is shown,
{\tt false
} if it has been hidden.
1586 \wxheading{See also
}
1588 \helpref{wxWindow::IsShownOnScreen
}{wxwindowisshownonscreen
}
1591 \membersection{wxWindow::IsShownOnScreen
}\label{wxwindowisshownonscreen
}
1593 \constfunc{virtual bool
}{IsShownOnScreen
}{\void}
1595 Returns
{\tt true
} if the window is physically visible on the screen, i.e. it
1596 is shown and all its parents up to the toplevel window are shown as well.
1598 \wxheading{See also
}
1600 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
1603 \membersection{wxWindow::IsTopLevel
}\label{wxwindowistoplevel
}
1605 \constfunc{bool
}{IsTopLevel
}{\void}
1607 Returns
{\tt true
} if the given window is a top-level one. Currently all frames and
1608 dialogs are considered to be top-level windows (even if they have a parent
1612 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
1614 \func{void
}{Layout
}{\void}
1616 Invokes the constraint-based layout algorithm or the sizer-based algorithm
1619 See
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
}: when auto
1620 layout is on, this function gets called automatically when the window is resized.
1623 \membersection{wxWindow::LineDown
}\label{wxwindowlinedown
}
1625 This is just a wrapper for
\helpref{ScrollLines
}{wxwindowscrolllines
}$(
1)$.
1628 \membersection{wxWindow::LineUp
}\label{wxwindowlineup
}
1630 This is just a wrapper for
\helpref{ScrollLines
}{wxwindowscrolllines
}$(-
1)$.
1633 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
1635 \func{void
}{Lower
}{\void}
1637 Lowers the window to the bottom of the window hierarchy (z-order).
1639 \wxheading{See also
}
1641 \helpref{Raise
}{wxwindowraise
}
1644 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
1646 \func{virtual void
}{MakeModal
}{\param{bool
}{flag
}}
1648 Disables all other windows in the application so that
1649 the user can only interact with this window.
1651 \wxheading{Parameters
}
1653 \docparam{flag
}{If
{\tt true
}, this call disables all other windows in the application so that
1654 the user can only interact with this window. If
{\tt false
}, the effect is reversed.
}
1657 \membersection{wxWindow::Move
}\label{wxwindowmove
}
1659 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
1661 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
1663 Moves the window to the given position.
1665 \wxheading{Parameters
}
1667 \docparam{x
}{Required x position.
}
1669 \docparam{y
}{Required y position.
}
1671 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
1675 Implementations of SetSize can also implicitly implement the
1676 wxWindow::Move function, which is defined in the base wxWindow class
1680 SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
1683 \wxheading{See also
}
1685 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
1687 \pythonnote{In place of a single overloaded method name, wxPython
1688 implements the following methods:
\par
1689 \indented{2cm
}{\begin{twocollist
}
1690 \twocolitem{{\bf Move(point)
}}{Accepts a wxPoint
}
1691 \twocolitem{{\bf MoveXY(x, y)
}}{Accepts a pair of integers
}
1696 \membersection{wxWindow::MoveAfterInTabOrder
}\label{wxwindowmoveafterintaborder
}
1698 \func{void
}{MoveAfterInTabOrder
}{\param{wxWindow *
}{win
}}
1700 Moves this window in the tab navigation order after the specified
\arg{win
}.
1701 This means that when the user presses
\texttt{TAB
} key on that other window,
1702 the focus switches to this window.
1704 Default tab order is the same as creation order, this function and
1705 \helpref{MoveBeforeInTabOrder()
}{wxwindowmovebeforeintaborder
} allow to change
1706 it after creating all the windows.
1708 \wxheading{Parameters
}
1710 \docparam{win
}{A sibling of this window which should precede it in tab order,
1714 \membersection{wxWindow::MoveBeforeInTabOrder
}\label{wxwindowmovebeforeintaborder
}
1716 \func{void
}{MoveBeforeInTabOrder
}{\param{wxWindow *
}{win
}}
1718 Same as
\helpref{MoveAfterInTabOrder
}{wxwindowmoveafterintaborder
} except that
1719 it inserts this window just before
\arg{win
} instead of putting it right after
1723 \membersection{wxWindow::Navigate
}\label{wxwindownavigate
}
1725 \func{bool
}{Navigate
}{\param{int
}{ flags = wxNavigationKeyEvent::IsForward
}}
1727 Does keyboard navigation from this window to another, by sending
1728 a wxNavigationKeyEvent.
1730 \wxheading{Parameters
}
1732 \docparam{flags
}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.
}
1736 You may wish to call this from a text control custom keypress handler to do the default
1737 navigation behaviour for the tab key, since the standard default behaviour for
1738 a multiline text control with the wxTE
\_PROCESS\_TAB style is to insert a tab
1739 and not navigate to the next control.
1742 \membersection{wxWindow::NextControlId
}\label{wxwindownextcontrolid
}
1744 \func{static int
}{NextControlId
}{\param{int
}{winid
}}
1746 If two controls are created consecutively using
\texttt{wxID
\_ANY} id, this
1747 function allows to retrieve the effective id of the latter control from the id
1748 of the former. This is useful for example to find the control following its
1749 \helpref{wxStaticText
}{wxstatictext
} label if only the id of or pointer to the
1750 label is available to the caller but it is known that the two controls were
1753 \wxheading{See also
}
1755 \helpref{PrevControlId
}{wxwindowprevcontrolid
}
1758 %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving
1759 %% the old docs here in case we want to move any still needed bits to
1760 %% the right location (i.e. probably the corresponding events docs)
1762 %% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
1764 %% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
1766 %% Called when a window is activated or deactivated.
1768 %% \wxheading{Parameters}
1770 %% \docparam{event}{Object containing activation information.}
1772 %% \wxheading{Remarks}
1774 %% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt true},
1775 %% otherwise it returns {\tt false} (it is being deactivated).
1777 %% \wxheading{See also}
1779 %% \helpref{wxActivateEvent}{wxactivateevent},\rtfsp
1780 %% \helpref{Event handling overview}{eventhandlingoverview}
1782 %% \membersection{wxWindow::OnChar}\label{wxwindowonchar}
1784 %% \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
1786 %% Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
1788 %% \wxheading{Parameters}
1790 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1791 %% details about this class.}
1793 %% \wxheading{Remarks}
1795 %% This member function is called in response to a keypress. To intercept this event,
1796 %% use the EVT\_CHAR macro in an event table definition. Your {\bf OnChar} handler may call this
1797 %% default function to achieve default keypress functionality.
1799 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1802 %% Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1803 %% keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1804 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1806 %% Most, but not all, windows allow keypresses to be intercepted.
1808 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1809 %% otherwise menu shortcuts may cease to work under Windows.
1811 %% \wxheading{See also}
1813 %% \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1814 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1815 %% \helpref{Event handling overview}{eventhandlingoverview}
1817 %% \membersection{wxWindow::OnCharHook}\label{wxwindowoncharhook}
1819 %% \func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
1821 %% This member is called to allow the window to intercept keyboard events
1822 %% before they are processed by child windows.
1824 %% \wxheading{Parameters}
1826 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1827 %% details about this class.}
1829 %% \wxheading{Remarks}
1831 %% This member function is called in response to a keypress, if the window is active. To intercept this event,
1832 %% use the EVT\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
1833 %% keypress, call \helpref{wxEvent::Skip}{wxeventskip} to allow default processing.
1835 %% An example of using this function is in the implementation of escape-character processing for wxDialog,
1836 %% where pressing ESC dismisses the dialog by {\bf OnCharHook} 'forging' a cancel button press event.
1838 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1841 %% This function is only relevant to top-level windows (frames and dialogs), and under
1842 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
1843 %% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
1844 %% the window won't get the event.
1846 %% \wxheading{See also}
1848 %% \helpref{wxKeyEvent}{wxkeyevent},\rtfsp
1849 %% \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1850 %% %% GD: OnXXX functions are not documented
1851 %% %%\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp
1852 %% \helpref{Event handling overview}{eventhandlingoverview}
1854 %% \membersection{wxWindow::OnCommand}\label{wxwindowoncommand}
1856 %% \func{virtual void}{OnCommand}{\param{wxEvtHandler\& }{object}, \param{wxCommandEvent\& }{event}}
1858 %% This virtual member function is called if the control does not handle the command event.
1860 %% \wxheading{Parameters}
1862 %% \docparam{object}{Object receiving the command event.}
1864 %% \docparam{event}{Command event}
1866 %% \wxheading{Remarks}
1868 %% This virtual function is provided mainly for backward compatibility. You can also intercept commands
1869 %% from child controls by using an event table, with identifiers or identifier ranges to identify
1870 %% the control(s) in question.
1872 %% \wxheading{See also}
1874 %% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1875 %% \helpref{Event handling overview}{eventhandlingoverview}
1877 %% \membersection{wxWindow::OnClose}\label{wxwindowonclose}
1879 %% \func{virtual bool}{OnClose}{\void}
1881 %% Called when the user has tried to close a a frame
1882 %% or dialog box using the window manager (X) or system menu (Windows).
1884 %% {\bf Note:} This is an obsolete function.
1885 %% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
1888 %% \wxheading{Return value}
1890 %% If {\tt true} is returned by OnClose, the window will be deleted by the system, otherwise the
1891 %% attempt will be ignored. Do not delete the window from within this handler, although
1892 %% you may delete other windows.
1894 %% \wxheading{See also}
1896 %% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
1897 %% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
1898 %% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
1899 %% \helpref{wxCloseEvent}{wxcloseevent}
1901 %% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
1903 %% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
1905 %% Called when the user has pressed a key, before it is translated into an ASCII value using other
1906 %% modifier keys that might be pressed at the same time.
1908 %% \wxheading{Parameters}
1910 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1911 %% details about this class.}
1913 %% \wxheading{Remarks}
1915 %% This member function is called in response to a key down event. To intercept this event,
1916 %% use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this
1917 %% default function to achieve default keypress functionality.
1919 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
1920 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1921 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1923 %% Most, but not all, windows allow keypresses to be intercepted.
1925 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1926 %% otherwise menu shortcuts may cease to work under Windows.
1928 %% \wxheading{See also}
1930 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1931 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1932 %% \helpref{Event handling overview}{eventhandlingoverview}
1934 %% \membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup}
1936 %% \func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}}
1938 %% Called when the user has released a key.
1940 %% \wxheading{Parameters}
1942 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1943 %% details about this class.}
1945 %% \wxheading{Remarks}
1947 %% This member function is called in response to a key up event. To intercept this event,
1948 %% use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this
1949 %% default function to achieve default keypress functionality.
1951 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
1952 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1953 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1955 %% Most, but not all, windows allow key up events to be intercepted.
1957 %% \wxheading{See also}
1959 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp
1960 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1961 %% \helpref{Event handling overview}{eventhandlingoverview}
1963 %% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
1965 %% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
1967 %% Default handler for the wxEVT\_INIT\_DIALOG event. Calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
1969 %% \wxheading{Parameters}
1971 %% \docparam{event}{Dialog initialisation event.}
1973 %% \wxheading{Remarks}
1975 %% Gives the window the default behaviour of transferring data to child controls via
1976 %% the validator that each control has.
1978 %% \wxheading{See also}
1980 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
1982 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
1984 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
1986 %% Called when a menu select is received from a menu bar: that is, the
1987 %% mouse cursor is over a menu item, but the left mouse button has not been
1990 %% \wxheading{Parameters}
1992 %% \docparam{event}{The menu highlight event. For more information, see \helpref{wxMenuEvent}{wxmenuevent}.}
1994 %% \wxheading{Remarks}
1996 %% You can choose any member function to receive
1997 %% menu select events, using the EVT\_MENU\_HIGHLIGHT macro for individual menu items or EVT\_MENU\_HIGHLIGHT\_ALL macro
1998 %% for all menu items.
2000 %% The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
2001 %% text in the first field of the status bar.
2003 %% This function was known as {\bf OnMenuSelect} in earlier versions of wxWidgets, but this was confusing
2004 %% since a selection is normally a left-click action.
2006 %% \wxheading{See also}
2008 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
2009 %% \helpref{Event handling overview}{eventhandlingoverview}
2012 %% \membersection{wxWindow::OnMouseEvent}\label{wxwindowonmouseevent}
2014 %% \func{void}{OnMouseEvent}{\param{wxMouseEvent\&}{ event}}
2016 %% Called when the user has initiated an event with the
2019 %% \wxheading{Parameters}
2021 %% \docparam{event}{The mouse event. See \helpref{wxMouseEvent}{wxmouseevent} for
2024 %% \wxheading{Remarks}
2026 %% Most, but not all, windows respond to this event.
2028 %% To intercept this event, use the EVT\_MOUSE\_EVENTS macro in an event table definition, or individual
2029 %% mouse event macros such as EVT\_LEFT\_DOWN.
2031 %% \wxheading{See also}
2033 %% \helpref{wxMouseEvent}{wxmouseevent},\rtfsp
2034 %% \helpref{Event handling overview}{eventhandlingoverview}
2036 %% \membersection{wxWindow::OnMove}\label{wxwindowonmove}
2038 %% \func{void}{OnMove}{\param{wxMoveEvent\& }{event}}
2040 %% Called when a window is moved.
2042 %% \wxheading{Parameters}
2044 %% \docparam{event}{The move event. For more information, see \helpref{wxMoveEvent}{wxmoveevent}.}
2046 %% \wxheading{Remarks}
2048 %% Use the EVT\_MOVE macro to intercept move events.
2050 %% \wxheading{Remarks}
2052 %% Not currently implemented.
2054 %% \wxheading{See also}
2056 %% \helpref{wxMoveEvent}{wxmoveevent},\rtfsp
2057 %% \helpref{wxFrame::OnSize}{wxframeonsize},\rtfsp
2058 %% \helpref{Event handling overview}{eventhandlingoverview}
2060 %% \membersection{wxWindow::OnPaint}\label{wxwindowonpaint}
2062 %% \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
2064 %% Sent to the event handler when the window must be refreshed.
2066 %% \wxheading{Parameters}
2068 %% \docparam{event}{Paint event. For more information, see \helpref{wxPaintEvent}{wxpaintevent}.}
2070 %% \wxheading{Remarks}
2072 %% Use the EVT\_PAINT macro in an event table definition to intercept paint events.
2074 %% Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
2075 %% even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
2081 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2083 %% wxPaintDC dc(this);
2085 %% DrawMyDocument(dc);
2090 %% You can optimize painting by retrieving the rectangles
2091 %% that have been damaged and only repainting these. The rectangles are in
2092 %% terms of the client area, and are unscrolled, so you will need to do
2093 %% some calculations using the current view position to obtain logical,
2096 %% Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
2100 %% // Called when window needs to be repainted.
2101 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2103 %% wxPaintDC dc(this);
2105 %% // Find Out where the window is scrolled to
2106 %% int vbX,vbY; // Top left corner of client
2107 %% GetViewStart(&vbX,&vbY);
2109 %% int vX,vY,vW,vH; // Dimensions of client area in pixels
2110 %% wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
2119 %% // Alternatively we can do this:
2121 %% // upd.GetRect(&rect);
2123 %% // Repaint this rectangle
2132 %% \wxheading{See also}
2134 %% \helpref{wxPaintEvent}{wxpaintevent},\rtfsp
2135 %% \helpref{wxPaintDC}{wxpaintdc},\rtfsp
2136 %% \helpref{Event handling overview}{eventhandlingoverview}
2138 %% \membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
2140 %% \func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
2142 %% Called when a scroll window event is received from one of the window's built-in scrollbars.
2144 %% \wxheading{Parameters}
2146 %% \docparam{event}{Command event. Retrieve the new scroll position by
2147 %% calling \helpref{wxScrollEvent::GetPosition}{wxscrolleventgetposition}, and the
2148 %% scrollbar orientation by calling \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}.}
2150 %% \wxheading{Remarks}
2152 %% Note that it is not possible to distinguish between horizontal and vertical scrollbars
2153 %% until the function is executing (you can't have one function for vertical, another
2154 %% for horizontal events).
2156 %% \wxheading{See also}
2158 %% \helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp
2159 %% \helpref{Event handling overview}{eventhandlingoverview}
2161 %% \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus}
2163 %% \func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
2165 %% Called when a window's focus is being set.
2167 %% \wxheading{Parameters}
2169 %% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
2171 %% \wxheading{Remarks}
2173 %% To intercept this event, use the macro EVT\_SET\_FOCUS in an event table definition.
2175 %% Most, but not all, windows respond to this event.
2177 %% \wxheading{See also}
2179 %% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
2180 %% \helpref{Event handling overview}{eventhandlingoverview}
2182 %% \membersection{wxWindow::OnSize}\label{wxwindowonsize}
2184 %% \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
2186 %% Called when the window has been resized. This is not a virtual function; you should
2187 %% provide your own non-virtual OnSize function and direct size events to it using EVT\_SIZE
2188 %% in an event table definition.
2190 %% \wxheading{Parameters}
2192 %% \docparam{event}{Size event. For more information, see \helpref{wxSizeEvent}{wxsizeevent}.}
2194 %% \wxheading{Remarks}
2196 %% You may wish to use this for frames to resize their child windows as appropriate.
2198 %% Note that the size passed is of
2199 %% the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
2200 %% used by the application.
2202 %% When a window is resized, usually only a small part of the window is damaged and you
2203 %% may only need to repaint that area. However, if your drawing depends on the size of the window,
2204 %% you may need to clear the DC explicitly and repaint the whole window. In which case, you
2205 %% may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
2207 %% \wxheading{See also}
2209 %% \helpref{wxSizeEvent}{wxsizeevent},\rtfsp
2210 %% \helpref{Event handling overview}{eventhandlingoverview}
2212 %% \membersection{wxWindow::OnSysColourChanged}\label{wxwindowonsyscolourchanged}
2214 %% \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}}
2216 %% Called when the user has changed the system colours. Windows only.
2218 %% \wxheading{Parameters}
2220 %% \docparam{event}{System colour change event. For more information, see \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}.}
2222 %% \wxheading{See also}
2224 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
2225 %% \helpref{Event handling overview}{eventhandlingoverview}
2228 \membersection{wxWindow::OnInternalIdle
}\label{wxwindowoninternalidle
}
2230 \func{virtual void
}{OnInternalIdle
}{\void}
2232 This virtual function is normally only used internally, but
2233 sometimes an application may need it to implement functionality
2234 that should not be disabled by an application defining an OnIdle
2235 handler in a derived class.
2237 This function may be used to do delayed painting, for example,
2238 and most implementations call
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
2239 in order to send update events to the window in idle time.
2242 \membersection{wxWindow::PageDown
}\label{wxwindowpagedown
}
2244 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(
1)$.
2247 \membersection{wxWindow::PageUp
}\label{wxwindowpageup
}
2249 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(-
1)$.
2252 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
2254 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler =
{\tt false
}}}
2256 Removes and returns the top-most event handler on the event handler stack.
2258 \wxheading{Parameters
}
2260 \docparam{deleteHandler
}{If this is
{\tt true
}, the handler will be deleted after it is removed. The
2261 default value is
{\tt false
}.
}
2263 \wxheading{See also
}
2265 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2266 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2267 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2268 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2269 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
2272 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
2274 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{const wxPoint\&
}{pos = wxDefaultPosition
}}
2276 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
2278 Pops up the given menu at the specified coordinates, relative to this
2279 window, and returns control when the user has dismissed the menu. If a
2280 menu item is selected, the corresponding menu event is generated and will be
2281 processed as usually. If the coordinates are not specified, current mouse
2282 cursor position is used.
2284 \wxheading{Parameters
}
2286 \docparam{menu
}{Menu to pop up.
}
2288 \docparam{pos
}{The position where the menu will appear.
}
2290 \docparam{x
}{Required x position for the menu to appear.
}
2292 \docparam{y
}{Required y position for the menu to appear.
}
2294 \wxheading{See also
}
2296 \helpref{wxMenu
}{wxmenu
}
2300 Just before the menu is popped up,
\helpref{wxMenu::UpdateUI
}{wxmenuupdateui
}
2301 is called to ensure that the menu items are in the correct state. The menu does
2302 not get deleted by the window.
2304 It is recommended to not explicitly specify coordinates when calling PopupMenu
2305 in response to mouse click, because some of the ports (namely, wxGTK) can do
2306 a better job of positioning the menu in that case.
2308 \pythonnote{In place of a single overloaded method name, wxPython
2309 implements the following methods:
\par
2310 \indented{2cm
}{\begin{twocollist
}
2311 \twocolitem{{\bf PopupMenu(menu, point)
}}{Specifies position with a wxPoint
}
2312 \twocolitem{{\bf PopupMenuXY(menu, x, y)
}}{Specifies position with two integers (x, y)
}
2317 \membersection{wxWindow::PrevControlId
}\label{wxwindowprevcontrolid
}
2319 \func{static int
}{PrevControlId
}{\param{int
}{winid
}}
2321 This is similar to
\helpref{NextControlId
}{wxwindownextcontrolid
} but returns
2322 the id of the control created just before the one with the given
\arg{winid
}.
2325 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
2327 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2329 Pushes this event handler onto the event stack for the window.
2331 \wxheading{Parameters
}
2333 \docparam{handler
}{Specifies the handler to be pushed.
}
2337 An event handler is an object that is capable of processing the events
2338 sent to a window. By default, the window is its own event handler, but
2339 an application may wish to substitute another, for example to allow
2340 central implementation of event-handling for a variety of different
2343 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
2344 an application to set up a chain of event handlers, where an event not handled by one event handler is
2345 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
2346 remove the event handler.
2348 \wxheading{See also
}
2350 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2351 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2352 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2353 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2354 \helpref{wxEvtHandler
}{wxevthandler
}
2357 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
2359 \func{void
}{Raise
}{\void}
2361 Raises the window to the top of the window hierarchy (z-order).
2363 In current version of wxWidgets this works both for managed and child windows.
2365 \wxheading{See also
}
2367 \helpref{Lower
}{wxwindowlower
}
2370 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
2372 \func{virtual void
}{Refresh
}{\param{bool
}{ eraseBackground =
{\tt true
}},
\param{const wxRect*
}{rect = NULL
}}
2374 Causes this window, and all of its children recursively (except under wxGTK1
2375 where this is not implemented), to be repainted. Note that repainting doesn't
2376 happen immediately but only during the next event loop iteration, if you need
2377 to update the window immediately you should use
\helpref{Update
}{wxwindowupdate
}
2380 \wxheading{Parameters
}
2382 \docparam{eraseBackground
}{If
{\tt true
}, the background will be
2385 \docparam{rect
}{If non-NULL, only the given rectangle will
2386 be treated as damaged.
}
2388 \wxheading{See also
}
2390 \helpref{wxWindow::RefreshRect
}{wxwindowrefreshrect
}
2393 \membersection{wxWindow::RefreshRect
}\label{wxwindowrefreshrect
}
2395 \func{void
}{RefreshRect
}{\param{const wxRect\&
}{rect
},
\param{bool
}{eraseBackground =
\true}}
2397 Redraws the contents of the given rectangle: only the area inside it will be
2400 This is the same as
\helpref{Refresh
}{wxwindowrefresh
} but has a nicer syntax
2401 as it can be called with a temporary wxRect object as argument like this
2402 \texttt{RefreshRect(wxRect(x, y, w, h))
}.
2405 \membersection{wxWindow::RegisterHotKey
}\label{wxwindowregisterhotkey
}
2407 \func{bool
}{RegisterHotKey
}{\param{int
}{ hotkeyId
},
\param{int
}{ modifiers
},
\param{int
}{ virtualKeyCode
}}
2409 Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window
2410 will receive a hotkey event. It will receive the event even if the application is in the background
2411 and does not have the input focus because the user is working with some other application.
2413 \wxheading{Parameters
}
2415 \docparam{hotkeyId
}{Numeric identifier of the hotkey. For applications this must be between
0 and
0xBFFF. If
2416 this function is called from a shared DLL, it must be a system wide unique identifier between
0xC000 and
0xFFFF.
2417 This is a MSW specific detail.
}
2419 \docparam{modifiers
}{A bitwise combination of
{\tt wxMOD
\_SHIFT},
{\tt wxMOD
\_CONTROL},
{\tt wxMOD
\_ALT}
2420 or
{\tt wxMOD
\_WIN} specifying the modifier keys that have to be pressed along with the key.
}
2422 \docparam{virtualKeyCode
}{The virtual key code of the hotkey.
}
2424 \wxheading{Return value
}
2426 {\tt true
} if the hotkey was registered successfully.
{\tt false
} if some other application already registered a
2427 hotkey with this modifier/virtualKeyCode combination.
2431 Use EVT
\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
2432 This function is currently only implemented under Windows. It is used
2433 in the
\helpref{Windows CE port
}{wxwince
} for detecting hardware button presses.
2435 \wxheading{See also
}
2437 \helpref{wxWindow::UnregisterHotKey
}{wxwindowunregisterhotkey
}
2440 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
2442 \func{virtual void
}{ReleaseMouse
}{\void}
2444 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
2446 \wxheading{See also
}
2448 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
2449 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
2450 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
2451 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
2452 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
2455 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
2457 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
2459 Removes a child window. This is called automatically by window deletion
2460 functions so should not be required by the application programmer.
2462 Notice that this function is mostly internal to wxWidgets and shouldn't be
2463 called by the user code.
2465 \wxheading{Parameters
}
2467 \docparam{child
}{Child window to remove.
}
2470 \membersection{wxWindow::RemoveEventHandler
}\label{wxwindowremoveeventhandler
}
2472 \func{bool
}{RemoveEventHandler
}{\param{wxEvtHandler *
}{handler
}}
2474 Find the given
{\it handler
} in the windows event handler chain and remove (but
2475 not delete) it from it.
2477 \wxheading{Parameters
}
2479 \docparam{handler
}{The event handler to remove, must be non-
{\tt NULL
} and
2480 must be present in this windows event handlers chain
}
2482 \wxheading{Return value
}
2484 Returns
{\tt true
} if it was found and
{\tt false
} otherwise (this also results
2485 in an assert failure so this function should only be called when the
2486 handler is supposed to be there).
2488 \wxheading{See also
}
2490 \helpref{PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2491 \helpref{PopEventHandler
}{wxwindowpopeventhandler
}
2494 \membersection{wxWindow::Reparent
}\label{wxwindowreparent
}
2496 \func{virtual bool
}{Reparent
}{\param{wxWindow*
}{newParent
}}
2498 Reparents the window, i.e the window will be removed from its
2499 current parent window (e.g. a non-standard toolbar in a wxFrame)
2500 and then re-inserted into another.
2502 \wxheading{Parameters
}
2504 \docparam{newParent
}{New parent.
}
2507 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
2509 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
2511 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
2513 Converts from screen to client window coordinates.
2515 \wxheading{Parameters
}
2517 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
2519 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
2521 \docparam{pt
}{The screen position for the second form of the function.
}
2523 \pythonnote{In place of a single overloaded method name, wxPython
2524 implements the following methods:
\par
2525 \indented{2cm
}{\begin{twocollist
}
2526 \twocolitem{{\bf ScreenToClient(point)
}}{Accepts and returns a wxPoint
}
2527 \twocolitem{{\bf ScreenToClientXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
2532 \membersection{wxWindow::ScrollLines
}\label{wxwindowscrolllines
}
2534 \func{virtual bool
}{ScrollLines
}{\param{int
}{lines
}}
2536 Scrolls the window by the given number of lines down (if
{\it lines
} is
2539 \wxheading{Return value
}
2541 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2542 on top/bottom and nothing was done.
2546 This function is currently only implemented under MSW and wxTextCtrl under
2547 wxGTK (it also works for wxScrolledWindow derived classes under all
2550 \wxheading{See also
}
2552 \helpref{ScrollPages
}{wxwindowscrollpages
}
2555 \membersection{wxWindow::ScrollPages
}\label{wxwindowscrollpages
}
2557 \func{virtual bool
}{ScrollPages
}{\param{int
}{pages
}}
2559 Scrolls the window by the given number of pages down (if
{\it pages
} is
2562 \wxheading{Return value
}
2564 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2565 on top/bottom and nothing was done.
2569 This function is currently only implemented under MSW and wxGTK.
2571 \wxheading{See also
}
2573 \helpref{ScrollLines
}{wxwindowscrolllines
}
2576 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
2578 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
2580 Physically scrolls the pixels in the window and move child windows accordingly.
2582 \wxheading{Parameters
}
2584 \docparam{dx
}{Amount to scroll horizontally.
}
2586 \docparam{dy
}{Amount to scroll vertically.
}
2588 \docparam{rect
}{Rectangle to scroll, if it is
\NULL, the whole window is
2589 scrolled (this is always the case under wxGTK which doesn't support this
2594 Note that you can often use
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2595 instead of using this function directly.
2598 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
2600 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
2602 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
2605 \membersection{wxWindow::SetAccessible
}\label{wxwindowsetaccessible
}
2607 \func{void
}{SetAccessible
}{\param{wxAccessible*
}{ accessible
}}
2609 Sets the accessible for this window. Any existing accessible for this window
2610 will be deleted first, if not identical to
{\it accessible
}.
2612 See also
\helpref{wxAccessible
}{wxaccessible
}.
2615 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
2617 \func{void
}{SetAutoLayout
}{\param{bool
}{ autoLayout
}}
2619 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
2620 be called automatically when the window is resized. Please note that this only
2621 happens for the windows usually used to contain children, namely
2622 \helpref{wxPanel
}{wxpanel
} and
\helpref{wxTopLevelWindow
}{wxtoplevelwindow
}
2623 (and the classes deriving from them).
2625 This method is called implicitly by
2626 \helpref{wxWindow::SetSizer
}{wxwindowsetsizer
} but if you use
2627 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
} you should call it
2628 manually or otherwise the window layout won't be correctly updated when its
2631 \wxheading{Parameters
}
2633 \docparam{autoLayout
}{Set this to
\true if you wish the Layout function to be
2634 called automatically when the window is resized.
}
2636 \wxheading{See also
}
2638 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
2641 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
2643 \func{virtual bool
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
2645 Sets the background colour of the window.
2647 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
2648 explanation of the difference between this method and
2649 \helpref{SetOwnBackgroundColour
}{wxwindowsetownbackgroundcolour
}.
2651 \wxheading{Parameters
}
2653 \docparam{colour
}{The colour to be used as the background colour, pass
2654 {\tt wxNullColour
} to reset to the default colour.
}
2658 The background colour is usually painted by the default
\rtfsp
2659 \helpref{wxEraseEvent
}{wxeraseevent
} event handler function
2660 under Windows and automatically under GTK.
2662 Note that setting the background colour does not cause an immediate refresh, so you
2663 may wish to call
\helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
} or
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} after
2664 calling this function.
2666 Using this function will disable attempts to use themes for this
2667 window, if the system supports them. Use with care since usually the
2668 themes represent the appearance chosen by the user to be used for all
2669 applications on the system.
2672 \wxheading{See also
}
2674 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
2675 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
2676 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2677 \helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
},
\rtfsp
2678 \helpref{wxWindow::Refresh
}{wxwindowrefresh
},
\rtfsp
2679 \helpref{wxEraseEvent
}{wxeraseevent
}
2681 \membersection{wxWindow::SetBackgroundStyle
}\label{wxwindowsetbackgroundstyle
}
2683 \func{virtual void
}{SetBackgroundStyle
}{\param{wxBackgroundStyle
}{ style
}}
2685 Sets the background style of the window. The background style indicates
2686 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
2687 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
2688 application to implement (wxBG
\_STYLE\_CUSTOM).
2690 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
2691 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
2693 \wxheading{See also
}
2695 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2696 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2697 \helpref{wxWindow::GetBackgroundStyle
}{wxwindowgetbackgroundstyle
}
2700 \membersection{wxWindow::SetInitialSize
}\label{wxwindowsetinitialsize
}
2702 \func{void
}{SetInitialSize
}{\param{const wxSize\&
}{size = wxDefaultSize
}}
2704 A
{\it smart
} SetSize that will fill in default size components with the
2705 window's
{\it best
} size values. Also sets the window's minsize to
2706 the value passed in for use with sizers. This means that if a full or
2707 partial size is passed to this function then the sizers will use that
2708 size instead of the results of GetBestSize to determine the minimum
2709 needs of the window for layout.
2711 Most controls will use this to set their initial size, and their min
2712 size to the passed in value (if any.)
2715 \wxheading{See also
}
2717 \helpref{wxWindow::SetSize
}{wxwindowsetsize
},
\rtfsp
2718 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
2719 \helpref{wxWindow::GetEffectiveMinSize
}{wxwindowgeteffectiveminsize
}
2722 \membersection{wxWindow::SetCaret
}\label{wxwindowsetcaret
}
2724 \constfunc{void
}{SetCaret
}{\param{wxCaret *
}{caret
}}
2726 Sets the
\helpref{caret
}{wxcaret
} associated with the window.
2729 \membersection{wxWindow::SetClientSize
}\label{wxwindowsetclientsize
}
2731 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
2733 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
2735 This sets the size of the window client area in pixels. Using this function to size a window
2736 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
2737 worry about what dimensions the border or title bar have when trying to fit the window
2738 around panel items, for example.
2740 \wxheading{Parameters
}
2742 \docparam{width
}{The required client area width.
}
2744 \docparam{height
}{The required client area height.
}
2746 \docparam{size
}{The required client size.
}
2748 \pythonnote{In place of a single overloaded method name, wxPython
2749 implements the following methods:
\par
2750 \indented{2cm
}{\begin{twocollist
}
2751 \twocolitem{{\bf SetClientSize(size)
}}{Accepts a wxSize
}
2752 \twocolitem{{\bf SetClientSizeWH(width, height)
}}{}
2757 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
2759 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
2761 Sets the window to have the given layout constraints. The window
2762 will then own the object, and will take care of its deletion.
2763 If an existing layout constraints object is already owned by the
2764 window, it will be deleted.
2766 \wxheading{Parameters
}
2768 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
2773 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
2774 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
2775 explicitly. When setting both a wxLayoutConstraints and a
\helpref{wxSizer
}{wxsizer
}, only the
2776 sizer will have effect.
2778 \membersection{wxWindow::SetContainingSizer
}\label{wxwindowsetcontainingsizer
}
2780 \func{void
}{SetContainingSizer
}{\param{wxSizer*
}{sizer
}}
2782 This normally does not need to be called by user code. It is called
2783 when a window is added to a sizer, and is used so the window can
2784 remove itself from the sizer when it is destroyed.
2787 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
2789 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
2791 % VZ: the docs are correct, if the code doesn't behave like this, it must be
2793 Sets the window's cursor. Notice that the window cursor also sets it for the
2794 children of the window implicitly.
2796 The
{\it cursor
} may be
{\tt wxNullCursor
} in which case the window cursor will
2797 be reset back to default.
2799 \wxheading{Parameters
}
2801 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
2803 \wxheading{See also
}
2805 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
2808 \membersection{wxWindow::SetDropTarget
}\label{wxwindowsetdroptarget
}
2810 \func{void
}{SetDropTarget
}{\param{wxDropTarget*
}{ target
}}
2812 Associates a drop target with this window.
2814 If the window already has a drop target, it is deleted.
2816 \wxheading{See also
}
2818 \helpref{wxWindow::GetDropTarget
}{wxwindowgetdroptarget
},
2819 \helpref{Drag and drop overview
}{wxdndoverview
}
2823 \membersection{wxWindow::SetInitialBestSize
}\label{wxwindowsetinitialbestsize
}
2825 \func{virtual void
}{SetInitialBestSize
}{\param{const wxSize\&
}{size
}}
2827 Sets the initial window size if none is given (i.e. at least one of the
2828 components of the size passed to ctor/Create() is wxDefaultCoord).
2830 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
2832 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2834 Sets the event handler for this window.
2836 \wxheading{Parameters
}
2838 \docparam{handler
}{Specifies the handler to be set.
}
2842 An event handler is an object that is capable of processing the events
2843 sent to a window. By default, the window is its own event handler, but
2844 an application may wish to substitute another, for example to allow
2845 central implementation of event-handling for a variety of different
2848 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
2849 this sets up a chain of event handlers, where an event not handled by one event handler is
2850 handed to the next one in the chain.
2852 \wxheading{See also
}
2854 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2855 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2856 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2857 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2858 \helpref{wxEvtHandler
}{wxevthandler
}
2861 \membersection{wxWindow::SetExtraStyle
}\label{wxwindowsetextrastyle
}
2863 \func{void
}{SetExtraStyle
}{\param{long
}{exStyle
}}
2865 Sets the extra style bits for the window. The currently defined extra style
2869 \begin{twocollist
}\itemsep=
0pt
2870 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
2871 and Validate() methods will recursively descend into all children of the
2872 window if it has this style flag set.
}
2873 \twocolitem{\windowstyle{wxWS
\_EX\_BLOCK\_EVENTS}}{Normally, the command
2874 events are propagated upwards to the window parent recursively until a handler
2875 for them is found. Using this style allows to prevent them from being
2876 propagated beyond this window. Notice that wxDialog has this style on by
2877 default for the reasons explained in the
2878 \helpref{event processing overview
}{eventprocessing
}.
}
2879 \twocolitem{\windowstyle{wxWS
\_EX\_TRANSIENT}}{This can be used to prevent a
2880 window from being used as an implicit parent for the dialogs which were
2881 created without a parent. It is useful for the windows which can disappear at
2882 any moment as creating children of such windows results in fatal problems.
}
2883 \twocolitem{\windowstyle{wxWS
\_EX\_CONTEXTHELP}}{Under Windows, puts a query
2884 button on the caption. When pressed, Windows will go into a context-sensitive
2885 help mode and wxWidgets will send a wxEVT
\_HELP event if the user clicked on an
2887 This style cannot be used together with wxMAXIMIZE
\_BOX or wxMINIMIZE
\_BOX, so
2888 these two styles are automatically turned of if this one is used.
}
2889 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
2890 if the mode set by
\helpref{wxIdleEvent::SetMode
}{wxidleeventsetmode
} is wxIDLE
\_PROCESS\_SPECIFIED.
}
2891 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
2892 even if the mode set by
\helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} is wxUPDATE
\_UI\_PROCESS\_SPECIFIED.
}
2896 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
2898 \func{virtual void
}{SetFocus
}{\void}
2900 This sets the window to receive keyboard input.
2902 \wxheading{See also
}
2904 \helpref{wxFocusEvent
}{wxfocusevent
}
2905 \helpref{wxPanel::SetFocus
}{wxpanelsetfocus
}
2906 \helpref{wxPanel::SetFocusIgnoringChildren
}{wxpanelsetfocusignoringchildren
}
2909 \membersection{wxWindow::SetFocusFromKbd
}\label{wxwindowsetfocusfromkbd
}
2911 \func{virtual void
}{SetFocusFromKbd
}{\void}
2913 This function is called by wxWidgets keyboard navigation code when the user
2914 gives the focus to this window from keyboard (e.g. using
{\tt TAB
} key).
2915 By default this method simply calls
\helpref{SetFocus
}{wxwindowsetfocus
} but
2916 can be overridden to do something in addition to this in the derived classes.
2919 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
2921 \func{void
}{SetFont
}{\param{const wxFont\&
}{font
}}
2923 Sets the font for this window. This function should not be called for the
2924 parent window if you don't want its font to be inherited by its children,
2925 use
\helpref{SetOwnFont
}{wxwindowsetownfont
} instead in this case and
2926 see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for more
2929 Please notice that the given font is
\emph{not
} automatically used for
2930 \helpref{wxPaintDC
}{wxpaintdc
} objects associated with this window, you need to
2931 call
\helpref{wxDC::SetFont()
}{wxdcsetfont
} too. However this font is used by
2932 any standard controls for drawing their text as well as by
2933 \helpref{wxWindow::GetTextExtent()
}{wxwindowgettextextent
}.
2935 \wxheading{Parameters
}
2937 \docparam{font
}{Font to associate with this window, pass
2938 {\tt wxNullFont
} to reset to the default font.
}
2940 \wxheading{See also
}
2942 \helpref{wxWindow::GetFont
}{wxwindowgetfont
},\\
2943 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
2946 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
2948 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
2950 Sets the foreground colour of the window.
2952 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
2953 explanation of the difference between this method and
2954 \helpref{SetOwnForegroundColour
}{wxwindowsetownforegroundcolour
}.
2956 \wxheading{Parameters
}
2958 \docparam{colour
}{The colour to be used as the foreground colour, pass
2959 {\tt wxNullColour
} to reset to the default colour.
}
2963 The interpretation of foreground colour is open to interpretation according
2964 to the window class; it may be the text colour or other colour, or it may not
2967 Using this function will disable attempts to use themes for this
2968 window, if the system supports them. Use with care since usually the
2969 themes represent the appearance chosen by the user to be used for all
2970 applications on the system.
2972 \wxheading{See also
}
2974 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2975 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2976 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
2977 \helpref{wxWindow::ShouldInheritColours
}{wxwindowshouldinheritcolours
}
2980 \membersection{wxWindow::SetHelpText
}\label{wxwindowsethelptext
}
2982 \func{virtual void
}{SetHelpText
}{\param{const wxString\&
}{helpText
}}
2984 Sets the help text to be used as context-sensitive help for this window.
2986 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
2987 and not in the window object itself.
2989 \wxheading{See also
}
2991 \helpref{GetHelpText
}{wxwindowgethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
2994 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
2996 \func{void
}{SetId
}{\param{int
}{ id
}}
2998 Sets the identifier of the window.
3002 Each window has an integer identifier. If the application has not provided one,
3003 an identifier will be generated. Normally, the identifier should be provided
3004 on creation and should not be modified subsequently.
3006 \wxheading{See also
}
3008 \helpref{wxWindow::GetId
}{wxwindowgetid
},
\rtfsp
3009 \helpref{Window identifiers
}{windowids
}
3013 \membersection{wxWindow::SetLabel
}\label{wxwindowsetlabel
}
3015 \func{virtual void
}{SetLabel
}{\param{const wxString\&
}{label
}}
3017 Sets the window's label.
3019 \wxheading{Parameters
}
3021 \docparam{label
}{The window label.
}
3023 \wxheading{See also
}
3025 \helpref{wxWindow::GetLabel
}{wxwindowgetlabel
}
3028 \membersection{wxWindow::SetMaxSize
}\label{wxwindowsetmaxsize
}
3030 \func{void
}{SetMaxSize
}{\param{const wxSize\&
}{size
}}
3032 Sets the maximum size of the window, to indicate to the sizer layout mechanism
3033 that this is the maximum possible size.
3035 \membersection{wxWindow::SetMinSize
}\label{wxwindowsetminsize
}
3037 \func{void
}{SetMinSize
}{\param{const wxSize\&
}{size
}}
3039 Sets the minimum size of the window, to indicate to the sizer layout mechanism
3040 that this is the minimum required size. You may need to call this
3041 if you change the window size after construction and before adding
3042 to its parent sizer.
3044 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
3046 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
3048 Sets the window's name.
3050 \wxheading{Parameters
}
3052 \docparam{name
}{A name to set for the window.
}
3054 \wxheading{See also
}
3056 \helpref{wxWindow::GetName
}{wxwindowgetname
}
3059 \membersection{wxWindow::SetOwnBackgroundColour
}\label{wxwindowsetownbackgroundcolour
}
3061 \func{void
}{SetOwnBackgroundColour
}{\param{const wxColour\&
}{colour
}}
3063 Sets the background colour of the window but prevents it from being inherited
3064 by the children of this window.
3066 \wxheading{See also
}
3068 \helpref{SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
3069 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3072 \membersection{wxWindow::SetOwnFont
}\label{wxwindowsetownfont
}
3074 \func{void
}{SetOwnFont
}{\param{const wxFont\&
}{font
}}
3076 Sets the font of the window but prevents it from being inherited by the
3077 children of this window.
3079 \wxheading{See also
}
3081 \helpref{SetFont
}{wxwindowsetfont
},
\rtfsp
3082 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3085 \membersection{wxWindow::SetOwnForegroundColour
}\label{wxwindowsetownforegroundcolour
}
3087 \func{void
}{SetOwnForegroundColour
}{\param{const wxColour\&
}{colour
}}
3089 Sets the foreground colour of the window but prevents it from being inherited
3090 by the children of this window.
3092 \wxheading{See also
}
3094 \helpref{SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
3095 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3098 \membersection{wxWindow::SetPalette
}\label{wxwindowsetpalette
}
3100 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
3102 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
3105 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
3107 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
3108 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
3109 \param{bool
}{refresh =
{\tt true
}}}
3111 Sets the scrollbar properties of a built-in scrollbar.
3113 \wxheading{Parameters
}
3115 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3117 \docparam{position
}{The position of the scrollbar in scroll units.
}
3119 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
3121 \docparam{range
}{The maximum position of the scrollbar.
}
3123 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3127 Let's say you wish to display
50 lines of text, using the same font.
3128 The window is sized so that you can only see
16 lines at a time.
3134 SetScrollbar(wxVERTICAL,
0,
16,
50);
3138 Note that with the window at this size, the thumb position can never go
3139 above
50 minus
16, or
34.
3141 You can determine how many lines are currently visible by dividing the current view
3142 size by the character height in pixels.
3144 When defining your own scrollbar behaviour, you will always need to recalculate
3145 the scrollbar settings when the window size changes. You could therefore put your
3146 scrollbar calculations and SetScrollbar
3147 call into a function named AdjustScrollbars, which can be called initially and also
3148 from your
\helpref{wxSizeEvent
}{wxsizeevent
} handler function.
3150 \wxheading{See also
}
3152 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
3153 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
},
\rtfsp
3154 \helpref{wxScrollWinEvent
}{wxscrollwinevent
}
3159 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
3161 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{bool
}{refresh =
{\tt true
}}}
3163 Sets the page size of one of the built-in scrollbars.
3165 \wxheading{Parameters
}
3167 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3169 \docparam{pageSize
}{Page size in scroll units.
}
3171 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3175 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
3176 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
3177 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
3178 value has to be adjusted when the window is resized, since the page size will have changed.
3180 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
3181 the thumb changes size to reflect the page size relative to the length of the
document. When the
3182 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
3183 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
3186 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
3187 handling of pages and ranges.
3189 \wxheading{See also
}
3191 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3192 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3193 \helpref{wxWindow::GetScrollPage
}{wxwindowgetscrollpage
},
\rtfsp
3194 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3198 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
3200 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{bool
}{refresh =
{\tt true
}}}
3202 Sets the position of one of the built-in scrollbars.
3204 \wxheading{Parameters
}
3206 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3208 \docparam{pos
}{Position in scroll units.
}
3210 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3214 This function does not directly affect the contents of the window: it is up to the
3215 application to take note of scrollbar attributes and redraw contents accordingly.
3217 \wxheading{See also
}
3219 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
3220 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3221 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
3222 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3227 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
3229 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{bool
}{refresh =
{\tt true
}}}
3231 Sets the range of one of the built-in scrollbars.
3233 \wxheading{Parameters
}
3235 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3237 \docparam{range
}{Scroll range.
}
3239 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3243 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
3244 object length of the scrollbar. If you are implementing a scrolling window, for example, you
3245 would adjust the scroll range when the window is resized, by subtracting the window view size from the
3246 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
3247 and usually the scrollbar will be automatically hidden.
3249 \wxheading{See also
}
3251 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3252 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
3253 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3254 \helpref{wxWindow::GetScrollPage
}{wxwindowgetscrollpage
},
\rtfsp
3255 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3259 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
3261 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
3262 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
3264 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
3266 Sets the size and position of the window in pixels.
3268 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3270 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
3272 Sets the size of the window in pixels.
3274 \wxheading{Parameters
}
3276 \docparam{x
}{Required x position in pixels, or wxDefaultCoord to indicate that the existing
3277 value should be used.
}
3279 \docparam{y
}{Required y position in pixels, or wxDefaultCoord to indicate that the existing
3280 value should be used.
}
3282 \docparam{width
}{Required width in pixels, or wxDefaultCoord to indicate that the existing
3283 value should be used.
}
3285 \docparam{height
}{Required height position in pixels, or wxDefaultCoord to indicate that the existing
3286 value should be used.
}
3288 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
3290 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
3292 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
3294 {\bf wxSIZE
\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
3295 a wxWidgets-supplied default width.\\
3296 {\bf wxSIZE
\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
3297 a wxWidgets-supplied default height.\\
3298 {\bf wxSIZE
\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
3299 a wxWidgets-supplied default size.\\
3300 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
3301 if $wxDefaultCoord$ values are supplied.\\
3302 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted
3303 as real dimensions, not default values.
3304 {\bf wxSIZE
\_FORCE}: normally, if the position and the size of the window are
3305 already the same as the parameters of this function, nothing is done. but with
3306 this flag a window resize may be forced even in this case (supported in wx
3307 2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
3312 The second form is a convenience for calling the first form with default
3313 x and y parameters, and must be used with non-default width and height values.
3315 The first form sets the position and optionally size, of the window.
3316 Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied
3317 by wxWidgets, or that the current value of the dimension should be used.
3319 \wxheading{See also
}
3321 \helpref{wxWindow::Move
}{wxwindowmove
}
3323 \pythonnote{In place of a single overloaded method name, wxPython
3324 implements the following methods:
\par
3325 \indented{2cm
}{\begin{twocollist
}
3326 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE
\_AUTO)
}}{}
3327 \twocolitem{{\bf SetSize(size)
}}{}
3328 \twocolitem{{\bf SetPosition(point)
}}{}
3333 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
3335 Use of this function for windows which are not toplevel windows
3336 (such as wxDialog or wxFrame) is discouraged. Please use
3337 \helpref{SetMinSize
}{wxwindowsetminsize
} and
\helpref{SetMaxSize
}{wxwindowsetmaxsize
}
3340 \wxheading{See also
}
3342 \helpref{wxTopLevelWindow::SetSizeHints
}{wxtoplevelwindowsetsizehints
}.
3345 \membersection{wxWindow::SetSizer
}\label{wxwindowsetsizer
}
3347 \func{void
}{SetSizer
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3349 Sets the window to have the given layout sizer. The window
3350 will then own the object, and will take care of its deletion.
3351 If an existing layout constraints object is already owned by the
3352 window, it will be deleted if the deleteOld parameter is true.
3354 Note that this function will also call
3355 \helpref{SetAutoLayout
}{wxwindowsetautolayout
} implicitly with
{\tt true
}
3356 parameter if the
{\it sizer
}\/ is non-NULL and
{\tt false
} otherwise.
3358 \wxheading{Parameters
}
3360 \docparam{sizer
}{The sizer to set. Pass NULL to disassociate and conditionally delete
3361 the window's sizer. See below.
}
3363 \docparam{deleteOld
}{If true (the default), this will delete any prexisting sizer.
3364 Pass false if you wish to handle deleting the old sizer yourself.
}
3368 SetSizer now enables and disables Layout automatically, but prior to wxWidgets
2.3.3
3369 the following applied:
3371 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
3372 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
3373 explicitly. When setting both a wxSizer and a
\helpref{wxLayoutConstraints
}{wxlayoutconstraints
},
3374 only the sizer will have effect.
3377 \membersection{wxWindow::SetSizerAndFit
}\label{wxwindowsetsizerandfit
}
3379 \func{void
}{SetSizerAndFit
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3381 The same as
\helpref{SetSizer
}{wxwindowsetsizer
}, except it also sets the size hints
3382 for the window based on the sizer's minimum size.
3385 \membersection{wxWindow::SetThemeEnabled
}\label{wxwindowsetthemeenabled
}
3387 \func{virtual void
}{SetThemeEnabled
}{\param{bool
}{enable
}}
3389 This function tells a window if it should use the system's "theme" code
3390 to draw the windows' background instead if its own background drawing
3391 code. This does not always have any effect since the underlying platform
3392 obviously needs to support the notion of themes in user defined windows.
3393 One such platform is GTK+ where windows can have (very colourful) backgrounds
3394 defined by a user's selected theme.
3396 Dialogs, notebook pages and the status bar have this flag set to true
3397 by default so that the default look and feel is simulated best.
3400 \membersection{wxWindow::SetToolTip
}\label{wxwindowsettooltip
}
3402 \func{void
}{SetToolTip
}{\param{const wxString\&
}{tip
}}
3404 \func{void
}{SetToolTip
}{\param{wxToolTip*
}{tip
}}
3406 Attach a tooltip to the window.
3408 See also:
\helpref{GetToolTip
}{wxwindowgettooltip
},
3409 \helpref{wxToolTip
}{wxtooltip
}
3412 \membersection{wxWindow::SetValidator
}\label{wxwindowsetvalidator
}
3414 \func{virtual void
}{SetValidator
}{\param{const wxValidator\&
}{ validator
}}
3416 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
3417 create a new validator of this type.
3420 \membersection{wxWindow::SetVirtualSize
}\label{wxwindowsetvirtualsize
}
3422 \func{void
}{SetVirtualSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3424 \func{void
}{SetVirtualSize
}{\param{const wxSize\&
}{ size
}}
3426 Sets the virtual size of the window in pixels.
3429 \membersection{wxWindow::SetVirtualSizeHints
}\label{wxwindowsetvirtualsizehints
}
3431 \func{virtual void
}{SetVirtualSizeHints
}{\param{int
}{ minW
},
\param{int
}{ minH
},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1}}
3433 \func{void
}{SetVirtualSizeHints
}{\param{const wxSize\&
}{ minSize=wxDefaultSize
},
3434 \param{const wxSize\&
}{ maxSize=wxDefaultSize
}}
3437 Allows specification of minimum and maximum virtual window sizes.
3438 If a pair of values is not set (or set to -
1), the default values
3441 \wxheading{Parameters
}
3443 \docparam{minW
}{Specifies the minimum width allowable.
}
3445 \docparam{minH
}{Specifies the minimum height allowable.
}
3447 \docparam{maxW
}{Specifies the maximum width allowable.
}
3449 \docparam{maxH
}{Specifies the maximum height allowable.
}
3451 \docparam{minSize
}{Minimum size.
}
3453 \docparam{maxSize
}{Maximum size.
}
3457 If this function is called, the user will not be able to size the virtual area
3458 of the window outside the given bounds.
3461 \membersection{wxWindow::SetWindowStyle
}\label{wxwindowsetwindowstyle
}
3463 \func{void
}{SetWindowStyle
}{\param{long
}{ style
}}
3465 Identical to
\helpref{SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
}.
3468 \membersection{wxWindow::SetWindowStyleFlag
}\label{wxwindowsetwindowstyleflag
}
3470 \func{virtual void
}{SetWindowStyleFlag
}{\param{long
}{ style
}}
3472 Sets the style of the window. Please note that some styles cannot be changed
3473 after the window creation and that
\helpref{Refresh()
}{wxwindowrefresh
} might
3474 need to be be called after changing the others for the change to take place
3477 See
\helpref{Window styles
}{windowstyles
} for more information about flags.
3479 \wxheading{See also
}
3481 \helpref{GetWindowStyleFlag
}{wxwindowgetwindowstyleflag
}
3484 \membersection{wxWindow::SetWindowVariant
}\label{wxwindowsetwindowvariant
}
3486 \func{void
}{SetWindowVariant
}{\param{wxWindowVariant
}{variant
}}
3488 This function can be called under all platforms but only does anything under
3489 Mac OS X
10.3+ currently. Under this system, each of the standard control can
3490 exist in several sizes which correspond to the elements of wxWindowVariant
3493 enum wxWindowVariant
3495 wxWINDOW_VARIANT_NORMAL, // Normal size
3496 wxWINDOW_VARIANT_SMALL, // Smaller size (about
25 % smaller than normal )
3497 wxWINDOW_VARIANT_MINI, // Mini size (about
33 % smaller than normal )
3498 wxWINDOW_VARIANT_LARGE, // Large size (about
25 % larger than normal )
3502 By default the controls use the normal size, of course, but this function can
3503 be used to change this.
3506 \membersection{wxWindow::ShouldInheritColours
}\label{wxwindowshouldinheritcolours
}
3508 \func{virtual bool
}{ShouldInheritColours
}{\void}
3510 Return
\true from here to allow the colours of this window to be changed by
3511 \helpref{InheritAttributes
}{wxwindowinheritattributes
}, returning
\false
3512 forbids inheriting them from the parent window.
3514 The base class version returns
\false, but this method is overridden in
3515 \helpref{wxControl
}{wxcontrol
} where it returns
\true.
3518 \membersection{wxWindow::Show
}\label{wxwindowshow
}
3520 \func{virtual bool
}{Show
}{\param{bool
}{ show =
{\tt true
}}}
3522 Shows or hides the window. You may need to call
\helpref{Raise
}{wxwindowraise
}
3523 for a top level window if you want to bring it to top, although this is not
3524 needed if Show() is called immediately after the frame creation.
3526 \wxheading{Parameters
}
3528 \docparam{show
}{If
{\tt true
} displays the window. Otherwise, hides it.
}
3530 \wxheading{Return value
}
3532 {\tt true
} if the window has been shown or hidden or
{\tt false
} if nothing was
3533 done because it already was in the requested state.
3535 \wxheading{See also
}
3537 \helpref{wxWindow::IsShown
}{wxwindowisshown
},
\rtfsp
3538 \helpref{wxWindow::Hide
}{wxwindowhide
},
\rtfsp
3539 \helpref{wxRadioBox::Show
}{wxradioboxshow
}
3542 \membersection{wxWindow::Thaw
}\label{wxwindowthaw
}
3544 \func{virtual void
}{Thaw
}{\void}
3546 Reenables window updating after a previous call to
3547 \helpref{Freeze
}{wxwindowfreeze
}. To really thaw the control, it must be called
3548 exactly the same number of times as
\helpref{Freeze
}{wxwindowfreeze
}.
3550 \wxheading{See also
}
3552 \helpref{wxWindowUpdateLocker
}{wxwindowupdatelocker
}
3555 \membersection{wxWindow::ToggleWindowStyle
}\label{wxwindowtogglewindowstyle
}
3557 \func{bool
}{ToggleWindowStyle
}{\param{int
}{flag
}}
3559 Turns the given
\arg{flag
} on if it's currently turned off and vice versa.
3560 This function cannot be used if the value of the flag is $
0$ (which is often
3561 the case for default flags).
3563 Also, please notice that not all styles can be changed after the control
3566 \wxheading{Return value
}
3568 Returns
\true if the style was turned on by this function,
\false if it was
3571 \wxheading{See also
}
3573 \helpref{wxWindow::SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
},
\rtfsp
3574 \helpref{wxWindow::HasFlag
}{wxwindowhasflag
}
3577 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
3579 \func{virtual bool
}{TransferDataFromWindow
}{\void}
3581 Transfers values from child controls to data areas specified by their validators. Returns
3582 {\tt false
} if a transfer failed.
3584 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3585 the method will also call TransferDataFromWindow() of all child windows.
3587 \wxheading{See also
}
3589 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3590 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3593 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
3595 \func{virtual bool
}{TransferDataToWindow
}{\void}
3597 Transfers values to child controls from data areas specified by their validators.
3599 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3600 the method will also call TransferDataToWindow() of all child windows.
3602 \wxheading{Return value
}
3604 Returns
{\tt false
} if a transfer failed.
3606 \wxheading{See also
}
3608 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3609 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3612 \membersection{wxWindow::UnregisterHotKey
}\label{wxwindowunregisterhotkey
}
3614 \func{bool
}{UnregisterHotKey
}{\param{int
}{ hotkeyId
}}
3616 Unregisters a system wide hotkey.
3618 \wxheading{Parameters
}
3620 \docparam{hotkeyId
}{Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey.
}
3622 \wxheading{Return value
}
3624 {\tt true
} if the hotkey was unregistered successfully,
{\tt false
} if the id was invalid.
3628 This function is currently only implemented under MSW.
3630 \wxheading{See also
}
3632 \helpref{wxWindow::RegisterHotKey
}{wxwindowregisterhotkey
}
3635 \membersection{wxWindow::Update
}\label{wxwindowupdate
}
3637 \func{virtual void
}{Update
}{\void}
3639 Calling this method immediately repaints the invalidated area of the window and
3640 all of its children recursively while this would usually only happen when the
3641 flow of control returns to the event loop.
3642 Notice that this function doesn't invalidate any area of the window so
3643 nothing happens if nothing has been invalidated (i.e. marked as requiring
3644 a redraw). Use
\helpref{Refresh
}{wxwindowrefresh
} first if you want to
3645 immediately redraw the window unconditionally.
3648 \membersection{wxWindow::UpdateWindowUI
}\label{wxwindowupdatewindowui
}
3650 \func{virtual void
}{UpdateWindowUI
}{\param{long
}{ flags = wxUPDATE
\_UI\_NONE}}
3652 This function sends
\helpref{wxUpdateUIEvents
}{wxupdateuievent
} to
3653 the window. The particular implementation depends on the window; for
3654 example a wxToolBar will send an update UI event for each toolbar button,
3655 and a wxFrame will send an update UI event for each menubar menu item.
3656 You can call this function from your application to ensure that your
3657 UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers
3658 are concerned). This may be necessary if you have called
3659 \helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} or
3660 \helpref{wxUpdateUIEvent::SetUpdateInterval
}{wxupdateuieventsetupdateinterval
} to
3661 limit the overhead that wxWidgets incurs by sending update UI events in idle time.
3663 {\it flags
} should be a bitlist of one or more of the following values.
3668 wxUPDATE_UI_NONE =
0x0000, // No particular value
3669 wxUPDATE_UI_RECURSE =
0x0001, // Call the function for descendants
3670 wxUPDATE_UI_FROMIDLE =
0x0002 // Invoked from On(Internal)Idle
3674 If you are calling this function from an OnInternalIdle or OnIdle
3675 function, make sure you pass the wxUPDATE
\_UI\_FROMIDLE flag, since
3676 this tells the window to only update the UI elements that need
3677 to be updated in idle time. Some windows update their elements
3678 only when necessary, for example when a menu is about to be shown.
3679 The following is an example of how to call UpdateWindowUI from
3683 void MyWindow::OnInternalIdle()
3685 if (wxUpdateUIEvent::CanUpdate(this))
3686 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
3690 \wxheading{See also
}
3692 \helpref{wxUpdateUIEvent
}{wxupdateuievent
},
3693 \helpref{wxWindow::DoUpdateWindowUI
}{wxwindowdoupdatewindowui
},
3694 \helpref{wxWindow::OnInternalIdle
}{wxwindowoninternalidle
}
3697 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
3699 \func{virtual bool
}{Validate
}{\void}
3701 Validates the current values of the child controls using their validators.
3703 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3704 the method will also call Validate() of all child windows.
3706 \wxheading{Return value
}
3708 Returns
{\tt false
} if any of the validations failed.
3710 \wxheading{See also
}
3712 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3713 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3714 \helpref{wxValidator
}{wxvalidator
}
3717 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
3719 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
3721 Moves the pointer to the given position on the window.
3723 {\bf NB:
} This function is not supported under Mac because Apple Human
3724 Interface Guidelines forbid moving the mouse cursor programmatically.
3726 \wxheading{Parameters
}
3728 \docparam{x
}{The new x position for the cursor.
}
3730 \docparam{y
}{The new y position for the cursor.
}