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
66 to have normal keyboard navigation take place, you should call
67 \helpref{Navigate
}{wxwindownavigate
} in response to the key events for
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::AcceptsFocus
}\label{wxwindowacceptsfocus
}
176 \constfunc{bool
}{AcceptsFocus
}{\void}
178 This method may be overridden in the derived classes to return
\false to
179 indicate that this control doesn't accept input at all (i.e. behaves like e.g.
180 \helpref{wxStaticText
}{wxstatictext
}) and so doesn't need focus.
184 \helpref{AcceptsFocusFromKeyboard
}{wxwindowacceptsfocusfromkeyboard
}
187 \membersection{wxWindow::AcceptsFocusFromKeyboard
}\label{wxwindowacceptsfocusfromkeyboard
}
189 \constfunc{bool
}{AcceptsFocusFromKeyboard
}{\void}
191 This method may be overridden in the derived classes to return
\false to
192 indicate that while this control can, in principle, have focus if the user
193 clicks it with the mouse, it shouldn't be included in the TAB traversal chain
194 when using the keyboard.
197 \membersection{wxWindow::AddChild
}\label{wxwindowaddchild
}
199 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
201 Adds a child window. This is called automatically by window creation
202 functions so should not be required by the application programmer.
204 Notice that this function is mostly internal to wxWidgets and shouldn't be
205 called by the user code.
207 \wxheading{Parameters
}
209 \docparam{child
}{Child window to add.
}
212 \membersection{wxWindow::CacheBestSize
}\label{wxwindowcachebestsize
}
214 \constfunc{void
}{CacheBestSize
}{\param{const wxSize\&
}{size
}}
216 Sets the cached best size value.
219 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
221 \func{virtual void
}{CaptureMouse
}{\void}
223 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
226 Note that wxWidgets maintains the stack of windows having captured the mouse
227 and when the mouse is released the capture returns to the window which had had
228 captured it previously and it is only really released if there were no previous
229 window. In particular, this means that you must release the mouse as many times
230 as you capture it, unless the window receives
231 the
\helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
} event.
233 Any application which captures the mouse in the beginning of some operation
234 {\em must
} handle
\helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
235 and cancel this operation when it receives the event. The event handler must
240 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
241 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
244 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
246 \func{void
}{Center
}{\param{int
}{ direction
}}
248 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
251 \membersection{wxWindow::CenterOnParent
}\label{wxwindowcenteronparent
}
253 \func{void
}{CenterOnParent
}{\param{int
}{ direction
}}
255 A synonym for
\helpref{CentreOnParent
}{wxwindowcentreonparent
}.
258 \membersection{wxWindow::CenterOnScreen
}\label{wxwindowcenteronscreen
}
260 \func{void
}{CenterOnScreen
}{\param{int
}{ direction
}}
262 A synonym for
\helpref{CentreOnScreen
}{wxwindowcentreonscreen
}.
265 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
267 \func{void
}{Centre
}{\param{int
}{ direction = wxBOTH
}}
271 \wxheading{Parameters
}
273 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
274 or
{\tt wxBOTH
}. It may also include
{\tt wxCENTRE
\_ON\_SCREEN} flag
275 if you want to center the window on the entire screen and not on its
278 The flag
{\tt wxCENTRE
\_FRAME} is obsolete and should not be used any longer
283 If the window is a top level one (i.e. doesn't have a parent), it will be
284 centered relative to the screen anyhow.
288 \helpref{wxWindow::Center
}{wxwindowcenter
}
291 \membersection{wxWindow::CentreOnParent
}\label{wxwindowcentreonparent
}
293 \func{void
}{CentreOnParent
}{\param{int
}{ direction = wxBOTH
}}
295 Centres the window on its parent. This is a more readable synonym for
296 \helpref{Centre
}{wxwindowcentre
}.
298 \wxheading{Parameters
}
300 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
305 This methods provides for a way to center top level windows over their
306 parents instead of the entire screen. If there is no parent or if the
307 window is not a top level window, then behaviour is the same as
308 \helpref{wxWindow::Centre
}{wxwindowcentre
}.
312 \helpref{wxWindow::CentreOnScreen
}{wxwindowcenteronscreen
}
315 \membersection{wxWindow::CentreOnScreen
}\label{wxwindowcentreonscreen
}
317 \func{void
}{CentreOnScreen
}{\param{int
}{ direction = wxBOTH
}}
319 Centres the window on screen. This only works for top level windows -
320 otherwise, the window will still be centered on its parent.
322 \wxheading{Parameters
}
324 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
329 \helpref{wxWindow::CentreOnParent
}{wxwindowcenteronparent
}
332 \membersection{wxWindow::ClearBackground
}\label{wxwindowclearbackground
}
334 \func{void
}{ClearBackground
}{\void}
336 Clears the window by filling it with the current background colour. Does not
337 cause an erase background event to be generated.
340 \membersection{wxWindow::ClientToScreen
}\label{wxwindowclienttoscreen
}
342 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
344 \perlnote{In wxPerl this method returns a
2-element list instead of
345 modifying its parameters.
}
347 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
349 Converts to screen coordinates from coordinates relative to this window.
351 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
352 a screen coordinate will be passed out.
}
354 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
355 a screen coordinate will be passed out.
}
357 \docparam{pt
}{The client position for the second form of the function.
}
359 \pythonnote{In place of a single overloaded method name, wxPython
360 implements the following methods:
\par
361 \indented{2cm
}{\begin{twocollist
}
362 \twocolitem{{\bf ClientToScreen(point)
}}{Accepts and returns a wxPoint
}
363 \twocolitem{{\bf ClientToScreenXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
368 \membersection{wxWindow::Close
}\label{wxwindowclose
}
370 \func{bool
}{Close
}{\param{bool
}{ force =
{\tt false
}}}
372 This function simply generates a
\helpref{wxCloseEvent
}{wxcloseevent
} whose
373 handler usually tries to close the window. It doesn't close the window itself,
376 \wxheading{Parameters
}
378 \docparam{force
}{{\tt false
} if the window's close handler should be able to veto the destruction
379 of this window,
{\tt true
} if it cannot.
}
383 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing
384 an opportunity for the window to choose whether to destroy the window.
385 Usually it is only used with the top level windows (wxFrame and wxDialog
386 classes) as the others are not supposed to have any special OnClose() logic.
388 The close handler should check whether the window is being deleted forcibly,
389 using
\helpref{wxCloseEvent::CanVeto
}{wxcloseeventcanveto
}, in which case it
390 should destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
392 {\it Note
} that calling Close does not guarantee that the window will be
393 destroyed; but it provides a way to simulate a manual close of a window, which
394 may or may not be implemented by destroying the window. The default
395 implementation of wxDialog::OnCloseWindow does not necessarily delete the
396 dialog, since it will simply simulate an wxID
\_CANCEL event which is handled by
397 the appropriate button event handler and may do anything at all.
399 To guarantee that the window will be destroyed, call
400 \helpref{wxWindow::Destroy
}{wxwindowdestroy
} instead
404 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
405 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
406 \helpref{wxCloseEvent
}{wxcloseevent
}
409 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
411 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
413 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
415 Converts a point or size from dialog units to pixels.
417 For the x dimension, the dialog units are multiplied by the average character width
418 and then divided by
4.
420 For the y dimension, the dialog units are multiplied by the average character height
421 and then divided by
8.
425 Dialog units are used for maintaining a dialog's proportions even if the font changes.
427 You can also use these functions programmatically. A convenience macro is defined:
431 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
437 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
439 \pythonnote{In place of a single overloaded method name, wxPython
440 implements the following methods:
\par
441 \indented{2cm
}{\begin{twocollist
}
442 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
443 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
446 Additionally, the following helper functions are defined:
\par
447 \indented{2cm
}{\begin{twocollist
}
448 \twocolitem{{\bf wxDLG
\_PNT(win, point)
}}{Converts a wxPoint from dialog
450 \twocolitem{{\bf wxDLG
\_SZE(win, size)
}}{Converts a wxSize from dialog
457 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
459 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
461 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
463 Converts a point or size from pixels to dialog units.
465 For the x dimension, the pixels are multiplied by
4 and then divided by the average
468 For the y dimension, the pixels are multiplied by
8 and then divided by the average
473 Dialog units are used for maintaining a dialog's proportions even if the font changes.
477 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
479 \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:
\par
480 \indented{2cm
}{\begin{twocollist
}
481 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
482 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
487 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
489 \func{virtual bool
}{Destroy
}{\void}
491 Destroys the window safely. Use this function instead of the delete operator, since
492 different window classes can be destroyed differently. Frames and dialogs
493 are not destroyed immediately when this function is called -- they are added
494 to a list of windows to be deleted on idle time, when all the window's events
495 have been processed. This prevents problems with events being sent to non-existent
498 \wxheading{Return value
}
500 {\tt true
} if the window has either been successfully deleted, or it has been added
501 to the list of windows pending real deletion.
504 \membersection{wxWindow::DestroyChildren
}\label{wxwindowdestroychildren
}
506 \func{virtual void
}{DestroyChildren
}{\void}
508 Destroys all children of a window. Called automatically by the destructor.
511 \membersection{wxWindow::Disable
}\label{wxwindowdisable
}
513 \func{bool
}{Disable
}{\void}
515 Disables the window, same as
\helpref{Enable(
{\tt false
})
}{wxwindowenable
}.
517 \wxheading{Return value
}
519 Returns
{\tt true
} if the window has been disabled,
{\tt false
} if it had been
520 already disabled before the call to this function.
523 \membersection{wxWindow::DoGetBestSize
}\label{wxwindowdogetbestsize
}
525 \constfunc{virtual wxSize
}{DoGetBestSize
}{\void}
527 Gets the size which best suits the window: for a control, it would be
528 the minimal size which doesn't truncate the control, for a panel - the
529 same size as it would have after a call to
\helpref{Fit()
}{wxwindowfit
}.
532 \membersection{wxWindow::DoUpdateWindowUI
}\label{wxwindowdoupdatewindowui
}
534 \func{virtual void
}{DoUpdateWindowUI
}{\param{wxUpdateUIEvent\&
}{ event
}}
536 Does the window-specific updating after processing the update event.
537 This function is called by
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
538 in order to check return values in the
\helpref{wxUpdateUIEvent
}{wxupdateuievent
} and
539 act appropriately. For example, to allow frame and dialog title updating, wxWidgets
540 implements this function as follows:
543 // do the window-specific processing after processing the update event
544 void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
546 if ( event.GetSetEnabled() )
547 Enable(event.GetEnabled());
549 if ( event.GetSetText() )
551 if ( event.GetText() != GetTitle() )
552 SetTitle(event.GetText());
559 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
561 \func{virtual void
}{DragAcceptFiles
}{\param{bool
}{ accept
}}
563 Enables or disables eligibility for drop file events (OnDropFiles).
565 \wxheading{Parameters
}
567 \docparam{accept
}{If
{\tt true
}, the window is eligible for drop file events. If
{\tt false
}, the window
568 will not accept drop file events.
}
575 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
577 \func{virtual bool
}{Enable
}{\param{bool
}{ enable =
{\tt true
}}}
579 Enable or disable the window for user input. Note that when a parent window is
580 disabled, all of its children are disabled as well and they are reenabled again
583 \wxheading{Parameters
}
585 \docparam{enable
}{If
{\tt true
}, enables the window for input. If
{\tt false
}, disables the window.
}
587 \wxheading{Return value
}
589 Returns
{\tt true
} if the window has been enabled or disabled,
{\tt false
} if
590 nothing was done, i.e. if the window had already been in the specified state.
594 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
},
\rtfsp
595 \helpref{wxWindow::Disable
}{wxwindowdisable
},
\rtfsp
596 \helpref{wxRadioBox::Enable
}{wxradioboxenable
}
599 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
601 \func{static wxWindow*
}{FindFocus
}{\void}
603 Finds the window or control which currently has the keyboard focus.
607 Note that this is a static function, so it can be called without needing a wxWindow pointer.
611 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
615 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
617 \constfunc{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
619 Find a child of this window, by identifier.
621 \constfunc{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
623 Find a child of this window, by name.
625 \pythonnote{In place of a single overloaded method name, wxPython
626 implements the following methods:
\par
627 \indented{2cm
}{\begin{twocollist
}
628 \twocolitem{{\bf FindWindowById(id)
}}{Accepts an integer
}
629 \twocolitem{{\bf FindWindowByName(name)
}}{Accepts a string
}
634 \membersection{wxWindow::FindWindowById
}\label{wxwindowfindwindowbyid
}
636 \func{static wxWindow*
}{FindWindowById
}{\param{long
}{ id
},
\param{wxWindow*
}{ parent = NULL
}}
638 Find the first window with the given
{\it id
}.
640 If
{\it parent
} is NULL, the search will start from all top-level
641 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
642 The search is recursive in both cases.
646 \helpref{FindWindow
}{wxwindowfindwindow
}
649 \membersection{wxWindow::FindWindowByLabel
}\label{wxwindowfindwindowbylabel
}
651 \func{static wxWindow*
}{FindWindowByLabel
}{\param{const wxString\&
}{ label
},
\param{wxWindow*
}{ parent = NULL
}}
653 Find a window by its label. Depending on the type of window, the label may be a window title
654 or panel item label. If
{\it parent
} is NULL, the search will start from all top-level
655 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
656 The search is recursive in both cases.
660 \helpref{FindWindow
}{wxwindowfindwindow
}
663 \membersection{wxWindow::FindWindowByName
}\label{wxwindowfindwindowbyname
}
665 \func{static wxWindow*
}{FindWindowByName
}{\param{const wxString\&
}{ name
},
\param{wxWindow*
}{ parent = NULL
}}
667 Find a window by its name (as given in a window constructor or
{\bf Create
} function call).
668 If
{\it parent
} is NULL, the search will start from all top-level
669 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
670 The search is recursive in both cases.
672 If no window with such name is found,
673 \helpref{FindWindowByLabel
}{wxwindowfindwindowbylabel
} is called.
677 \helpref{FindWindow
}{wxwindowfindwindow
}
680 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
682 \func{virtual void
}{Fit
}{\void}
684 Sizes the window so that it fits around its subwindows. This function won't do
685 anything if there are no subwindows and will only really work correctly if
686 sizers are used for the subwindows layout. Also, if the window has exactly one
687 subwindow it is better (faster and the result is more precise as Fit adds some
688 margin to account for fuzziness of its calculations) to call
691 window->SetClientSize(child->GetSize());
694 instead of calling Fit.
697 \membersection{wxWindow::FitInside
}\label{wxwindowfitinside
}
699 \func{virtual void
}{FitInside
}{\void}
701 Similar to
\helpref{Fit
}{wxwindowfit
}, but sizes the interior (virtual) size
702 of a window. Mainly useful with scrolled windows to reset scrollbars after
703 sizing changes that do not trigger a size event, and/or scrolled windows without
704 an interior sizer. This function similarly won't do anything if there are no
708 \membersection{wxWindow::Freeze
}\label{wxwindowfreeze
}
710 \func{virtual void
}{Freeze
}{\void}
712 Freezes the window or, in other words, prevents any updates from taking place
713 on screen, the window is not redrawn at all.
\helpref{Thaw
}{wxwindowthaw
} must
714 be called to reenable window redrawing. Calls to these two functions may be
717 This method is useful for visual appearance optimization (for example, it
718 is a good idea to use it before doing many large text insertions in a row into
719 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
720 controls so it is mostly just a hint to wxWidgets and not a mandatory
725 \helpref{wxWindowUpdateLocker
}{wxwindowupdatelocker
}
728 \membersection{wxWindow::GetAcceleratorTable
}\label{wxwindowgetacceleratortable
}
730 \constfunc{wxAcceleratorTable*
}{GetAcceleratorTable
}{\void}
732 Gets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
735 \membersection{wxWindow::GetAccessible
}\label{wxwindowgetaccessible
}
737 \func{wxAccessible*
}{GetAccessible
}{\void}
739 Returns the accessible object for this window, if any.
741 See also
\helpref{wxAccessible
}{wxaccessible
}.
744 \membersection{wxWindow::GetAdjustedBestSize
}\label{wxwindowgetadjustedbestsize
}
746 \constfunc{wxSize
}{GetAdjustedBestSize
}{\void}
748 This method is deprecated, use
\helpref{GetEffectiveMinSize
}{wxwindowgeteffectiveminsize
}
752 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
754 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
756 Returns the background colour of the window.
760 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
761 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
762 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
}
764 \membersection{wxWindow::GetBackgroundStyle
}\label{wxwindowgetbackgroundstyle
}
766 \constfunc{virtual wxBackgroundStyle
}{GetBackgroundStyle
}{\void}
768 Returns the background style of the window. The background style indicates
769 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
770 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
771 application to implement (wxBG
\_STYLE\_CUSTOM).
773 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
774 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
778 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
779 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
780 \helpref{wxWindow::SetBackgroundStyle
}{wxwindowsetbackgroundstyle
}
782 \membersection{wxWindow::GetEffectiveMinSize
}\label{wxwindowgeteffectiveminsize
}
784 \constfunc{wxSize
}{GetEffectiveMinSize
}{\void}
786 Merges the window's best size into the min size and returns the
787 result. This is the value used by sizers to determine the appropriate
788 ammount of sapce to allocate for the widget.
792 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
793 \helpref{wxWindow::SetInitialSize
}{wxwindowsetinitialsize
}
796 \membersection{wxWindow::GetBestSize
}\label{wxwindowgetbestsize
}
798 \constfunc{wxSize
}{GetBestSize
}{\void}
800 This functions returns the best acceptable minimal size for the window. For
801 example, for a static control, it will be the minimal size such that the
802 control label is not truncated. For windows containing subwindows (typically
803 \helpref{wxPanel
}{wxpanel
}), the size returned by this function will be the
804 same as the size the window would have had after calling
805 \helpref{Fit
}{wxwindowfit
}.
808 \membersection{wxWindow::GetCapture
}\label{wxwindowgetcapture
}
810 \func{static wxWindow *
}{GetCapture
}{\void}
812 Returns the currently captured window.
816 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
817 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
818 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
819 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
820 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
823 \membersection{wxWindow::GetCaret
}\label{wxwindowgetcaret
}
825 \constfunc{wxCaret *
}{GetCaret
}{\void}
827 Returns the
\helpref{caret
}{wxcaret
} associated with the window.
830 \membersection{wxWindow::GetCharHeight
}\label{wxwindowgetcharheight
}
832 \constfunc{virtual int
}{GetCharHeight
}{\void}
834 Returns the character height for this window.
837 \membersection{wxWindow::GetCharWidth
}\label{wxwindowgetcharwidth
}
839 \constfunc{virtual int
}{GetCharWidth
}{\void}
841 Returns the average character width for this window.
844 \membersection{wxWindow::GetChildren
}\label{wxwindowgetchildren
}
846 \func{wxWindowList\&
}{GetChildren
}{\void}
848 \constfunc{const wxWindowList\&
}{GetChildren
}{\void}
850 Returns a reference to the list of the window's children.
\texttt{wxWindowList
}
851 is a type-safe
\helpref{wxList
}{wxlist
}-like class whose elements are of type
855 \membersection{wxWindow::GetClassDefaultAttributes
}\label{wxwindowgetclassdefaultattributes
}
857 \func{static wxVisualAttributes
}{GetClassDefaultAttributes
}{\param{wxWindowVariant
}{ variant =
\texttt{wxWINDOW
\_VARIANT\_NORMAL}}}
859 Returns the default font and colours which are used by the control. This is
860 useful if you want to use the same font or colour in your own control as in a
861 standard control -- which is a much better idea than hard coding specific
862 colours or fonts which might look completely out of place on the users
863 system, especially if it uses themes.
865 The
\arg{variant
} parameter is only relevant under Mac currently and is
866 ignore under other platforms. Under Mac, it will change the size of the
867 returned font. See
\helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}
870 This static method is ``overridden'' in many derived classes and so calling,
871 for example,
\helpref{wxButton
}{wxbutton
}::GetClassDefaultAttributes() will typically
872 return the values appropriate for a button which will be normally different
873 from those returned by, say,
\helpref{wxListCtrl
}{wxlistctrl
}::GetClassDefaultAttributes().
875 The
\texttt{wxVisualAttributes
} structure has at least the fields
876 \texttt{font
},
\texttt{colFg
} and
\texttt{colBg
}. All of them may be invalid
877 if it was not possible to determine the default control appearance or,
878 especially for the background colour, if the field doesn't make sense as is
879 the case for
\texttt{colBg
} for the controls with themed background.
883 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
886 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
888 \constfunc{void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
890 \perlnote{In wxPerl this method takes no parameter and returns
891 a
2-element list
{\tt (width, height)
}.
}
893 \constfunc{wxSize
}{GetClientSize
}{\void}
895 Returns the size of the window `client area' in pixels. The client area is the
896 area which may be drawn on by the programmer, excluding title bar, border,
899 Note that if this window is a top-level one and it is currently minimized, the
900 return size is empty (both width and height are $
0$).
902 \wxheading{Parameters
}
904 \docparam{width
}{Receives the client width in pixels.
}
906 \docparam{height
}{Receives the client height in pixels.
}
908 \pythonnote{In place of a single overloaded method name, wxPython
909 implements the following methods:
\par
910 \indented{2cm
}{\begin{twocollist
}
911 \twocolitem{{\bf GetClientSizeTuple()
}}{Returns a
2-tuple of (width, height)
}
912 \twocolitem{{\bf GetClientSize()
}}{Returns a wxSize object
}
918 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
919 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
923 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
925 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
927 Returns a pointer to the window's layout constraints, or NULL if there are none.
930 \membersection{wxWindow::GetContainingSizer
}\label{wxwindowgetcontainingsizer
}
932 \constfunc{const wxSizer *
}{GetContainingSizer
}{\void}
934 Return the sizer that this window is a member of, if any, otherwise
938 \membersection{wxWindow::GetCursor
}\label{wxwindowgetcursor
}
940 \constfunc{const wxCursor\&
}{GetCursor
}{\void}
942 Return the cursor associated with this window.
946 \helpref{wxWindow::SetCursor
}{wxwindowsetcursor
}
949 \membersection{wxWindow::GetDefaultAttributes
}\label{wxwindowgetdefaultattributes
}
951 \constfunc{virtual wxVisualAttributes
}{GetDefaultAttributes
}{\void}
953 Currently this is the same as calling
954 \helpref{GetClassDefaultAttributes
}{wxwindowgetclassdefaultattributes
}(
\helpref{GetWindowVariant
}{wxwindowgetwindowvariant
}()).
956 One advantage of using this function compared to the static version is that
957 the call is automatically dispatched to the correct class (as usual with
958 virtual functions) and you don't have to specify the class name explicitly.
960 The other one is that in the future this function could return different
961 results, for example it might return a different font for an ``Ok'' button
962 than for a generic button if the users GUI is configured to show such buttons
963 in bold font. Of course, the down side is that it is impossible to call this
964 function without actually having an object to apply it to whereas the static
965 version can be used without having to create an object first.
968 \membersection{wxWindow::GetDropTarget
}\label{wxwindowgetdroptarget
}
970 \constfunc{wxDropTarget*
}{GetDropTarget
}{\void}
972 Returns the associated drop target, which may be NULL.
976 \helpref{wxWindow::SetDropTarget
}{wxwindowsetdroptarget
},
977 \helpref{Drag and drop overview
}{wxdndoverview
}
980 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
982 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
984 Returns the event handler for this window. By default, the window is its
989 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
990 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
991 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
992 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
993 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
996 \membersection{wxWindow::GetExtraStyle
}\label{wxwindowgetextrastyle
}
998 \constfunc{long
}{GetExtraStyle
}{\void}
1000 Returns the extra style bits for the window.
1003 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
1005 \constfunc{wxFont
}{GetFont
}{\void}
1007 Returns the font for this window.
1009 \wxheading{See also
}
1011 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
1014 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
1016 \func{virtual wxColour
}{GetForegroundColour
}{\void}
1018 Returns the foreground colour of the window.
1022 The interpretation of foreground colour is open to interpretation according
1023 to the window class; it may be the text colour or other colour, or it may not
1026 \wxheading{See also
}
1028 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
1029 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
1030 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
1033 \membersection{wxWindow::GetGrandParent
}\label{wxwindowgetgrandparent
}
1035 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
1037 Returns the grandparent of a window, or NULL if there isn't one.
1040 \membersection{wxWindow::GetHandle
}\label{wxwindowgethandle
}
1042 \constfunc{void*
}{GetHandle
}{\void}
1044 Returns the platform-specific handle of the physical window. Cast it to an appropriate
1045 handle, such as
{\bf HWND
} for Windows,
{\bf Widget
} for Motif,
{\bf GtkWidget
} for GTK or
{\bf WinHandle
} for PalmOS.
1047 \pythonnote{This method will return an integer in wxPython.
}
1049 \perlnote{This method will return an integer in wxPerl.
}
1052 \membersection{wxWindow::GetHelpTextAtPoint
}\label{wxwindowgethelptextatpoint
}
1054 \constfunc{virtual wxString
}{GetHelpTextAtPoint
}{\param{const wxPoint &
}{point
},
\param{wxHelpEvent::Origin
}{origin
}}
1056 Gets the help text to be used as context-sensitive help for this window. This
1057 method should be overridden if the help message depends on the position inside
1058 the window, otherwise
\helpref{GetHelpText
}{wxwindowgethelptext
} can be used.
1060 \wxheading{Parameters
}
1062 \docparam{point
}{Coordinates of the mouse at the moment of help event emission.
}
1064 \docparam{origin
}{Help event origin, see also
\helpref{wxHelpEvent::GetOrigin
}{wxhelpeventgetorigin
}.
}
1069 \membersection{wxWindow::GetHelpText
}\label{wxwindowgethelptext
}
1071 \constfunc{virtual wxString
}{GetHelpText
}{\void}
1073 Gets the help text to be used as context-sensitive help for this window.
1075 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
1076 and not in the window object itself.
1078 \wxheading{See also
}
1080 \helpref{SetHelpText
}{wxwindowsethelptext
},
\helpref{GetHelpTextAtPoint
}{wxwindowgethelptextatpoint
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
1083 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
1085 \constfunc{int
}{GetId
}{\void}
1087 Returns the identifier of the window.
1091 Each window has an integer identifier. If the application has not provided one
1092 (or the default wxID
\_ANY) an unique identifier with a negative value will be generated.
1094 \wxheading{See also
}
1096 \helpref{wxWindow::SetId
}{wxwindowsetid
},
\rtfsp
1097 \helpref{Window identifiers
}{windowids
}
1100 \membersection{wxWindow::GetLabel
}\label{wxwindowgetlabel
}
1102 \constfunc{virtual wxString
}{GetLabel
}{\void}
1104 Generic way of getting a label from any window, for
1105 identification purposes.
1109 The interpretation of this function differs from class to class.
1110 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
1111 the button text. This function can be useful for meta-programs (such as testing
1112 tools or special-needs access programs) which need to identify windows
1115 \membersection{wxWindow::GetMaxSize
}\label{wxwindowgetmaxsize
}
1117 \constfunc{wxSize
}{GetMaxSize
}{\void}
1119 Returns the maximum size of the window, an indication to the sizer layout mechanism
1120 that this is the maximum possible size.
1122 \membersection{wxWindow::GetMinSize
}\label{wxwindowgetminsize
}
1124 \constfunc{virtual wxSize
}{GetMinSize
}{\void}
1126 Returns the minimum size of the window, an indication to the sizer layout mechanism
1127 that this is the minimum required size. It normally just returns the value set
1128 by
\helpref{SetMinSize
}{wxwindowsetminsize
}, but it can be overridden to do the
1129 calculation on demand.
1131 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
1133 \constfunc{virtual wxString
}{GetName
}{\void}
1135 Returns the window's name.
1139 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
1140 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
1142 \wxheading{See also
}
1144 \helpref{wxWindow::SetName
}{wxwindowsetname
}
1147 \membersection{wxWindow::GetParent
}\label{wxwindowgetparent
}
1149 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
1151 Returns the parent of the window, or NULL if there is no parent.
1154 \membersection{wxWindow::GetPosition
}\label{wxwindowgetposition
}
1156 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
1158 \constfunc{wxPoint
}{GetPosition
}{\void}
1160 This gets the position of the window in pixels, relative to the parent window
1161 for the child windows or relative to the display origin for the top level
1164 \wxheading{Parameters
}
1166 \docparam{x
}{Receives the x position of the window if non-
\NULL.
}
1168 \docparam{y
}{Receives the y position of the window if non-
\NULL.
}
1170 \pythonnote{In place of a single overloaded method name, wxPython
1171 implements the following methods:
\par
1172 \indented{2cm
}{\begin{twocollist
}
1173 \twocolitem{{\bf GetPosition()
}}{Returns a wxPoint
}
1174 \twocolitem{{\bf GetPositionTuple()
}}{Returns a tuple (x, y)
}
1178 \perlnote{In wxPerl there are two methods instead of a single overloaded
1180 \indented{2cm
}{\begin{twocollist
}
1181 \twocolitem{{\bf GetPosition()
}}{Returns a Wx::Point
}
1182 \twocolitem{{\bf GetPositionXY()
}}{Returns a
2-element list
1188 \wxheading{See also
}
1190 \helpref{GetScreenPosition
}{wxwindowgetscreenposition
}
1193 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
1195 \constfunc{virtual wxRect
}{GetRect
}{\void}
1197 Returns the position and size of the window as a
\helpref{wxRect
}{wxrect
} object.
1199 \wxheading{See also
}
1201 \helpref{GetScreenRect
}{wxwindowgetscreenrect
}
1204 \membersection{wxWindow::GetScreenPosition
}\label{wxwindowgetscreenposition
}
1206 \constfunc{virtual void
}{GetScreenPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
1208 \constfunc{wxPoint
}{GetScreenPosition
}{\void}
1210 Returns the window position in screen coordinates, whether the window is a
1211 child window or a top level one.
1213 \wxheading{Parameters
}
1215 \docparam{x
}{Receives the x position of the window on the screen if non-
\NULL.
}
1217 \docparam{y
}{Receives the y position of the window on the screen if non-
\NULL.
}
1219 \wxheading{See also
}
1221 \helpref{GetPosition
}{wxwindowgetposition
}
1224 \membersection{wxWindow::GetScreenRect
}\label{wxwindowgetscreenrect
}
1226 \constfunc{virtual wxRect
}{GetScreenRect
}{\void}
1228 Returns the position and size of the window on the screen as a
1229 \helpref{wxRect
}{wxrect
} object.
1231 \wxheading{See also
}
1233 \helpref{GetRect
}{wxwindowgetrect
}
1236 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
1238 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
1240 Returns the built-in scrollbar position.
1242 \wxheading{See also
}
1244 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1247 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
1249 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
1251 Returns the built-in scrollbar range.
1253 \wxheading{See also
}
1255 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1258 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
1260 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
1262 Returns the built-in scrollbar thumb size.
1264 \wxheading{See also
}
1266 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1269 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
1271 \constfunc{void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1273 \constfunc{wxSize
}{GetSize
}{\void}
1275 Returns the size of the entire window in pixels, including title bar, border,
1278 Note that if this window is a top-level one and it is currently minimized, the
1279 returned size is the restored window size, not the size of the window icon.
1281 \wxheading{Parameters
}
1283 \docparam{width
}{Receives the window width.
}
1285 \docparam{height
}{Receives the window height.
}
1287 \pythonnote{In place of a single overloaded method name, wxPython
1288 implements the following methods:
\par
1289 \indented{2cm
}{\begin{twocollist
}
1290 \twocolitem{{\bf GetSize()
}}{Returns a wxSize
}
1291 \twocolitem{{\bf GetSizeTuple()
}}{Returns a
2-tuple (width, height)
}
1295 \perlnote{In wxPerl there are two methods instead of a single overloaded
1297 \indented{2cm
}{\begin{twocollist
}
1298 \twocolitem{{\bf GetSize()
}}{Returns a Wx::Size
}
1299 \twocolitem{{\bf GetSizeWH()
}}{Returns a
2-element list
1300 {\tt ( width, height )
}}
1304 \wxheading{See also
}
1306 \helpref{GetClientSize
}{wxwindowgetclientsize
},
\rtfsp
1307 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
1310 \membersection{wxWindow::GetSizer
}\label{wxwindowgetsizer
}
1312 \constfunc{wxSizer *
}{GetSizer
}{\void}
1314 Return the sizer associated with the window by a previous call to
1315 \helpref{SetSizer()
}{wxwindowsetsizer
} or
{\tt NULL
}.
1318 \membersection{wxWindow::GetTextExtent
}\label{wxwindowgettextextent
}
1320 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{w
},
\param{int*
}{h
},
1321 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
1322 \param{const wxFont*
}{font = NULL
},
\param{bool
}{ use16 =
{\tt false
}}}
1324 \constfunc{wxSize
}{GetTextExtent
}{\param{const wxString\&
}{string
}}
1326 Gets the dimensions of the string as it would be drawn on the
1327 window with the currently selected font.
1329 The text extent is returned in
\arg{w
} and
\arg{h
} pointers (first form) or as a
1330 \helpref{wxSize
}{wxsize
} object (second form).
1332 \wxheading{Parameters
}
1334 \docparam{string
}{String whose extent is to be measured.
}
1336 \docparam{w
}{Return value for width.
}
1338 \docparam{h
}{Return value for height.
}
1340 \docparam{descent
}{Return value for descent (optional).
}
1342 \docparam{externalLeading
}{Return value for external leading (optional).
}
1344 \docparam{font
}{Font to use instead of the current window font (optional).
}
1346 \docparam{use16
}{If
{\tt true
},
{\it string
} contains
16-bit characters. The default is
{\tt false
}.
}
1348 \pythonnote{In place of a single overloaded method name, wxPython
1349 implements the following methods:
\par
1350 \indented{2cm
}{\begin{twocollist
}
1351 \twocolitem{{\bf GetTextExtent(string)
}}{Returns a
2-tuple, (width, height)
}
1352 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)
}}{Returns a
1353 4-tuple, (width, height, descent, externalLeading)
}
1357 \perlnote{In wxPerl this method takes only the
{\tt string
} and optionally
1358 {\tt font
} parameters, and returns a
4-element list
1359 {\tt ( x, y, descent, externalLeading )
}.
}
1362 \membersection{wxWindow::GetToolTip
}\label{wxwindowgettooltip
}
1364 \constfunc{wxToolTip*
}{GetToolTip
}{\void}
1366 Get the associated tooltip or NULL if none.
1369 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
1371 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
1373 Returns the region specifying which parts of the window have been damaged. Should
1374 only be called within an
\helpref{wxPaintEvent
}{wxpaintevent
} handler.
1376 \wxheading{See also
}
1378 \helpref{wxRegion
}{wxregion
},
\rtfsp
1379 \helpref{wxRegionIterator
}{wxregioniterator
}
1382 \membersection{wxWindow::GetValidator
}\label{wxwindowgetvalidator
}
1384 \constfunc{wxValidator*
}{GetValidator
}{\void}
1386 Returns a pointer to the current validator for the window, or NULL if there is none.
1389 \membersection{wxWindow::GetVirtualSize
}\label{wxwindowgetvirtualsize
}
1391 \constfunc{void
}{GetVirtualSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1393 \constfunc{wxSize
}{GetVirtualSize
}{\void}
1395 This gets the virtual size of the window in pixels. By default it
1396 returns the client size of the window, but after a call to
1397 \helpref{SetVirtualSize
}{wxwindowsetvirtualsize
} it will return
1400 \wxheading{Parameters
}
1402 \docparam{width
}{Receives the window virtual width.
}
1404 \docparam{height
}{Receives the window virtual height.
}
1406 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
1407 \helpref{GetClientSize
}{wxwindowgetclientsize
}
1410 \membersection{wxWindow::GetWindowBorderSize
}\label{wxwindowgetwindowbordersize
}
1412 \constfunc{wxSize
}{GetWindowBorderSize
}{\void}
1414 Returns the size of the left/right and top/bottom borders of this window in x
1415 and y components of the result respectively.
1418 \membersection{wxWindow::GetWindowStyleFlag
}\label{wxwindowgetwindowstyleflag
}
1420 \constfunc{long
}{GetWindowStyleFlag
}{\void}
1422 Gets the window style that was passed to the constructor or
{\bf Create
}
1423 method.
{\bf GetWindowStyle()
} is another name for the same function.
1426 \membersection{wxWindow::GetWindowVariant
}\label{wxwindowgetwindowvariant
}
1428 \constfunc{wxWindowVariant
}{GetWindowVariant
}{\void}
1430 Returns the value previously passed to
1431 \helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}.
1434 \membersection{wxWindow::HasCapture
}\label{wxwindowhascapture
}
1436 \constfunc{virtual bool
}{HasCapture
}{\void}
1438 Returns
{\tt true
} if this window has the current mouse capture.
1440 \wxheading{See also
}
1442 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
1443 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
1444 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
1445 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
1448 \membersection{wxWindow::HasFlag
}\label{wxwindowhasflag
}
1450 \constfunc{bool
}{HasFlag
}{\param{int
}{flag
}}
1452 Returns
\texttt{true
} if the window has the given
\arg{flag
} bit set.
1455 \membersection{wxWindow::HasMultiplePages
}\label{wxwindowhasmultiplepages
}
1457 \constfunc{virtual bool
}{HasMultiplePages
}{\void}
1459 This method should be overridden to return
\texttt{true
} if this window has
1460 multiple pages. All standard class with multiple pages such as
1461 \helpref{wxNotebook
}{wxnotebook
},
\helpref{wxListbook
}{wxlistbook
} and
1462 \helpref{wxTreebook
}{wxtreebook
} already override it to return
\texttt{true
}
1463 and user-defined classes with similar behaviour should do it as well to allow
1464 the library to handle such windows appropriately.
1467 \membersection{wxWindow::HasScrollbar
}\label{wxwindowhasscrollbar
}
1469 \constfunc{virtual bool
}{HasScrollbar
}{\param{int
}{orient
}}
1471 Returns
{\tt true
} if this window has a scroll bar for this orientation.
1473 \wxheading{Parameters
}
1475 \docparam{orient
}{Orientation to check, either
{\tt wxHORIZONTAL
} or
{\tt wxVERTICAL
}.
}
1478 \membersection{wxWindow::HasTransparentBackground
}\label{wxwindowhastransparentbackground
}
1480 \constfunc{virtual bool
}{HasTransparentBackground
}{\void}
1482 Returns
\true if this window background is transparent (as, for example, for
1483 wxStaticText) and should show the parent window background.
1485 This method is mostly used internally by the library itself and you normally
1486 shouldn't have to call it. You may, however, have to override it in your
1487 wxWindow-derived class to ensure that background is painted correctly.
1490 \membersection{wxWindow::Hide
}\label{wxwindowhide
}
1492 \func{bool
}{Hide
}{\void}
1494 Equivalent to calling
\helpref{Show
}{wxwindowshow
}(
{\tt false
}).
1497 \membersection{wxWindow::InheritAttributes
}\label{wxwindowinheritattributes
}
1499 \func{void
}{InheritAttributes
}{\void}
1501 This function is (or should be, in case of custom controls) called during
1502 window creation to intelligently set up the window visual attributes, that is
1503 the font and the foreground and background colours.
1505 By ``intelligently'' the following is meant: by default, all windows use their
1506 own
\helpref{default
}{wxwindowgetclassdefaultattributes
} attributes. However
1507 if some of the parents attributes are explicitly (that is, using
1508 \helpref{SetFont
}{wxwindowsetfont
} and not
1509 \helpref{SetOwnFont
}{wxwindowsetownfont
}) changed
\emph{and
} if the
1510 corresponding attribute hadn't been explicitly set for this window itself,
1511 then this window takes the same value as used by the parent. In addition, if
1512 the window overrides
\helpref{ShouldInheritColours
}{wxwindowshouldinheritcolours
}
1513 to return
\false, the colours will not be changed no matter what and only the
1516 This rather complicated logic is necessary in order to accommodate the
1517 different usage scenarios. The most common one is when all default attributes
1518 are used and in this case, nothing should be inherited as in modern GUIs
1519 different controls use different fonts (and colours) than their siblings so
1520 they can't inherit the same value from the parent. However it was also deemed
1521 desirable to allow to simply change the attributes of all children at once by
1522 just changing the font or colour of their common parent, hence in this case we
1523 do inherit the parents attributes.
1526 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
1528 \func{void
}{InitDialog
}{\void}
1530 Sends an
{\tt wxEVT
\_INIT\_DIALOG} event, whose handler usually transfers data
1531 to the dialog via validators.
1534 \membersection{wxWindow::InvalidateBestSize
}\label{wxwindowinvalidatebestsize
}
1536 \func{void
}{InvalidateBestSize
}{\void}
1538 Resets the cached best size value so it will be recalculated the next time it is needed.
1541 \membersection{wxWindow::IsDoubleBuffered
}\label{wxwindowisdoublebuffered
}
1543 \constfunc{virtual bool
}{IsDoubleBuffered
}{\void}
1545 Returns
\true if the window contents is double-buffered by the system, i.e. if
1546 any drawing done on the window is really done on a temporary backing surface
1547 and transferred to the screen all at once later.
1549 \wxheading{See also
}
1551 \helpref{wxBufferedDC
}{wxbuffereddc
}
1554 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
1556 \constfunc{virtual bool
}{IsEnabled
}{\void}
1558 Returns
\true if the window is enabled, i.e. if it accepts user input,
\false
1561 Notice that this method can return
\false even if this window itself hadn't
1562 been explicitly disabled when one of its parent windows is disabled. To get the
1563 intrinsic status of this window, use
1564 \helpref{IsThisEnabled
}{wxwindowisthisenabled
}
1566 \wxheading{See also
}
1568 \helpref{wxWindow::Enable
}{wxwindowenable
}
1571 \membersection{wxWindow::IsExposed
}\label{wxwindowisexposed
}
1573 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
}}
1575 \constfunc{bool
}{IsExposed
}{\param{wxPoint
}{\&pt
}}
1577 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
},
\param{int
}{w
},
\param{int
}{h
}}
1579 \constfunc{bool
}{IsExposed
}{\param{wxRect
}{\&rect
}}
1581 Returns
{\tt true
} if the given point or rectangle area has been exposed since the
1582 last repaint. Call this in an paint event handler to optimize redrawing by
1583 only redrawing those areas, which have been exposed.
1585 \pythonnote{In place of a single overloaded method name, wxPython
1586 implements the following methods:
\par
1587 \indented{2cm
}{\begin{twocollist
}
1588 \twocolitem{{\bf IsExposed(x,y, w=
0,h=
0)
}}{}
1589 \twocolitem{{\bf IsExposedPoint(pt)
}}{}
1590 \twocolitem{{\bf IsExposedRect(rect)
}}{}
1594 \membersection{wxWindow::IsFrozen
}\label{wxwindowisfrozen
}
1596 \constfunc{virtual bool
}{IsFrozen
}{\void}
1598 Returns
\true if the window is currently frozen by a call to
1599 \helpref{Freeze()
}{wxwindowfreeze
}.
1601 \wxheading{See also
}
1603 \helpref{Thaw()
}{wxwindowthaw
}
1606 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
1608 \constfunc{virtual bool
}{IsRetained
}{\void}
1610 Returns
{\tt true
} if the window is retained,
{\tt false
} otherwise.
1614 Retained windows are only available on X platforms.
1617 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
1619 \constfunc{virtual bool
}{IsShown
}{\void}
1621 Returns
{\tt true
} if the window is shown,
{\tt false
} if it has been hidden.
1623 \wxheading{See also
}
1625 \helpref{wxWindow::IsShownOnScreen
}{wxwindowisshownonscreen
}
1628 \membersection{wxWindow::IsShownOnScreen
}\label{wxwindowisshownonscreen
}
1630 \constfunc{virtual bool
}{IsShownOnScreen
}{\void}
1632 Returns
{\tt true
} if the window is physically visible on the screen, i.e. it
1633 is shown and all its parents up to the toplevel window are shown as well.
1635 \wxheading{See also
}
1637 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
1640 \membersection{wxWindow::IsThisEnabled
}\label{wxwindowisthisenabled
}
1642 \constfunc{bool
}{IsThisEnabled
}{\void}
1644 Returns
\true if this window is intrinsically enabled,
\false otherwise, i.e.
1645 if
\helpref{Enable(false)
}{wxwindowenable
} had been called. This method is
1646 mostly used for wxWidgets itself, user code should normally use
1647 \helpref{IsEnabled
}{wxwindowisenabled
} instead.
1650 \membersection{wxWindow::IsTopLevel
}\label{wxwindowistoplevel
}
1652 \constfunc{bool
}{IsTopLevel
}{\void}
1654 Returns
{\tt true
} if the given window is a top-level one. Currently all frames and
1655 dialogs are considered to be top-level windows (even if they have a parent
1659 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
1661 \func{void
}{Layout
}{\void}
1663 Invokes the constraint-based layout algorithm or the sizer-based algorithm
1666 See
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
}: when auto
1667 layout is on, this function gets called automatically when the window is resized.
1670 \membersection{wxWindow::LineDown
}\label{wxwindowlinedown
}
1672 This is just a wrapper for
\helpref{ScrollLines
}{wxwindowscrolllines
}$(
1)$.
1675 \membersection{wxWindow::LineUp
}\label{wxwindowlineup
}
1677 This is just a wrapper for
\helpref{ScrollLines
}{wxwindowscrolllines
}$(-
1)$.
1680 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
1682 \func{void
}{Lower
}{\void}
1684 Lowers the window to the bottom of the window hierarchy (z-order).
1686 \wxheading{See also
}
1688 \helpref{Raise
}{wxwindowraise
}
1691 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
1693 \func{virtual void
}{MakeModal
}{\param{bool
}{flag
}}
1695 Disables all other windows in the application so that
1696 the user can only interact with this window.
1698 \wxheading{Parameters
}
1700 \docparam{flag
}{If
{\tt true
}, this call disables all other windows in the application so that
1701 the user can only interact with this window. If
{\tt false
}, the effect is reversed.
}
1704 \membersection{wxWindow::Move
}\label{wxwindowmove
}
1706 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
1708 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
1710 Moves the window to the given position.
1712 \wxheading{Parameters
}
1714 \docparam{x
}{Required x position.
}
1716 \docparam{y
}{Required y position.
}
1718 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
1722 Implementations of SetSize can also implicitly implement the
1723 wxWindow::Move function, which is defined in the base wxWindow class
1727 SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
1730 \wxheading{See also
}
1732 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
1734 \pythonnote{In place of a single overloaded method name, wxPython
1735 implements the following methods:
\par
1736 \indented{2cm
}{\begin{twocollist
}
1737 \twocolitem{{\bf Move(point)
}}{Accepts a wxPoint
}
1738 \twocolitem{{\bf MoveXY(x, y)
}}{Accepts a pair of integers
}
1743 \membersection{wxWindow::MoveAfterInTabOrder
}\label{wxwindowmoveafterintaborder
}
1745 \func{void
}{MoveAfterInTabOrder
}{\param{wxWindow *
}{win
}}
1747 Moves this window in the tab navigation order after the specified
\arg{win
}.
1748 This means that when the user presses
\texttt{TAB
} key on that other window,
1749 the focus switches to this window.
1751 Default tab order is the same as creation order, this function and
1752 \helpref{MoveBeforeInTabOrder()
}{wxwindowmovebeforeintaborder
} allow to change
1753 it after creating all the windows.
1755 \wxheading{Parameters
}
1757 \docparam{win
}{A sibling of this window which should precede it in tab order,
1761 \membersection{wxWindow::MoveBeforeInTabOrder
}\label{wxwindowmovebeforeintaborder
}
1763 \func{void
}{MoveBeforeInTabOrder
}{\param{wxWindow *
}{win
}}
1765 Same as
\helpref{MoveAfterInTabOrder
}{wxwindowmoveafterintaborder
} except that
1766 it inserts this window just before
\arg{win
} instead of putting it right after
1770 \membersection{wxWindow::Navigate
}\label{wxwindownavigate
}
1772 \func{bool
}{Navigate
}{\param{int
}{ flags = wxNavigationKeyEvent::IsForward
}}
1774 Performs a keyboard navigation action starting from this window. This method is
1775 equivalent to calling
\helpref{NavigateIn()
}{wxwindownavigatein
} method on the
1778 \wxheading{Parameters
}
1780 \docparam{flags
}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.
}
1782 \wxheading{Return value
}
1784 Returns
\true if the focus was moved to another window or
\false if nothing
1789 You may wish to call this from a text control custom keypress handler to do the default
1790 navigation behaviour for the tab key, since the standard default behaviour for
1791 a multiline text control with the wxTE
\_PROCESS\_TAB style is to insert a tab
1792 and not navigate to the next control.
1795 \membersection{wxWindow::NavigateIn
}\label{wxwindownavigatein
}
1797 \func{bool
}{NavigateIn
}{\param{int
}{ flags = wxNavigationKeyEvent::IsForward
}}
1799 Performs a keyboard navigation action inside this window.
1801 See
\helpref{Navigate
}{wxwindownavigate
} for more information.
1804 \membersection{wxWindow::NextControlId
}\label{wxwindownextcontrolid
}
1806 \func{static int
}{NextControlId
}{\param{int
}{winid
}}
1808 If two controls are created consecutively using
\texttt{wxID
\_ANY} id, this
1809 function allows to retrieve the effective id of the latter control from the id
1810 of the former. This is useful for example to find the control following its
1811 \helpref{wxStaticText
}{wxstatictext
} label if only the id of or pointer to the
1812 label is available to the caller but it is known that the two controls were
1815 \wxheading{See also
}
1817 \helpref{PrevControlId
}{wxwindowprevcontrolid
}
1820 %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving
1821 %% the old docs here in case we want to move any still needed bits to
1822 %% the right location (i.e. probably the corresponding events docs)
1824 %% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
1826 %% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
1828 %% Called when a window is activated or deactivated.
1830 %% \wxheading{Parameters}
1832 %% \docparam{event}{Object containing activation information.}
1834 %% \wxheading{Remarks}
1836 %% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt true},
1837 %% otherwise it returns {\tt false} (it is being deactivated).
1839 %% \wxheading{See also}
1841 %% \helpref{wxActivateEvent}{wxactivateevent},\rtfsp
1842 %% \helpref{Event handling overview}{eventhandlingoverview}
1844 %% \membersection{wxWindow::OnChar}\label{wxwindowonchar}
1846 %% \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
1848 %% Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
1850 %% \wxheading{Parameters}
1852 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1853 %% details about this class.}
1855 %% \wxheading{Remarks}
1857 %% This member function is called in response to a keypress. To intercept this event,
1858 %% use the EVT\_CHAR macro in an event table definition. Your {\bf OnChar} handler may call this
1859 %% default function to achieve default keypress functionality.
1861 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1864 %% Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1865 %% keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1866 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1868 %% Most, but not all, windows allow keypresses to be intercepted.
1870 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1871 %% otherwise menu shortcuts may cease to work under Windows.
1873 %% \wxheading{See also}
1875 %% \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1876 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1877 %% \helpref{Event handling overview}{eventhandlingoverview}
1879 %% \membersection{wxWindow::OnCharHook}\label{wxwindowoncharhook}
1881 %% \func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
1883 %% This member is called to allow the window to intercept keyboard events
1884 %% before they are processed by child windows.
1886 %% \wxheading{Parameters}
1888 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1889 %% details about this class.}
1891 %% \wxheading{Remarks}
1893 %% This member function is called in response to a keypress, if the window is active. To intercept this event,
1894 %% use the EVT\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
1895 %% keypress, call \helpref{wxEvent::Skip}{wxeventskip} to allow default processing.
1897 %% An example of using this function is in the implementation of escape-character processing for wxDialog,
1898 %% where pressing ESC dismisses the dialog by {\bf OnCharHook} 'forging' a cancel button press event.
1900 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1903 %% This function is only relevant to top-level windows (frames and dialogs), and under
1904 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
1905 %% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
1906 %% the window won't get the event.
1908 %% \wxheading{See also}
1910 %% \helpref{wxKeyEvent}{wxkeyevent},\rtfsp
1911 %% \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1912 %% %% GD: OnXXX functions are not documented
1913 %% %%\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp
1914 %% \helpref{Event handling overview}{eventhandlingoverview}
1916 %% \membersection{wxWindow::OnCommand}\label{wxwindowoncommand}
1918 %% \func{virtual void}{OnCommand}{\param{wxEvtHandler\& }{object}, \param{wxCommandEvent\& }{event}}
1920 %% This virtual member function is called if the control does not handle the command event.
1922 %% \wxheading{Parameters}
1924 %% \docparam{object}{Object receiving the command event.}
1926 %% \docparam{event}{Command event}
1928 %% \wxheading{Remarks}
1930 %% This virtual function is provided mainly for backward compatibility. You can also intercept commands
1931 %% from child controls by using an event table, with identifiers or identifier ranges to identify
1932 %% the control(s) in question.
1934 %% \wxheading{See also}
1936 %% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1937 %% \helpref{Event handling overview}{eventhandlingoverview}
1939 %% \membersection{wxWindow::OnClose}\label{wxwindowonclose}
1941 %% \func{virtual bool}{OnClose}{\void}
1943 %% Called when the user has tried to close a a frame
1944 %% or dialog box using the window manager (X) or system menu (Windows).
1946 %% {\bf Note:} This is an obsolete function.
1947 %% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
1950 %% \wxheading{Return value}
1952 %% If {\tt true} is returned by OnClose, the window will be deleted by the system, otherwise the
1953 %% attempt will be ignored. Do not delete the window from within this handler, although
1954 %% you may delete other windows.
1956 %% \wxheading{See also}
1958 %% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
1959 %% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
1960 %% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
1961 %% \helpref{wxCloseEvent}{wxcloseevent}
1963 %% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
1965 %% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
1967 %% Called when the user has pressed a key, before it is translated into an ASCII value using other
1968 %% modifier keys that might be pressed at the same time.
1970 %% \wxheading{Parameters}
1972 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1973 %% details about this class.}
1975 %% \wxheading{Remarks}
1977 %% This member function is called in response to a key down event. To intercept this event,
1978 %% use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this
1979 %% default function to achieve default keypress functionality.
1981 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
1982 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1983 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1985 %% Most, but not all, windows allow keypresses to be intercepted.
1987 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1988 %% otherwise menu shortcuts may cease to work under Windows.
1990 %% \wxheading{See also}
1992 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1993 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1994 %% \helpref{Event handling overview}{eventhandlingoverview}
1996 %% \membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup}
1998 %% \func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}}
2000 %% Called when the user has released a key.
2002 %% \wxheading{Parameters}
2004 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
2005 %% details about this class.}
2007 %% \wxheading{Remarks}
2009 %% This member function is called in response to a key up event. To intercept this event,
2010 %% use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this
2011 %% default function to achieve default keypress functionality.
2013 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
2014 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
2015 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
2017 %% Most, but not all, windows allow key up events to be intercepted.
2019 %% \wxheading{See also}
2021 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp
2022 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
2023 %% \helpref{Event handling overview}{eventhandlingoverview}
2025 %% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
2027 %% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
2029 %% Default handler for the wxEVT\_INIT\_DIALOG event. Calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
2031 %% \wxheading{Parameters}
2033 %% \docparam{event}{Dialog initialisation event.}
2035 %% \wxheading{Remarks}
2037 %% Gives the window the default behaviour of transferring data to child controls via
2038 %% the validator that each control has.
2040 %% \wxheading{See also}
2042 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
2044 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
2046 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
2048 %% Called when a menu select is received from a menu bar: that is, the
2049 %% mouse cursor is over a menu item, but the left mouse button has not been
2052 %% \wxheading{Parameters}
2054 %% \docparam{event}{The menu highlight event. For more information, see \helpref{wxMenuEvent}{wxmenuevent}.}
2056 %% \wxheading{Remarks}
2058 %% You can choose any member function to receive
2059 %% menu select events, using the EVT\_MENU\_HIGHLIGHT macro for individual menu items or EVT\_MENU\_HIGHLIGHT\_ALL macro
2060 %% for all menu items.
2062 %% The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
2063 %% text in the first field of the status bar.
2065 %% This function was known as {\bf OnMenuSelect} in earlier versions of wxWidgets, but this was confusing
2066 %% since a selection is normally a left-click action.
2068 %% \wxheading{See also}
2070 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
2071 %% \helpref{Event handling overview}{eventhandlingoverview}
2074 %% \membersection{wxWindow::OnMouseEvent}\label{wxwindowonmouseevent}
2076 %% \func{void}{OnMouseEvent}{\param{wxMouseEvent\&}{ event}}
2078 %% Called when the user has initiated an event with the
2081 %% \wxheading{Parameters}
2083 %% \docparam{event}{The mouse event. See \helpref{wxMouseEvent}{wxmouseevent} for
2086 %% \wxheading{Remarks}
2088 %% Most, but not all, windows respond to this event.
2090 %% To intercept this event, use the EVT\_MOUSE\_EVENTS macro in an event table definition, or individual
2091 %% mouse event macros such as EVT\_LEFT\_DOWN.
2093 %% \wxheading{See also}
2095 %% \helpref{wxMouseEvent}{wxmouseevent},\rtfsp
2096 %% \helpref{Event handling overview}{eventhandlingoverview}
2098 %% \membersection{wxWindow::OnMove}\label{wxwindowonmove}
2100 %% \func{void}{OnMove}{\param{wxMoveEvent\& }{event}}
2102 %% Called when a window is moved.
2104 %% \wxheading{Parameters}
2106 %% \docparam{event}{The move event. For more information, see \helpref{wxMoveEvent}{wxmoveevent}.}
2108 %% \wxheading{Remarks}
2110 %% Use the EVT\_MOVE macro to intercept move events.
2112 %% \wxheading{Remarks}
2114 %% Not currently implemented.
2116 %% \wxheading{See also}
2118 %% \helpref{wxMoveEvent}{wxmoveevent},\rtfsp
2119 %% \helpref{wxFrame::OnSize}{wxframeonsize},\rtfsp
2120 %% \helpref{Event handling overview}{eventhandlingoverview}
2122 %% \membersection{wxWindow::OnPaint}\label{wxwindowonpaint}
2124 %% \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
2126 %% Sent to the event handler when the window must be refreshed.
2128 %% \wxheading{Parameters}
2130 %% \docparam{event}{Paint event. For more information, see \helpref{wxPaintEvent}{wxpaintevent}.}
2132 %% \wxheading{Remarks}
2134 %% Use the EVT\_PAINT macro in an event table definition to intercept paint events.
2136 %% Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
2137 %% even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
2143 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2145 %% wxPaintDC dc(this);
2147 %% DrawMyDocument(dc);
2152 %% You can optimize painting by retrieving the rectangles
2153 %% that have been damaged and only repainting these. The rectangles are in
2154 %% terms of the client area, and are unscrolled, so you will need to do
2155 %% some calculations using the current view position to obtain logical,
2158 %% Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
2162 %% // Called when window needs to be repainted.
2163 %% void MyWindow::OnPaint(wxPaintEvent\& event)
2165 %% wxPaintDC dc(this);
2167 %% // Find Out where the window is scrolled to
2168 %% int vbX,vbY; // Top left corner of client
2169 %% GetViewStart(&vbX,&vbY);
2171 %% int vX,vY,vW,vH; // Dimensions of client area in pixels
2172 %% wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
2181 %% // Alternatively we can do this:
2183 %% // upd.GetRect(&rect);
2185 %% // Repaint this rectangle
2194 %% \wxheading{See also}
2196 %% \helpref{wxPaintEvent}{wxpaintevent},\rtfsp
2197 %% \helpref{wxPaintDC}{wxpaintdc},\rtfsp
2198 %% \helpref{Event handling overview}{eventhandlingoverview}
2200 %% \membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
2202 %% \func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
2204 %% Called when a scroll window event is received from one of the window's built-in scrollbars.
2206 %% \wxheading{Parameters}
2208 %% \docparam{event}{Command event. Retrieve the new scroll position by
2209 %% calling \helpref{wxScrollEvent::GetPosition}{wxscrolleventgetposition}, and the
2210 %% scrollbar orientation by calling \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}.}
2212 %% \wxheading{Remarks}
2214 %% Note that it is not possible to distinguish between horizontal and vertical scrollbars
2215 %% until the function is executing (you can't have one function for vertical, another
2216 %% for horizontal events).
2218 %% \wxheading{See also}
2220 %% \helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp
2221 %% \helpref{Event handling overview}{eventhandlingoverview}
2223 %% \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus}
2225 %% \func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
2227 %% Called when a window's focus is being set.
2229 %% \wxheading{Parameters}
2231 %% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
2233 %% \wxheading{Remarks}
2235 %% To intercept this event, use the macro EVT\_SET\_FOCUS in an event table definition.
2237 %% Most, but not all, windows respond to this event.
2239 %% \wxheading{See also}
2241 %% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
2242 %% \helpref{Event handling overview}{eventhandlingoverview}
2244 %% \membersection{wxWindow::OnSize}\label{wxwindowonsize}
2246 %% \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
2248 %% Called when the window has been resized. This is not a virtual function; you should
2249 %% provide your own non-virtual OnSize function and direct size events to it using EVT\_SIZE
2250 %% in an event table definition.
2252 %% \wxheading{Parameters}
2254 %% \docparam{event}{Size event. For more information, see \helpref{wxSizeEvent}{wxsizeevent}.}
2256 %% \wxheading{Remarks}
2258 %% You may wish to use this for frames to resize their child windows as appropriate.
2260 %% Note that the size passed is of
2261 %% the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
2262 %% used by the application.
2264 %% When a window is resized, usually only a small part of the window is damaged and you
2265 %% may only need to repaint that area. However, if your drawing depends on the size of the window,
2266 %% you may need to clear the DC explicitly and repaint the whole window. In which case, you
2267 %% may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
2269 %% \wxheading{See also}
2271 %% \helpref{wxSizeEvent}{wxsizeevent},\rtfsp
2272 %% \helpref{Event handling overview}{eventhandlingoverview}
2274 %% \membersection{wxWindow::OnSysColourChanged}\label{wxwindowonsyscolourchanged}
2276 %% \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}}
2278 %% Called when the user has changed the system colours. Windows only.
2280 %% \wxheading{Parameters}
2282 %% \docparam{event}{System colour change event. For more information, see \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}.}
2284 %% \wxheading{See also}
2286 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
2287 %% \helpref{Event handling overview}{eventhandlingoverview}
2290 \membersection{wxWindow::OnInternalIdle
}\label{wxwindowoninternalidle
}
2292 \func{virtual void
}{OnInternalIdle
}{\void}
2294 This virtual function is normally only used internally, but
2295 sometimes an application may need it to implement functionality
2296 that should not be disabled by an application defining an OnIdle
2297 handler in a derived class.
2299 This function may be used to do delayed painting, for example,
2300 and most implementations call
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
2301 in order to send update events to the window in idle time.
2304 \membersection{wxWindow::PageDown
}\label{wxwindowpagedown
}
2306 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(
1)$.
2309 \membersection{wxWindow::PageUp
}\label{wxwindowpageup
}
2311 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(-
1)$.
2314 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
2316 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler =
{\tt false
}}}
2318 Removes and returns the top-most event handler on the event handler stack.
2320 \wxheading{Parameters
}
2322 \docparam{deleteHandler
}{If this is
{\tt true
}, the handler will be deleted after it is removed. The
2323 default value is
{\tt false
}.
}
2325 \wxheading{See also
}
2327 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2328 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2329 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2330 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2331 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
2334 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
2336 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{const wxPoint\&
}{pos = wxDefaultPosition
}}
2338 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
2340 Pops up the given menu at the specified coordinates, relative to this
2341 window, and returns control when the user has dismissed the menu. If a
2342 menu item is selected, the corresponding menu event is generated and will be
2343 processed as usually. If the coordinates are not specified, current mouse
2344 cursor position is used.
2346 \wxheading{Parameters
}
2348 \docparam{menu
}{Menu to pop up.
}
2350 \docparam{pos
}{The position where the menu will appear.
}
2352 \docparam{x
}{Required x position for the menu to appear.
}
2354 \docparam{y
}{Required y position for the menu to appear.
}
2356 \wxheading{See also
}
2358 \helpref{wxMenu
}{wxmenu
}
2362 Just before the menu is popped up,
\helpref{wxMenu::UpdateUI
}{wxmenuupdateui
}
2363 is called to ensure that the menu items are in the correct state. The menu does
2364 not get deleted by the window.
2366 It is recommended to not explicitly specify coordinates when calling PopupMenu
2367 in response to mouse click, because some of the ports (namely, wxGTK) can do
2368 a better job of positioning the menu in that case.
2370 \pythonnote{In place of a single overloaded method name, wxPython
2371 implements the following methods:
\par
2372 \indented{2cm
}{\begin{twocollist
}
2373 \twocolitem{{\bf PopupMenu(menu, point)
}}{Specifies position with a wxPoint
}
2374 \twocolitem{{\bf PopupMenuXY(menu, x, y)
}}{Specifies position with two integers (x, y)
}
2379 \membersection{wxWindow::PrevControlId
}\label{wxwindowprevcontrolid
}
2381 \func{static int
}{PrevControlId
}{\param{int
}{winid
}}
2383 This is similar to
\helpref{NextControlId
}{wxwindownextcontrolid
} but returns
2384 the id of the control created just before the one with the given
\arg{winid
}.
2387 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
2389 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2391 Pushes this event handler onto the event stack for the window.
2393 \wxheading{Parameters
}
2395 \docparam{handler
}{Specifies the handler to be pushed.
}
2399 An event handler is an object that is capable of processing the events
2400 sent to a window. By default, the window is its own event handler, but
2401 an application may wish to substitute another, for example to allow
2402 central implementation of event-handling for a variety of different
2405 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
2406 an application to set up a chain of event handlers, where an event not handled by one event handler is
2407 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
2408 remove the event handler.
2410 \wxheading{See also
}
2412 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2413 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2414 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2415 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2416 \helpref{wxEvtHandler
}{wxevthandler
}
2419 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
2421 \func{void
}{Raise
}{\void}
2423 Raises the window to the top of the window hierarchy (z-order).
2425 In current version of wxWidgets this works both for managed and child windows.
2427 \wxheading{See also
}
2429 \helpref{Lower
}{wxwindowlower
}
2432 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
2434 \func{virtual void
}{Refresh
}{\param{bool
}{ eraseBackground =
{\tt true
}},
\param{const wxRect*
}{rect = NULL
}}
2436 Causes this window, and all of its children recursively (except under wxGTK1
2437 where this is not implemented), to be repainted. Note that repainting doesn't
2438 happen immediately but only during the next event loop iteration, if you need
2439 to update the window immediately you should use
\helpref{Update
}{wxwindowupdate
}
2442 \wxheading{Parameters
}
2444 \docparam{eraseBackground
}{If
{\tt true
}, the background will be
2447 \docparam{rect
}{If non-NULL, only the given rectangle will
2448 be treated as damaged.
}
2450 \wxheading{See also
}
2452 \helpref{wxWindow::RefreshRect
}{wxwindowrefreshrect
}
2455 \membersection{wxWindow::RefreshRect
}\label{wxwindowrefreshrect
}
2457 \func{void
}{RefreshRect
}{\param{const wxRect\&
}{rect
},
\param{bool
}{eraseBackground =
\true}}
2459 Redraws the contents of the given rectangle: only the area inside it will be
2462 This is the same as
\helpref{Refresh
}{wxwindowrefresh
} but has a nicer syntax
2463 as it can be called with a temporary wxRect object as argument like this
2464 \texttt{RefreshRect(wxRect(x, y, w, h))
}.
2467 \membersection{wxWindow::RegisterHotKey
}\label{wxwindowregisterhotkey
}
2469 \func{bool
}{RegisterHotKey
}{\param{int
}{ hotkeyId
},
\param{int
}{ modifiers
},
\param{int
}{ virtualKeyCode
}}
2471 Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window
2472 will receive a hotkey event. It will receive the event even if the application is in the background
2473 and does not have the input focus because the user is working with some other application.
2475 \wxheading{Parameters
}
2477 \docparam{hotkeyId
}{Numeric identifier of the hotkey. For applications this must be between
0 and
0xBFFF. If
2478 this function is called from a shared DLL, it must be a system wide unique identifier between
0xC000 and
0xFFFF.
2479 This is a MSW specific detail.
}
2481 \docparam{modifiers
}{A bitwise combination of
{\tt wxMOD
\_SHIFT},
{\tt wxMOD
\_CONTROL},
{\tt wxMOD
\_ALT}
2482 or
{\tt wxMOD
\_WIN} specifying the modifier keys that have to be pressed along with the key.
}
2484 \docparam{virtualKeyCode
}{The virtual key code of the hotkey.
}
2486 \wxheading{Return value
}
2488 {\tt true
} if the hotkey was registered successfully.
{\tt false
} if some other application already registered a
2489 hotkey with this modifier/virtualKeyCode combination.
2493 Use EVT
\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
2494 This function is currently only implemented under Windows. It is used
2495 in the
\helpref{Windows CE port
}{wxwince
} for detecting hardware button presses.
2497 \wxheading{See also
}
2499 \helpref{wxWindow::UnregisterHotKey
}{wxwindowunregisterhotkey
}
2502 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
2504 \func{virtual void
}{ReleaseMouse
}{\void}
2506 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
2508 \wxheading{See also
}
2510 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
2511 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
2512 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
2513 \helpref{wxMouseCaptureLostEvent
}{wxmousecapturelostevent
}
2514 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
2517 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
2519 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
2521 Removes a child window. This is called automatically by window deletion
2522 functions so should not be required by the application programmer.
2524 Notice that this function is mostly internal to wxWidgets and shouldn't be
2525 called by the user code.
2527 \wxheading{Parameters
}
2529 \docparam{child
}{Child window to remove.
}
2532 \membersection{wxWindow::RemoveEventHandler
}\label{wxwindowremoveeventhandler
}
2534 \func{bool
}{RemoveEventHandler
}{\param{wxEvtHandler *
}{handler
}}
2536 Find the given
{\it handler
} in the windows event handler chain and remove (but
2537 not delete) it from it.
2539 \wxheading{Parameters
}
2541 \docparam{handler
}{The event handler to remove, must be non-
{\tt NULL
} and
2542 must be present in this windows event handlers chain
}
2544 \wxheading{Return value
}
2546 Returns
{\tt true
} if it was found and
{\tt false
} otherwise (this also results
2547 in an assert failure so this function should only be called when the
2548 handler is supposed to be there).
2550 \wxheading{See also
}
2552 \helpref{PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2553 \helpref{PopEventHandler
}{wxwindowpopeventhandler
}
2556 \membersection{wxWindow::Reparent
}\label{wxwindowreparent
}
2558 \func{virtual bool
}{Reparent
}{\param{wxWindow*
}{newParent
}}
2560 Reparents the window, i.e the window will be removed from its
2561 current parent window (e.g. a non-standard toolbar in a wxFrame)
2562 and then re-inserted into another.
2564 \wxheading{Parameters
}
2566 \docparam{newParent
}{New parent.
}
2569 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
2571 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
2573 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
2575 Converts from screen to client window coordinates.
2577 \wxheading{Parameters
}
2579 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
2581 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
2583 \docparam{pt
}{The screen position for the second form of the function.
}
2585 \pythonnote{In place of a single overloaded method name, wxPython
2586 implements the following methods:
\par
2587 \indented{2cm
}{\begin{twocollist
}
2588 \twocolitem{{\bf ScreenToClient(point)
}}{Accepts and returns a wxPoint
}
2589 \twocolitem{{\bf ScreenToClientXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
2594 \membersection{wxWindow::ScrollLines
}\label{wxwindowscrolllines
}
2596 \func{virtual bool
}{ScrollLines
}{\param{int
}{lines
}}
2598 Scrolls the window by the given number of lines down (if
{\it lines
} is
2601 \wxheading{Return value
}
2603 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2604 on top/bottom and nothing was done.
2608 This function is currently only implemented under MSW and wxTextCtrl under
2609 wxGTK (it also works for wxScrolledWindow derived classes under all
2612 \wxheading{See also
}
2614 \helpref{ScrollPages
}{wxwindowscrollpages
}
2617 \membersection{wxWindow::ScrollPages
}\label{wxwindowscrollpages
}
2619 \func{virtual bool
}{ScrollPages
}{\param{int
}{pages
}}
2621 Scrolls the window by the given number of pages down (if
{\it pages
} is
2624 \wxheading{Return value
}
2626 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2627 on top/bottom and nothing was done.
2631 This function is currently only implemented under MSW and wxGTK.
2633 \wxheading{See also
}
2635 \helpref{ScrollLines
}{wxwindowscrolllines
}
2638 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
2640 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
2642 Physically scrolls the pixels in the window and move child windows accordingly.
2644 \wxheading{Parameters
}
2646 \docparam{dx
}{Amount to scroll horizontally.
}
2648 \docparam{dy
}{Amount to scroll vertically.
}
2650 \docparam{rect
}{Rectangle to scroll, if it is
\NULL, the whole window is
2651 scrolled (this is always the case under wxGTK which doesn't support this
2656 Note that you can often use
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2657 instead of using this function directly.
2660 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
2662 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
2664 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
2667 \membersection{wxWindow::SetAccessible
}\label{wxwindowsetaccessible
}
2669 \func{void
}{SetAccessible
}{\param{wxAccessible*
}{ accessible
}}
2671 Sets the accessible for this window. Any existing accessible for this window
2672 will be deleted first, if not identical to
{\it accessible
}.
2674 See also
\helpref{wxAccessible
}{wxaccessible
}.
2677 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
2679 \func{void
}{SetAutoLayout
}{\param{bool
}{ autoLayout
}}
2681 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
2682 be called automatically when the window is resized. Please note that this only
2683 happens for the windows usually used to contain children, namely
2684 \helpref{wxPanel
}{wxpanel
} and
\helpref{wxTopLevelWindow
}{wxtoplevelwindow
}
2685 (and the classes deriving from them).
2687 This method is called implicitly by
2688 \helpref{wxWindow::SetSizer
}{wxwindowsetsizer
} but if you use
2689 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
} you should call it
2690 manually or otherwise the window layout won't be correctly updated when its
2693 \wxheading{Parameters
}
2695 \docparam{autoLayout
}{Set this to
\true if you wish the Layout function to be
2696 called automatically when the window is resized.
}
2698 \wxheading{See also
}
2700 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
2703 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
2705 \func{virtual bool
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
2707 Sets the background colour of the window.
2709 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
2710 explanation of the difference between this method and
2711 \helpref{SetOwnBackgroundColour
}{wxwindowsetownbackgroundcolour
}.
2713 \wxheading{Parameters
}
2715 \docparam{colour
}{The colour to be used as the background colour, pass
2716 {\tt wxNullColour
} to reset to the default colour.
}
2720 The background colour is usually painted by the default
\rtfsp
2721 \helpref{wxEraseEvent
}{wxeraseevent
} event handler function
2722 under Windows and automatically under GTK.
2724 Note that setting the background colour does not cause an immediate refresh, so you
2725 may wish to call
\helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
} or
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} after
2726 calling this function.
2728 Using this function will disable attempts to use themes for this
2729 window, if the system supports them. Use with care since usually the
2730 themes represent the appearance chosen by the user to be used for all
2731 applications on the system.
2734 \wxheading{See also
}
2736 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
2737 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
2738 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2739 \helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
},
\rtfsp
2740 \helpref{wxWindow::Refresh
}{wxwindowrefresh
},
\rtfsp
2741 \helpref{wxEraseEvent
}{wxeraseevent
}
2743 \membersection{wxWindow::SetBackgroundStyle
}\label{wxwindowsetbackgroundstyle
}
2745 \func{virtual void
}{SetBackgroundStyle
}{\param{wxBackgroundStyle
}{ style
}}
2747 Sets the background style of the window. The background style indicates
2748 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
2749 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
2750 application to implement (wxBG
\_STYLE\_CUSTOM).
2752 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
2753 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
2755 \wxheading{See also
}
2757 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2758 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2759 \helpref{wxWindow::GetBackgroundStyle
}{wxwindowgetbackgroundstyle
}
2762 \membersection{wxWindow::SetInitialSize
}\label{wxwindowsetinitialsize
}
2764 \func{void
}{SetInitialSize
}{\param{const wxSize\&
}{size = wxDefaultSize
}}
2766 A
{\it smart
} SetSize that will fill in default size components with the
2767 window's
{\it best
} size values. Also sets the window's minsize to
2768 the value passed in for use with sizers. This means that if a full or
2769 partial size is passed to this function then the sizers will use that
2770 size instead of the results of GetBestSize to determine the minimum
2771 needs of the window for layout.
2773 Most controls will use this to set their initial size, and their min
2774 size to the passed in value (if any.)
2777 \wxheading{See also
}
2779 \helpref{wxWindow::SetSize
}{wxwindowsetsize
},
\rtfsp
2780 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
2781 \helpref{wxWindow::GetEffectiveMinSize
}{wxwindowgeteffectiveminsize
}
2784 \membersection{wxWindow::SetCaret
}\label{wxwindowsetcaret
}
2786 \constfunc{void
}{SetCaret
}{\param{wxCaret *
}{caret
}}
2788 Sets the
\helpref{caret
}{wxcaret
} associated with the window.
2791 \membersection{wxWindow::SetClientSize
}\label{wxwindowsetclientsize
}
2793 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
2795 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
2797 This sets the size of the window client area in pixels. Using this function to size a window
2798 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
2799 worry about what dimensions the border or title bar have when trying to fit the window
2800 around panel items, for example.
2802 \wxheading{Parameters
}
2804 \docparam{width
}{The required client area width.
}
2806 \docparam{height
}{The required client area height.
}
2808 \docparam{size
}{The required client size.
}
2810 \pythonnote{In place of a single overloaded method name, wxPython
2811 implements the following methods:
\par
2812 \indented{2cm
}{\begin{twocollist
}
2813 \twocolitem{{\bf SetClientSize(size)
}}{Accepts a wxSize
}
2814 \twocolitem{{\bf SetClientSizeWH(width, height)
}}{}
2819 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
2821 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
2823 Sets the window to have the given layout constraints. The window
2824 will then own the object, and will take care of its deletion.
2825 If an existing layout constraints object is already owned by the
2826 window, it will be deleted.
2828 \wxheading{Parameters
}
2830 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
2835 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
2836 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
2837 explicitly. When setting both a wxLayoutConstraints and a
\helpref{wxSizer
}{wxsizer
}, only the
2838 sizer will have effect.
2840 \membersection{wxWindow::SetContainingSizer
}\label{wxwindowsetcontainingsizer
}
2842 \func{void
}{SetContainingSizer
}{\param{wxSizer*
}{sizer
}}
2844 This normally does not need to be called by user code. It is called
2845 when a window is added to a sizer, and is used so the window can
2846 remove itself from the sizer when it is destroyed.
2849 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
2851 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
2853 % VZ: the docs are correct, if the code doesn't behave like this, it must be
2855 Sets the window's cursor. Notice that the window cursor also sets it for the
2856 children of the window implicitly.
2858 The
{\it cursor
} may be
{\tt wxNullCursor
} in which case the window cursor will
2859 be reset back to default.
2861 \wxheading{Parameters
}
2863 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
2865 \wxheading{See also
}
2867 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
2870 \membersection{wxWindow::SetDropTarget
}\label{wxwindowsetdroptarget
}
2872 \func{void
}{SetDropTarget
}{\param{wxDropTarget*
}{ target
}}
2874 Associates a drop target with this window.
2876 If the window already has a drop target, it is deleted.
2878 \wxheading{See also
}
2880 \helpref{wxWindow::GetDropTarget
}{wxwindowgetdroptarget
},
2881 \helpref{Drag and drop overview
}{wxdndoverview
}
2885 \membersection{wxWindow::SetInitialBestSize
}\label{wxwindowsetinitialbestsize
}
2887 \func{virtual void
}{SetInitialBestSize
}{\param{const wxSize\&
}{size
}}
2889 Sets the initial window size if none is given (i.e. at least one of the
2890 components of the size passed to ctor/Create() is wxDefaultCoord).
2892 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
2894 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2896 Sets the event handler for this window.
2898 \wxheading{Parameters
}
2900 \docparam{handler
}{Specifies the handler to be set.
}
2904 An event handler is an object that is capable of processing the events
2905 sent to a window. By default, the window is its own event handler, but
2906 an application may wish to substitute another, for example to allow
2907 central implementation of event-handling for a variety of different
2910 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
2911 this sets up a chain of event handlers, where an event not handled by one event handler is
2912 handed to the next one in the chain.
2914 \wxheading{See also
}
2916 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2917 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2918 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2919 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2920 \helpref{wxEvtHandler
}{wxevthandler
}
2923 \membersection{wxWindow::SetExtraStyle
}\label{wxwindowsetextrastyle
}
2925 \func{void
}{SetExtraStyle
}{\param{long
}{exStyle
}}
2927 Sets the extra style bits for the window. The currently defined extra style
2931 \begin{twocollist
}\itemsep=
0pt
2932 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
2933 and Validate() methods will recursively descend into all children of the
2934 window if it has this style flag set.
}
2935 \twocolitem{\windowstyle{wxWS
\_EX\_BLOCK\_EVENTS}}{Normally, the command
2936 events are propagated upwards to the window parent recursively until a handler
2937 for them is found. Using this style allows to prevent them from being
2938 propagated beyond this window. Notice that wxDialog has this style on by
2939 default for the reasons explained in the
2940 \helpref{event processing overview
}{eventprocessing
}.
}
2941 \twocolitem{\windowstyle{wxWS
\_EX\_TRANSIENT}}{This can be used to prevent a
2942 window from being used as an implicit parent for the dialogs which were
2943 created without a parent. It is useful for the windows which can disappear at
2944 any moment as creating children of such windows results in fatal problems.
}
2945 \twocolitem{\windowstyle{wxWS
\_EX\_CONTEXTHELP}}{Under Windows, puts a query
2946 button on the caption. When pressed, Windows will go into a context-sensitive
2947 help mode and wxWidgets will send a wxEVT
\_HELP event if the user clicked on an
2949 This style cannot be used together with wxMAXIMIZE
\_BOX or wxMINIMIZE
\_BOX, so
2950 these two styles are automatically turned of if this one is used.
}
2951 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
2952 if the mode set by
\helpref{wxIdleEvent::SetMode
}{wxidleeventsetmode
} is wxIDLE
\_PROCESS\_SPECIFIED.
}
2953 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
2954 even if the mode set by
\helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} is wxUPDATE
\_UI\_PROCESS\_SPECIFIED.
}
2958 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
2960 \func{virtual void
}{SetFocus
}{\void}
2962 This sets the window to receive keyboard input.
2964 \wxheading{See also
}
2966 \helpref{wxFocusEvent
}{wxfocusevent
}
2967 \helpref{wxPanel::SetFocus
}{wxpanelsetfocus
}
2968 \helpref{wxPanel::SetFocusIgnoringChildren
}{wxpanelsetfocusignoringchildren
}
2971 \membersection{wxWindow::SetFocusFromKbd
}\label{wxwindowsetfocusfromkbd
}
2973 \func{virtual void
}{SetFocusFromKbd
}{\void}
2975 This function is called by wxWidgets keyboard navigation code when the user
2976 gives the focus to this window from keyboard (e.g. using
{\tt TAB
} key).
2977 By default this method simply calls
\helpref{SetFocus
}{wxwindowsetfocus
} but
2978 can be overridden to do something in addition to this in the derived classes.
2981 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
2983 \func{bool
}{SetFont
}{\param{const wxFont\&
}{font
}}
2985 Sets the font for this window. This function should not be called for the
2986 parent window if you don't want its font to be inherited by its children,
2987 use
\helpref{SetOwnFont
}{wxwindowsetownfont
} instead in this case and
2988 see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for more
2991 Please notice that the given font is
\emph{not
} automatically used for
2992 \helpref{wxPaintDC
}{wxpaintdc
} objects associated with this window, you need to
2993 call
\helpref{wxDC::SetFont()
}{wxdcsetfont
} too. However this font is used by
2994 any standard controls for drawing their text as well as by
2995 \helpref{wxWindow::GetTextExtent()
}{wxwindowgettextextent
}.
2997 \wxheading{Parameters
}
2999 \docparam{font
}{Font to associate with this window, pass
3000 {\tt wxNullFont
} to reset to the default font.
}
3002 \wxheading{Return value
}
3004 \true if the want was really changed,
\false if it was already set to this
3005 \arg{font
} and so nothing was done.
3007 \wxheading{See also
}
3009 \helpref{wxWindow::GetFont
}{wxwindowgetfont
},\\
3010 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3013 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
3015 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
3017 Sets the foreground colour of the window.
3019 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
3020 explanation of the difference between this method and
3021 \helpref{SetOwnForegroundColour
}{wxwindowsetownforegroundcolour
}.
3023 \wxheading{Parameters
}
3025 \docparam{colour
}{The colour to be used as the foreground colour, pass
3026 {\tt wxNullColour
} to reset to the default colour.
}
3030 The interpretation of foreground colour is open to interpretation according
3031 to the window class; it may be the text colour or other colour, or it may not
3034 Using this function will disable attempts to use themes for this
3035 window, if the system supports them. Use with care since usually the
3036 themes represent the appearance chosen by the user to be used for all
3037 applications on the system.
3039 \wxheading{See also
}
3041 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
3042 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
3043 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
3044 \helpref{wxWindow::ShouldInheritColours
}{wxwindowshouldinheritcolours
}
3047 \membersection{wxWindow::SetHelpText
}\label{wxwindowsethelptext
}
3049 \func{virtual void
}{SetHelpText
}{\param{const wxString\&
}{helpText
}}
3051 Sets the help text to be used as context-sensitive help for this window.
3053 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
3054 and not in the window object itself.
3056 \wxheading{See also
}
3058 \helpref{GetHelpText
}{wxwindowgethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
3061 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
3063 \func{void
}{SetId
}{\param{int
}{ id
}}
3065 Sets the identifier of the window.
3069 Each window has an integer identifier. If the application has not provided one,
3070 an identifier will be generated. Normally, the identifier should be provided
3071 on creation and should not be modified subsequently.
3073 \wxheading{See also
}
3075 \helpref{wxWindow::GetId
}{wxwindowgetid
},
\rtfsp
3076 \helpref{Window identifiers
}{windowids
}
3080 \membersection{wxWindow::SetLabel
}\label{wxwindowsetlabel
}
3082 \func{virtual void
}{SetLabel
}{\param{const wxString\&
}{label
}}
3084 Sets the window's label.
3086 \wxheading{Parameters
}
3088 \docparam{label
}{The window label.
}
3090 \wxheading{See also
}
3092 \helpref{wxWindow::GetLabel
}{wxwindowgetlabel
}
3095 \membersection{wxWindow::SetMaxSize
}\label{wxwindowsetmaxsize
}
3097 \func{void
}{SetMaxSize
}{\param{const wxSize\&
}{size
}}
3099 Sets the maximum size of the window, to indicate to the sizer layout mechanism
3100 that this is the maximum possible size.
3102 \membersection{wxWindow::SetMinSize
}\label{wxwindowsetminsize
}
3104 \func{void
}{SetMinSize
}{\param{const wxSize\&
}{size
}}
3106 Sets the minimum size of the window, to indicate to the sizer layout mechanism
3107 that this is the minimum required size. You may need to call this
3108 if you change the window size after construction and before adding
3109 to its parent sizer.
3111 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
3113 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
3115 Sets the window's name.
3117 \wxheading{Parameters
}
3119 \docparam{name
}{A name to set for the window.
}
3121 \wxheading{See also
}
3123 \helpref{wxWindow::GetName
}{wxwindowgetname
}
3126 \membersection{wxWindow::SetOwnBackgroundColour
}\label{wxwindowsetownbackgroundcolour
}
3128 \func{void
}{SetOwnBackgroundColour
}{\param{const wxColour\&
}{colour
}}
3130 Sets the background colour of the window but prevents it from being inherited
3131 by the children of this window.
3133 \wxheading{See also
}
3135 \helpref{SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
3136 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3139 \membersection{wxWindow::SetOwnFont
}\label{wxwindowsetownfont
}
3141 \func{void
}{SetOwnFont
}{\param{const wxFont\&
}{font
}}
3143 Sets the font of the window but prevents it from being inherited by the
3144 children of this window.
3146 \wxheading{See also
}
3148 \helpref{SetFont
}{wxwindowsetfont
},
\rtfsp
3149 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3152 \membersection{wxWindow::SetOwnForegroundColour
}\label{wxwindowsetownforegroundcolour
}
3154 \func{void
}{SetOwnForegroundColour
}{\param{const wxColour\&
}{colour
}}
3156 Sets the foreground colour of the window but prevents it from being inherited
3157 by the children of this window.
3159 \wxheading{See also
}
3161 \helpref{SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
3162 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
3165 \membersection{wxWindow::SetPalette
}\label{wxwindowsetpalette
}
3167 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
3169 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
3172 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
3174 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
3175 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
3176 \param{bool
}{refresh =
{\tt true
}}}
3178 Sets the scrollbar properties of a built-in scrollbar.
3180 \wxheading{Parameters
}
3182 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3184 \docparam{position
}{The position of the scrollbar in scroll units.
}
3186 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
3188 \docparam{range
}{The maximum position of the scrollbar.
}
3190 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3194 Let's say you wish to display
50 lines of text, using the same font.
3195 The window is sized so that you can only see
16 lines at a time.
3201 SetScrollbar(wxVERTICAL,
0,
16,
50);
3205 Note that with the window at this size, the thumb position can never go
3206 above
50 minus
16, or
34.
3208 You can determine how many lines are currently visible by dividing the current view
3209 size by the character height in pixels.
3211 When defining your own scrollbar behaviour, you will always need to recalculate
3212 the scrollbar settings when the window size changes. You could therefore put your
3213 scrollbar calculations and SetScrollbar
3214 call into a function named AdjustScrollbars, which can be called initially and also
3215 from your
\helpref{wxSizeEvent
}{wxsizeevent
} handler function.
3217 \wxheading{See also
}
3219 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
3220 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
},
\rtfsp
3221 \helpref{wxScrollWinEvent
}{wxscrollwinevent
}
3226 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
3228 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{bool
}{refresh =
{\tt true
}}}
3230 Sets the page size of one of the built-in scrollbars.
3232 \wxheading{Parameters
}
3234 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3236 \docparam{pageSize
}{Page size in scroll units.
}
3238 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3242 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
3243 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
3244 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
3245 value has to be adjusted when the window is resized, since the page size will have changed.
3247 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
3248 the thumb changes size to reflect the page size relative to the length of the
document. When the
3249 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
3250 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
3253 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
3254 handling of pages and ranges.
3256 \wxheading{See also
}
3258 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3259 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3260 \helpref{wxWindow::GetScrollPage
}{wxwindowgetscrollpage
},
\rtfsp
3261 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3265 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
3267 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{bool
}{refresh =
{\tt true
}}}
3269 Sets the position of one of the built-in scrollbars.
3271 \wxheading{Parameters
}
3273 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3275 \docparam{pos
}{Position in scroll units.
}
3277 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3281 This function does not directly affect the contents of the window: it is up to the
3282 application to take note of scrollbar attributes and redraw contents accordingly.
3284 \wxheading{See also
}
3286 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
3287 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3288 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
3289 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3294 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
3296 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{bool
}{refresh =
{\tt true
}}}
3298 Sets the range of one of the built-in scrollbars.
3300 \wxheading{Parameters
}
3302 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3304 \docparam{range
}{Scroll range.
}
3306 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3310 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
3311 object length of the scrollbar. If you are implementing a scrolling window, for example, you
3312 would adjust the scroll range when the window is resized, by subtracting the window view size from the
3313 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
3314 and usually the scrollbar will be automatically hidden.
3316 \wxheading{See also
}
3318 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3319 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
3320 \helpref{wxWindow::GetScrollPos
}{wxwindowgetscrollpos
},
\rtfsp
3321 \helpref{wxWindow::GetScrollPage
}{wxwindowgetscrollpage
},
\rtfsp
3322 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3326 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
3328 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
3329 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
3331 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
3333 Sets the position and size of the window in pixels.
3335 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3337 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
3339 Sets the size of the window in pixels.
3341 \wxheading{Parameters
}
3343 \docparam{x
}{Required x position in pixels, or wxDefaultCoord to indicate that the existing
3344 value should be used.
}
3346 \docparam{y
}{Required y position in pixels, or wxDefaultCoord to indicate that the existing
3347 value should be used.
}
3349 \docparam{width
}{Required width in pixels, or wxDefaultCoord to indicate that the existing
3350 value should be used.
}
3352 \docparam{height
}{Required height position in pixels, or wxDefaultCoord to indicate that the existing
3353 value should be used.
}
3355 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
3357 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
3359 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
3361 {\bf wxSIZE
\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
3362 a wxWidgets-supplied default width.\\
3363 {\bf wxSIZE
\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
3364 a wxWidgets-supplied default height.\\
3365 {\bf wxSIZE
\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
3366 a wxWidgets-supplied default size.\\
3367 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
3368 if $wxDefaultCoord$ values are supplied.\\
3369 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted
3370 as real dimensions, not default values.
3371 {\bf wxSIZE
\_FORCE}: normally, if the position and the size of the window are
3372 already the same as the parameters of this function, nothing is done. but with
3373 this flag a window resize may be forced even in this case (supported in wx
3374 2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
3379 The second form is a convenience for calling the first form with default
3380 x and y parameters, and must be used with non-default width and height values.
3382 The first form sets the position and optionally size, of the window.
3383 Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied
3384 by wxWidgets, or that the current value of the dimension should be used.
3386 \wxheading{See also
}
3388 \helpref{wxWindow::Move
}{wxwindowmove
}
3390 \pythonnote{In place of a single overloaded method name, wxPython
3391 implements the following methods:
\par
3392 \indented{2cm
}{\begin{twocollist
}
3393 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE
\_AUTO)
}}{}
3394 \twocolitem{{\bf SetSize(size)
}}{}
3395 \twocolitem{{\bf SetPosition(point)
}}{}
3400 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
3402 Use of this function for windows which are not toplevel windows
3403 (such as wxDialog or wxFrame) is discouraged. Please use
3404 \helpref{SetMinSize
}{wxwindowsetminsize
} and
\helpref{SetMaxSize
}{wxwindowsetmaxsize
}
3407 \wxheading{See also
}
3409 \helpref{wxTopLevelWindow::SetSizeHints
}{wxtoplevelwindowsetsizehints
}.
3412 \membersection{wxWindow::SetSizer
}\label{wxwindowsetsizer
}
3414 \func{void
}{SetSizer
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3416 Sets the window to have the given layout sizer. The window
3417 will then own the object, and will take care of its deletion.
3418 If an existing layout constraints object is already owned by the
3419 window, it will be deleted if the deleteOld parameter is true.
3421 Note that this function will also call
3422 \helpref{SetAutoLayout
}{wxwindowsetautolayout
} implicitly with
{\tt true
}
3423 parameter if the
{\it sizer
}\/ is non-NULL and
{\tt false
} otherwise.
3425 \wxheading{Parameters
}
3427 \docparam{sizer
}{The sizer to set. Pass NULL to disassociate and conditionally delete
3428 the window's sizer. See below.
}
3430 \docparam{deleteOld
}{If true (the default), this will delete any pre-existing sizer.
3431 Pass false if you wish to handle deleting the old sizer yourself.
}
3435 SetSizer now enables and disables Layout automatically, but prior to wxWidgets
2.3.3
3436 the following applied:
3438 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
3439 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
3440 explicitly. When setting both a wxSizer and a
\helpref{wxLayoutConstraints
}{wxlayoutconstraints
},
3441 only the sizer will have effect.
3444 \membersection{wxWindow::SetSizerAndFit
}\label{wxwindowsetsizerandfit
}
3446 \func{void
}{SetSizerAndFit
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3448 The same as
\helpref{SetSizer
}{wxwindowsetsizer
}, except it also sets the size hints
3449 for the window based on the sizer's minimum size.
3452 \membersection{wxWindow::SetThemeEnabled
}\label{wxwindowsetthemeenabled
}
3454 \func{virtual void
}{SetThemeEnabled
}{\param{bool
}{enable
}}
3456 This function tells a window if it should use the system's "theme" code
3457 to draw the windows' background instead if its own background drawing
3458 code. This does not always have any effect since the underlying platform
3459 obviously needs to support the notion of themes in user defined windows.
3460 One such platform is GTK+ where windows can have (very colourful) backgrounds
3461 defined by a user's selected theme.
3463 Dialogs, notebook pages and the status bar have this flag set to true
3464 by default so that the default look and feel is simulated best.
3467 \membersection{wxWindow::SetToolTip
}\label{wxwindowsettooltip
}
3469 \func{void
}{SetToolTip
}{\param{const wxString\&
}{tip
}}
3471 \func{void
}{SetToolTip
}{\param{wxToolTip*
}{tip
}}
3473 Attach a tooltip to the window.
3475 See also:
\helpref{GetToolTip
}{wxwindowgettooltip
},
3476 \helpref{wxToolTip
}{wxtooltip
}
3479 \membersection{wxWindow::SetValidator
}\label{wxwindowsetvalidator
}
3481 \func{virtual void
}{SetValidator
}{\param{const wxValidator\&
}{ validator
}}
3483 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
3484 create a new validator of this type.
3487 \membersection{wxWindow::SetVirtualSize
}\label{wxwindowsetvirtualsize
}
3489 \func{void
}{SetVirtualSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3491 \func{void
}{SetVirtualSize
}{\param{const wxSize\&
}{ size
}}
3493 Sets the virtual size of the window in pixels.
3496 \membersection{wxWindow::SetVirtualSizeHints
}\label{wxwindowsetvirtualsizehints
}
3498 \func{virtual void
}{SetVirtualSizeHints
}{\param{int
}{ minW
},
\param{int
}{ minH
},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1}}
3500 \func{void
}{SetVirtualSizeHints
}{\param{const wxSize\&
}{ minSize=wxDefaultSize
},
3501 \param{const wxSize\&
}{ maxSize=wxDefaultSize
}}
3504 Allows specification of minimum and maximum virtual window sizes.
3505 If a pair of values is not set (or set to -
1), the default values
3508 \wxheading{Parameters
}
3510 \docparam{minW
}{Specifies the minimum width allowable.
}
3512 \docparam{minH
}{Specifies the minimum height allowable.
}
3514 \docparam{maxW
}{Specifies the maximum width allowable.
}
3516 \docparam{maxH
}{Specifies the maximum height allowable.
}
3518 \docparam{minSize
}{Minimum size.
}
3520 \docparam{maxSize
}{Maximum size.
}
3524 If this function is called, the user will not be able to size the virtual area
3525 of the window outside the given bounds.
3528 \membersection{wxWindow::SetWindowStyle
}\label{wxwindowsetwindowstyle
}
3530 \func{void
}{SetWindowStyle
}{\param{long
}{ style
}}
3532 Identical to
\helpref{SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
}.
3535 \membersection{wxWindow::SetWindowStyleFlag
}\label{wxwindowsetwindowstyleflag
}
3537 \func{virtual void
}{SetWindowStyleFlag
}{\param{long
}{ style
}}
3539 Sets the style of the window. Please note that some styles cannot be changed
3540 after the window creation and that
\helpref{Refresh()
}{wxwindowrefresh
} might
3541 need to be be called after changing the others for the change to take place
3544 See
\helpref{Window styles
}{windowstyles
} for more information about flags.
3546 \wxheading{See also
}
3548 \helpref{GetWindowStyleFlag
}{wxwindowgetwindowstyleflag
}
3551 \membersection{wxWindow::SetWindowVariant
}\label{wxwindowsetwindowvariant
}
3553 \func{void
}{SetWindowVariant
}{\param{wxWindowVariant
}{variant
}}
3555 This function can be called under all platforms but only does anything under
3556 Mac OS X
10.3+ currently. Under this system, each of the standard control can
3557 exist in several sizes which correspond to the elements of wxWindowVariant
3560 enum wxWindowVariant
3562 wxWINDOW_VARIANT_NORMAL, // Normal size
3563 wxWINDOW_VARIANT_SMALL, // Smaller size (about
25 % smaller than normal )
3564 wxWINDOW_VARIANT_MINI, // Mini size (about
33 % smaller than normal )
3565 wxWINDOW_VARIANT_LARGE, // Large size (about
25 % larger than normal )
3569 By default the controls use the normal size, of course, but this function can
3570 be used to change this.
3573 \membersection{wxWindow::ShouldInheritColours
}\label{wxwindowshouldinheritcolours
}
3575 \func{virtual bool
}{ShouldInheritColours
}{\void}
3577 Return
\true from here to allow the colours of this window to be changed by
3578 \helpref{InheritAttributes
}{wxwindowinheritattributes
}, returning
\false
3579 forbids inheriting them from the parent window.
3581 The base class version returns
\false, but this method is overridden in
3582 \helpref{wxControl
}{wxcontrol
} where it returns
\true.
3585 \membersection{wxWindow::Show
}\label{wxwindowshow
}
3587 \func{virtual bool
}{Show
}{\param{bool
}{ show =
{\tt true
}}}
3589 Shows or hides the window. You may need to call
\helpref{Raise
}{wxwindowraise
}
3590 for a top level window if you want to bring it to top, although this is not
3591 needed if Show() is called immediately after the frame creation.
3593 \wxheading{Parameters
}
3595 \docparam{show
}{If
{\tt true
} displays the window. Otherwise, hides it.
}
3597 \wxheading{Return value
}
3599 {\tt true
} if the window has been shown or hidden or
{\tt false
} if nothing was
3600 done because it already was in the requested state.
3602 \wxheading{See also
}
3604 \helpref{wxWindow::IsShown
}{wxwindowisshown
},
\rtfsp
3605 \helpref{wxWindow::Hide
}{wxwindowhide
},
\rtfsp
3606 \helpref{wxRadioBox::Show
}{wxradioboxshow
}
3609 \membersection{wxWindow::Thaw
}\label{wxwindowthaw
}
3611 \func{virtual void
}{Thaw
}{\void}
3613 Reenables window updating after a previous call to
3614 \helpref{Freeze
}{wxwindowfreeze
}. To really thaw the control, it must be called
3615 exactly the same number of times as
\helpref{Freeze
}{wxwindowfreeze
}.
3617 \wxheading{See also
}
3619 \helpref{wxWindowUpdateLocker
}{wxwindowupdatelocker
}
3622 \membersection{wxWindow::ToggleWindowStyle
}\label{wxwindowtogglewindowstyle
}
3624 \func{bool
}{ToggleWindowStyle
}{\param{int
}{flag
}}
3626 Turns the given
\arg{flag
} on if it's currently turned off and vice versa.
3627 This function cannot be used if the value of the flag is $
0$ (which is often
3628 the case for default flags).
3630 Also, please notice that not all styles can be changed after the control
3633 \wxheading{Return value
}
3635 Returns
\true if the style was turned on by this function,
\false if it was
3638 \wxheading{See also
}
3640 \helpref{wxWindow::SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
},
\rtfsp
3641 \helpref{wxWindow::HasFlag
}{wxwindowhasflag
}
3644 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
3646 \func{virtual bool
}{TransferDataFromWindow
}{\void}
3648 Transfers values from child controls to data areas specified by their validators. Returns
3649 {\tt false
} if a transfer failed.
3651 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3652 the method will also call TransferDataFromWindow() of all child windows.
3654 \wxheading{See also
}
3656 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3657 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3660 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
3662 \func{virtual bool
}{TransferDataToWindow
}{\void}
3664 Transfers values to child controls from data areas specified by their validators.
3666 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3667 the method will also call TransferDataToWindow() of all child windows.
3669 \wxheading{Return value
}
3671 Returns
{\tt false
} if a transfer failed.
3673 \wxheading{See also
}
3675 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3676 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3679 \membersection{wxWindow::UnregisterHotKey
}\label{wxwindowunregisterhotkey
}
3681 \func{bool
}{UnregisterHotKey
}{\param{int
}{ hotkeyId
}}
3683 Unregisters a system wide hotkey.
3685 \wxheading{Parameters
}
3687 \docparam{hotkeyId
}{Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey.
}
3689 \wxheading{Return value
}
3691 {\tt true
} if the hotkey was unregistered successfully,
{\tt false
} if the id was invalid.
3695 This function is currently only implemented under MSW.
3697 \wxheading{See also
}
3699 \helpref{wxWindow::RegisterHotKey
}{wxwindowregisterhotkey
}
3702 \membersection{wxWindow::Update
}\label{wxwindowupdate
}
3704 \func{virtual void
}{Update
}{\void}
3706 Calling this method immediately repaints the invalidated area of the window and
3707 all of its children recursively while this would usually only happen when the
3708 flow of control returns to the event loop.
3709 Notice that this function doesn't invalidate any area of the window so
3710 nothing happens if nothing has been invalidated (i.e. marked as requiring
3711 a redraw). Use
\helpref{Refresh
}{wxwindowrefresh
} first if you want to
3712 immediately redraw the window unconditionally.
3715 \membersection{wxWindow::UpdateWindowUI
}\label{wxwindowupdatewindowui
}
3717 \func{virtual void
}{UpdateWindowUI
}{\param{long
}{ flags = wxUPDATE
\_UI\_NONE}}
3719 This function sends
\helpref{wxUpdateUIEvents
}{wxupdateuievent
} to
3720 the window. The particular implementation depends on the window; for
3721 example a wxToolBar will send an update UI event for each toolbar button,
3722 and a wxFrame will send an update UI event for each menubar menu item.
3723 You can call this function from your application to ensure that your
3724 UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers
3725 are concerned). This may be necessary if you have called
3726 \helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} or
3727 \helpref{wxUpdateUIEvent::SetUpdateInterval
}{wxupdateuieventsetupdateinterval
} to
3728 limit the overhead that wxWidgets incurs by sending update UI events in idle time.
3730 {\it flags
} should be a bitlist of one or more of the following values.
3735 wxUPDATE_UI_NONE =
0x0000, // No particular value
3736 wxUPDATE_UI_RECURSE =
0x0001, // Call the function for descendants
3737 wxUPDATE_UI_FROMIDLE =
0x0002 // Invoked from On(Internal)Idle
3741 If you are calling this function from an OnInternalIdle or OnIdle
3742 function, make sure you pass the wxUPDATE
\_UI\_FROMIDLE flag, since
3743 this tells the window to only update the UI elements that need
3744 to be updated in idle time. Some windows update their elements
3745 only when necessary, for example when a menu is about to be shown.
3746 The following is an example of how to call UpdateWindowUI from
3750 void MyWindow::OnInternalIdle()
3752 if (wxUpdateUIEvent::CanUpdate(this))
3753 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
3757 \wxheading{See also
}
3759 \helpref{wxUpdateUIEvent
}{wxupdateuievent
},
3760 \helpref{wxWindow::DoUpdateWindowUI
}{wxwindowdoupdatewindowui
},
3761 \helpref{wxWindow::OnInternalIdle
}{wxwindowoninternalidle
}
3764 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
3766 \func{virtual bool
}{Validate
}{\void}
3768 Validates the current values of the child controls using their validators.
3770 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3771 the method will also call Validate() of all child windows.
3773 \wxheading{Return value
}
3775 Returns
{\tt false
} if any of the validations failed.
3777 \wxheading{See also
}
3779 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3780 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3781 \helpref{wxValidator
}{wxvalidator
}
3784 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
3786 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
3788 Moves the pointer to the given position on the window.
3790 {\bf NB:
} This function is not supported under Mac because Apple Human
3791 Interface Guidelines forbid moving the mouse cursor programmatically.
3793 \wxheading{Parameters
}
3795 \docparam{x
}{The new x position for the cursor.
}
3797 \docparam{y
}{The new y position for the cursor.
}