1 \section{\class{wxWindow
}}\label{wxwindow
}
3 wxWindow is the base class for all windows and represents any visible object on
4 screen. All controls, top level windows and so on are windows. Sizers and
5 device contexts are not, however, as they don't appear on screen themselves.
7 Please note that all children of the window will be deleted automatically by
8 the destructor before the window itself is deleted which means that you don't
9 have to worry about deleting them manually. Please see the
\helpref{window
10 deletion overview
}{windowdeletionoverview
} for more information.
12 Also note that in this, and many others, wxWidgets classes some
13 \texttt{GetXXX()
} methods may be overloaded (as, for example,
14 \helpref{GetSize
}{wxwindowgetsize
} or
15 \helpref{GetClientSize
}{wxwindowgetclientsize
}). In this case, the overloads
16 are non-virtual because having multiple virtual functions with the same name
17 results in a virtual function name hiding at the derived class level (in
18 English, this means that the derived class has to override all overloaded
19 variants if it overrides any of them). To allow overriding them in the derived
20 class, wxWidgets uses a unique protected virtual
\texttt{DoGetXXX()
} method
21 and all
\texttt{GetXXX()
} ones are forwarded to it, so overriding the former
22 changes the behaviour of the latter.
24 \wxheading{Derived from
}
26 \helpref{wxEvtHandler
}{wxevthandler
}\\
27 \helpref{wxObject
}{wxobject
}
29 \wxheading{Include files
}
33 \wxheading{Window styles
}
35 The following styles can apply to all windows, although they will not always make sense for a particular
36 window class or on all platforms.
39 \begin{twocollist
}\itemsep=
0pt
40 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
42 \twocolitem{\windowstyle{wxDOUBLE
\_BORDER}}{Displays a double border. Windows and Mac only.
}
43 \twocolitem{\windowstyle{wxSUNKEN
\_BORDER}}{Displays a sunken border.
}
44 \twocolitem{\windowstyle{wxRAISED
\_BORDER}}{Displays a raised border.
}
45 \twocolitem{\windowstyle{wxSTATIC
\_BORDER}}{Displays a border suitable for a static control. Windows only.
}
46 \twocolitem{\windowstyle{wxNO
\_BORDER}}{Displays no border, overriding the default border style for the window.
}
47 \twocolitem{\windowstyle{wxTRANSPARENT
\_WINDOW}}{The window is transparent, that is, it will not receive paint
48 events. Windows only.
}
49 \twocolitem{\windowstyle{wxTAB
\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.
}
50 \twocolitem{\windowstyle{wxWANTS
\_CHARS}}{Use this to indicate that
51 the window wants to get all char/key events for all keys - even for
52 keys like TAB or ENTER which are usually used for dialog navigation
53 and which wouldn't be generated without this style. If you need to
54 use this style in order to get the arrows or etc., but would still like to have
55 normal keyboard navigation take place, you should create and send a
56 wxNavigationKeyEvent in response to the key events for Tab and
58 \twocolitem{\windowstyle{wxNO
\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting
59 the window completely when its size is changed - you will have to repaint the
60 new window area manually if you use this style. Currently only has an effect for
62 \twocolitem{\windowstyle{wxVSCROLL
}}{Use this style to enable a vertical scrollbar.
}
63 \twocolitem{\windowstyle{wxHSCROLL
}}{Use this style to enable a horizontal scrollbar.
}
64 \twocolitem{\windowstyle{wxALWAYS
\_SHOW\_SB}}{If a window has scrollbars,
65 disable them instead of hiding them when they are not needed (i.e. when the
66 size of the window is big enough to not require the scrollbars to navigate it).
67 This style is currently only implemented for wxMSW and wxUniversal and does
68 nothing on the other platforms.
}
69 \twocolitem{\windowstyle{wxCLIP
\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
70 repainted, then children being painted over them. Windows only.
}
71 \twocolitem{\windowstyle{wxFULL
\_REPAINT\_ON\_RESIZE}}{Use this style to force
72 a complete redraw of the window whenever it is resized instead of redrawing
73 just the part of the window affected by resizing. Note that this was the
74 behaviour by default before
2.5.1 release and that if you experience redraw
75 problems with the code which previously used to work you may want to try this.
}
78 See also
\helpref{window styles overview
}{windowstyles
}.
80 \wxheading{Extra window styles
}
82 The following are extra styles, set using
\helpref{wxWindow::SetExtraStyle
}{wxwindowsetextrastyle
}.
85 \begin{twocollist
}\itemsep=
0pt
86 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{By default, Validate/TransferDataTo/FromWindow()
87 only work on direct children of the window (compatible behaviour). Set this flag to make them recursively
88 descend into all subwindows.
}
89 \twocolitem{\windowstyle{wxWS
\_EX\_BLOCK\_EVENTS}}{wxCommandEvents and the objects of the derived classes are forwarded to the
90 parent window and so on recursively by default. Using this flag for the
91 given window allows to block this propagation at this window, i.e. prevent
92 the events from being propagated further upwards. Dialogs have this
94 \twocolitem{\windowstyle{wxWS
\_EX\_TRANSIENT}}{Don't use this window as an implicit parent for the other windows: this must
95 be used with transient windows as otherwise there is the risk of creating a
96 dialog/frame with this window as a parent which would lead to a crash if the
97 parent is destroyed before the child.
}
98 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
99 if the mode set by
\helpref{wxIdleEvent::SetMode
}{wxidleeventsetmode
} is wxIDLE
\_PROCESS\_SPECIFIED.
}
100 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
101 even if the mode set by
\helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} is wxUPDATE
\_UI\_PROCESS\_SPECIFIED.
}
106 \helpref{Event handling overview
}{eventhandlingoverview
}
108 \latexignore{\rtfignore{\wxheading{Members
}}}
111 \membersection{wxWindow::wxWindow
}\label{wxwindowctor
}
113 \func{}{wxWindow
}{\void}
117 \func{}{wxWindow
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
118 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
119 \param{const wxSize\&
}{size = wxDefaultSize
},
120 \param{long
}{style =
0},
121 \param{const wxString\&
}{name = wxPanelNameStr
}}
123 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
125 \wxheading{Parameters
}
127 \docparam{parent
}{Pointer to a parent window.
}
129 \docparam{id
}{Window identifier. If -
1, will automatically create an identifier.
}
131 \docparam{pos
}{Window position. wxDefaultPosition is (-
1, -
1) which indicates that wxWidgets
132 should generate a default position for the window. If using the wxWindow class directly, supply
135 \docparam{size
}{Window size. wxDefaultSize is (-
1, -
1) which indicates that wxWidgets
136 should generate a default size for the window. If no suitable size can be found, the
137 window will be sized to
20x20 pixels so that the window is visible but obviously not
140 \docparam{style
}{Window style. For generic window styles, please see
\helpref{wxWindow
}{wxwindow
}.
}
142 \docparam{name
}{Window name.
}
145 \membersection{wxWindow::
\destruct{wxWindow
}}\label{wxwindowdtor
}
147 \func{}{\destruct{wxWindow
}}{\void}
149 Destructor. Deletes all subwindows, then deletes itself. Instead of using
150 the
{\bf delete
} operator explicitly, you should normally
151 use
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} so that wxWidgets
152 can delete a window only when it is safe to do so, in idle time.
156 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
157 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
158 \helpref{wxCloseEvent
}{wxcloseevent
}
161 \membersection{wxWindow::AddChild
}\label{wxwindowaddchild
}
163 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
165 Adds a child window. This is called automatically by window creation
166 functions so should not be required by the application programmer.
168 Notice that this function is mostly internal to wxWidgets and shouldn't be
169 called by the user code.
171 \wxheading{Parameters
}
173 \docparam{child
}{Child window to add.
}
176 \membersection{wxWindow::CacheBestSize
}\label{wxwindowcachebestsize
}
178 \constfunc{void
}{CacheBestSize
}{\param{const wxSize\&
}{size
}}
180 Sets the cached best size value.
183 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
185 \func{virtual void
}{CaptureMouse
}{\void}
187 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
190 Note that wxWidgets maintains the stack of windows having captured the mouse
191 and when the mouse is released the capture returns to the window which had had
192 captured it previously and it is only really released if there were no previous
193 window. In particular, this means that you must release the mouse as many times
198 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
201 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
203 \func{void
}{Center
}{\param{int
}{ direction
}}
205 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
208 \membersection{wxWindow::CenterOnParent
}\label{wxwindowcenteronparent
}
210 \func{void
}{CenterOnParent
}{\param{int
}{ direction
}}
212 A synonym for
\helpref{CentreOnParent
}{wxwindowcentreonparent
}.
215 \membersection{wxWindow::CenterOnScreen
}\label{wxwindowcenteronscreen
}
217 \func{void
}{CenterOnScreen
}{\param{int
}{ direction
}}
219 A synonym for
\helpref{CentreOnScreen
}{wxwindowcentreonscreen
}.
222 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
224 \func{void
}{Centre
}{\param{int
}{ direction = wxBOTH
}}
228 \wxheading{Parameters
}
230 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
231 or
{\tt wxBOTH
}. It may also include
{\tt wxCENTRE
\_ON\_SCREEN} flag
232 if you want to center the window on the entire screen and not on its
235 The flag
{\tt wxCENTRE
\_FRAME} is obsolete and should not be used any longer
240 If the window is a top level one (i.e. doesn't have a parent), it will be
241 centered relative to the screen anyhow.
245 \helpref{wxWindow::Center
}{wxwindowcenter
}
248 \membersection{wxWindow::CentreOnParent
}\label{wxwindowcentreonparent
}
250 \func{void
}{CentreOnParent
}{\param{int
}{ direction = wxBOTH
}}
252 Centres the window on its parent. This is a more readable synonym for
253 \helpref{Centre
}{wxwindowcentre
}.
255 \wxheading{Parameters
}
257 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
262 This methods provides for a way to center top level windows over their
263 parents instead of the entire screen. If there is no parent or if the
264 window is not a top level window, then behaviour is the same as
265 \helpref{wxWindow::Centre
}{wxwindowcentre
}.
269 \helpref{wxWindow::CentreOnScreen
}{wxwindowcenteronscreen
}
272 \membersection{wxWindow::CentreOnScreen
}\label{wxwindowcentreonscreen
}
274 \func{void
}{CentreOnScreen
}{\param{int
}{ direction = wxBOTH
}}
276 Centres the window on screen. This only works for top level windows -
277 otherwise, the window will still be centered on its parent.
279 \wxheading{Parameters
}
281 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
286 \helpref{wxWindow::CentreOnParent
}{wxwindowcenteronparent
}
289 \membersection{wxWindow::ClearBackground
}\label{wxwindowclearbackground
}
291 \func{void
}{ClearBackground
}{\void}
293 Clears the window by filling it with the current background colour. Does not
294 cause an erase background event to be generated.
297 \membersection{wxWindow::ClientToScreen
}\label{wxwindowclienttoscreen
}
299 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
301 \perlnote{In wxPerl this method returns a
2-element list instead of
302 modifying its parameters.
}
304 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
306 Converts to screen coordinates from coordinates relative to this window.
308 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
309 a screen coordinate will be passed out.
}
311 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
312 a screen coordinate will be passed out.
}
314 \docparam{pt
}{The client position for the second form of the function.
}
316 \pythonnote{In place of a single overloaded method name, wxPython
317 implements the following methods:
\par
318 \indented{2cm
}{\begin{twocollist
}
319 \twocolitem{{\bf ClientToScreen(point)
}}{Accepts and returns a wxPoint
}
320 \twocolitem{{\bf ClientToScreenXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
325 \membersection{wxWindow::Close
}\label{wxwindowclose
}
327 \func{bool
}{Close
}{\param{bool
}{ force =
{\tt false
}}}
329 This function simply generates a
\helpref{wxCloseEvent
}{wxcloseevent
} whose
330 handler usually tries to close the window. It doesn't close the window itself,
333 \wxheading{Parameters
}
335 \docparam{force
}{{\tt false
} if the window's close handler should be able to veto the destruction
336 of this window,
{\tt true
} if it cannot.
}
340 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing
341 an opportunity for the window to choose whether to destroy the window.
342 Usually it is only used with the top level windows (wxFrame and wxDialog
343 classes) as the others are not supposed to have any special OnClose() logic.
345 The close handler should check whether the window is being deleted forcibly,
346 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}, in which case it
347 should destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
349 {\it Note
} that calling Close does not guarantee that the window will be
350 destroyed; but it provides a way to simulate a manual close of a window, which
351 may or may not be implemented by destroying the window. The default
352 implementation of wxDialog::OnCloseWindow does not necessarily delete the
353 dialog, since it will simply simulate an wxID
\_CANCEL event which is handled by
354 the appropriate button event handler and may do anything at all.
356 To guarantee that the window will be destroyed, call
357 \helpref{wxWindow::Destroy
}{wxwindowdestroy
} instead
361 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
362 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
363 \helpref{wxCloseEvent
}{wxcloseevent
}
366 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
368 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
370 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
372 Converts a point or size from dialog units to pixels.
374 For the x dimension, the dialog units are multiplied by the average character width
375 and then divided by
4.
377 For the y dimension, the dialog units are multiplied by the average character height
378 and then divided by
8.
382 Dialog units are used for maintaining a dialog's proportions even if the font changes.
384 You can also use these functions programmatically. A convenience macro is defined:
388 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
394 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
396 \pythonnote{In place of a single overloaded method name, wxPython
397 implements the following methods:
\par
398 \indented{2cm
}{\begin{twocollist
}
399 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
400 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
403 Additionally, the following helper functions are defined:
\par
404 \indented{2cm
}{\begin{twocollist
}
405 \twocolitem{{\bf wxDLG
\_PNT(win, point)
}}{Converts a wxPoint from dialog
407 \twocolitem{{\bf wxDLG
\_SZE(win, size)
}}{Converts a wxSize from dialog
414 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
416 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
418 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
420 Converts a point or size from pixels to dialog units.
422 For the x dimension, the pixels are multiplied by
4 and then divided by the average
425 For the y dimension, the pixels are multiplied by
8 and then divided by the average
430 Dialog units are used for maintaining a dialog's proportions even if the font changes.
434 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
436 \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:
\par
437 \indented{2cm
}{\begin{twocollist
}
438 \twocolitem{{\bf ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
439 \twocolitem{{\bf ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
444 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
446 \func{virtual bool
}{Destroy
}{\void}
448 Destroys the window safely. Use this function instead of the delete operator, since
449 different window classes can be destroyed differently. Frames and dialogs
450 are not destroyed immediately when this function is called -- they are added
451 to a list of windows to be deleted on idle time, when all the window's events
452 have been processed. This prevents problems with events being sent to non-existent
455 \wxheading{Return value
}
457 {\tt true
} if the window has either been successfully deleted, or it has been added
458 to the list of windows pending real deletion.
461 \membersection{wxWindow::DestroyChildren
}\label{wxwindowdestroychildren
}
463 \func{virtual void
}{DestroyChildren
}{\void}
465 Destroys all children of a window. Called automatically by the destructor.
468 \membersection{wxWindow::Disable
}\label{wxwindowdisable
}
470 \func{bool
}{Disable
}{\void}
472 Disables the window, same as
\helpref{Enable(
{\tt false
})
}{wxwindowenable
}.
474 \wxheading{Return value
}
476 Returns
{\tt true
} if the window has been disabled,
{\tt false
} if it had been
477 already disabled before the call to this function.
480 \membersection{wxWindow::DoGetBestSize
}\label{wxwindowdogetbestsize
}
482 \constfunc{virtual wxSize
}{DoGetBestSize
}{\void}
484 Gets the size which best suits the window: for a control, it would be
485 the minimal size which doesn't truncate the control, for a panel - the
486 same size as it would have after a call to
\helpref{Fit()
}{wxwindowfit
}.
489 \membersection{wxWindow::DoUpdateWindowUI
}\label{wxwindowdoupdatewindowui
}
491 \func{virtual void
}{DoUpdateWindowUI
}{\param{wxUpdateUIEvent\&
}{ event
}}
493 Does the window-specific updating after processing the update event.
494 This function is called by
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
495 in order to check return values in the
\helpref{wxUpdateUIEvent
}{wxupdateuievent
} and
496 act appropriately. For example, to allow frame and dialog title updating, wxWidgets
497 implements this function as follows:
500 // do the window-specific processing after processing the update event
501 void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
503 if ( event.GetSetEnabled() )
504 Enable(event.GetEnabled());
506 if ( event.GetSetText() )
508 if ( event.GetText() != GetTitle() )
509 SetTitle(event.GetText());
516 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
518 \func{virtual void
}{DragAcceptFiles
}{\param{bool
}{ accept
}}
520 Enables or disables eligibility for drop file events (OnDropFiles).
522 \wxheading{Parameters
}
524 \docparam{accept
}{If
{\tt true
}, the window is eligible for drop file events. If
{\tt false
}, the window
525 will not accept drop file events.
}
532 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
534 \func{virtual bool
}{Enable
}{\param{bool
}{ enable =
{\tt true
}}}
536 Enable or disable the window for user input. Note that when a parent window is
537 disabled, all of its children are disabled as well and they are reenabled again
540 \wxheading{Parameters
}
542 \docparam{enable
}{If
{\tt true
}, enables the window for input. If
{\tt false
}, disables the window.
}
544 \wxheading{Return value
}
546 Returns
{\tt true
} if the window has been enabled or disabled,
{\tt false
} if
547 nothing was done, i.e. if the window had already been in the specified state.
551 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
},
\rtfsp
552 \helpref{wxWindow::Disable
}{wxwindowdisable
}
555 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
557 \func{static wxWindow*
}{FindFocus
}{\void}
559 Finds the window or control which currently has the keyboard focus.
563 Note that this is a static function, so it can be called without needing a wxWindow pointer.
567 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
571 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
573 \func{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
575 Find a child of this window, by identifier.
577 \func{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
579 Find a child of this window, by name.
581 \pythonnote{In place of a single overloaded method name, wxPython
582 implements the following methods:
\par
583 \indented{2cm
}{\begin{twocollist
}
584 \twocolitem{{\bf FindWindowById(id)
}}{Accepts an integer
}
585 \twocolitem{{\bf FindWindowByName(name)
}}{Accepts a string
}
590 \membersection{wxWindow::FindWindowById
}\label{wxwindowfindwindowbyid
}
592 \func{static wxWindow*
}{FindWindowById
}{\param{long
}{ id
},
\param{wxWindow*
}{ parent = NULL
}}
594 Find the first window with the given
{\it id
}.
596 If
{\it parent
} is NULL, the search will start from all top-level
597 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
598 The search is recursive in both cases.
602 \helpref{FindWindow
}{wxwindowfindwindow
}
605 \membersection{wxWindow::FindWindowByName
}\label{wxwindowfindwindowbyname
}
607 \func{static wxWindow*
}{FindWindowByName
}{\param{const wxString\&
}{ name
},
\param{wxWindow*
}{ parent = NULL
}}
609 Find a window by its name (as given in a window constructor or
{\bf Create
} function call).
610 If
{\it parent
} is NULL, the search will start from all top-level
611 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
612 The search is recursive in both cases.
614 If no window with such name is found,
615 \helpref{FindWindowByLabel
}{wxwindowfindwindowbylabel
} is called.
619 \helpref{FindWindow
}{wxwindowfindwindow
}
622 \membersection{wxWindow::FindWindowByLabel
}\label{wxwindowfindwindowbylabel
}
624 \func{static wxWindow*
}{FindWindowByLabel
}{\param{const wxString\&
}{ label
},
\param{wxWindow*
}{ parent = NULL
}}
626 Find a window by its label. Depending on the type of window, the label may be a window title
627 or panel item label. If
{\it parent
} is NULL, the search will start from all top-level
628 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
629 The search is recursive in both cases.
633 \helpref{FindWindow
}{wxwindowfindwindow
}
636 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
638 \func{virtual void
}{Fit
}{\void}
640 Sizes the window so that it fits around its subwindows. This function won't do
641 anything if there are no subwindows and will only really work correctly if the
642 sizers are used for the subwindows layout. Also, if the window has exactly one
643 subwindow it is better (faster and the result is more precise as Fit adds some
644 margin to account for fuzziness of its calculations) to call
647 window->SetClientSize(child->GetSize());
650 instead of calling Fit.
653 \membersection{wxWindow::FitInside
}\label{wxwindowfitinside
}
655 \func{virtual void
}{FitInside
}{\void}
657 Similar to
\helpref{Fit
}{wxwindowfit
}, but sizes the interior (virtual) size
658 of a window. Mainly useful with scrolled windows to reset scrollbars after
659 sizing changes that do not trigger a size event, and/or scrolled windows without
660 an interior sizer. This function similarly won't do anything if there are no
664 \membersection{wxWindow::Freeze
}\label{wxwindowfreeze
}
666 \func{virtual void
}{Freeze
}{\void}
668 Freezes the window or, in other words, prevents any updates from taking place
669 on screen, the window is not redrawn at all.
\helpref{Thaw
}{wxwindowthaw
} must
670 be called to reenable window redrawing. Calls to these two functions may be
673 This method is useful for visual appearance optimization (for example, it
674 is a good idea to use it before doing many large text insertions in a row into
675 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
676 controls so it is mostly just a hint to wxWidgets and not a mandatory
680 \membersection{wxWindow::GetAcceleratorTable
}\label{wxwindowgetacceleratortable
}
682 \constfunc{wxAcceleratorTable*
}{GetAcceleratorTable
}{\void}
684 Gets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
687 \membersection{wxWindow::GetAccessible
}\label{wxwindowgetaccessible
}
689 \func{wxAccessible*
}{GetAccessible
}{\void}
691 Returns the accessible object for this window, if any.
693 See also
\helpref{wxAccessible
}{wxaccessible
}.
696 \membersection{wxWindow::GetAdjustedBestSize
}\label{wxwindowgetadjustedbestsize
}
698 \constfunc{wxSize
}{GetAdjustedBestSize
}{\void}
700 This method is similar to
\helpref{GetBestSize
}{wxwindowgetbestsize
}, except
701 in one thing. GetBestSize should return the minimum untruncated size of the
702 window, while this method will return the largest of BestSize and any user
703 specified minimum size. ie. it is the minimum size the window should currently
704 be drawn at, not the minimal size it can possibly tolerate.
707 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
709 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
711 Returns the background colour of the window.
715 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
716 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
717 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
}
719 \membersection{wxWindow::GetBackgroundStyle
}\label{wxwindowgetbackgroundstyle
}
721 \constfunc{virtual wxBackgroundStyle
}{GetBackgroundStyle
}{\void}
723 Returns the background style of the window. The background style indicates
724 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
725 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
726 application to implement (wxBG
\_STYLE\_CUSTOM).
728 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
729 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
733 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
734 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
735 \helpref{wxWindow::SetBackgroundStyle
}{wxwindowsetbackgroundstyle
}
737 \membersection{wxWindow::GetBestFittingSize
}\label{wxwindowgetbestfittingsize
}
739 \constfunc{wxSize
}{GetBestFittingSize
}{\void}
741 Merges the window's best size into the min size and returns the result.
745 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
746 \helpref{wxWindow::SetBestFittingSize
}{wxwindowsetbestfittingsize
},
\rtfsp
747 \helpref{wxWindow::SetSizeHints
}{wxwindowsetsizehints
}
750 \membersection{wxWindow::GetBestSize
}\label{wxwindowgetbestsize
}
752 \constfunc{wxSize
}{GetBestSize
}{\void}
754 This functions returns the best acceptable minimal size for the window. For
755 example, for a static control, it will be the minimal size such that the
756 control label is not truncated. For windows containing subwindows (typically
757 \helpref{wxPanel
}{wxpanel
}), the size returned by this function will be the
758 same as the size the window would have had after calling
759 \helpref{Fit
}{wxwindowfit
}.
762 \membersection{wxWindow::GetCaret
}\label{wxwindowgetcaret
}
764 \constfunc{wxCaret *
}{GetCaret
}{\void}
766 Returns the
\helpref{caret
}{wxcaret
} associated with the window.
769 \membersection{wxWindow::GetCapture
}\label{wxwindowgetcapture
}
771 \func{static wxWindow *
}{GetCapture
}{\void}
773 Returns the currently captured window.
777 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
778 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
779 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
780 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
783 \membersection{wxWindow::GetCharHeight
}\label{wxwindowgetcharheight
}
785 \constfunc{virtual int
}{GetCharHeight
}{\void}
787 Returns the character height for this window.
790 \membersection{wxWindow::GetCharWidth
}\label{wxwindowgetcharwidth
}
792 \constfunc{virtual int
}{GetCharWidth
}{\void}
794 Returns the average character width for this window.
797 \membersection{wxWindow::GetChildren
}\label{wxwindowgetchildren
}
799 \func{wxList\&
}{GetChildren
}{\void}
801 Returns a reference to the list of the window's children.
804 \membersection{wxWindow::GetClassDefaultAttributes
}\label{wxwindowgetclassdefaultattributes
}
806 \func{static wxVisualAttributes
}{GetClassDefaultAttributes
}{\param{wxWindowVariant
}{ variant =
\texttt{wxWINDOW
\_VARIANT\_NORMAL}}}
808 Returns the default font and colours which are used by the control. This is
809 useful if you want to use the same font or colour in your own control as in a
810 standard control -- which is a much better idea than hard coding specific
811 colours or fonts which might look completely out of place on the users
812 system, especially if it uses themes.
814 The
\arg{variant
} parameter is only relevant under Mac currently and is
815 ignore under other platforms. Under Mac, it will change the size of the
816 returned font. See
\helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}
819 This static method is ``overridden'' in many derived classes and so calling,
820 for example,
\helpref{wxButton
}{wxbutton
}::GetClassDefaultAttributes() will typically
821 return the values appropriate for a button which will be normally different
822 from those returned by, say,
\helpref{wxListCtrl
}{wxlistctrl
}::GetClassDefaultAttributes().
824 The
\texttt{wxVisualAttributes
} structure has at least the fields
825 \texttt{font
},
\texttt{colFg
} and
\texttt{colBg
}. All of them may be invalid
826 if it was not possible to determine the default control appearance or,
827 especially for the background colour, if the field doesn't make sense as is
828 the case for
\texttt{colBg
} for the controls with themed background.
832 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
835 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
837 \constfunc{void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
839 \perlnote{In wxPerl this method takes no parameter and returns
840 a
2-element list
{\tt (width, height)
}.
}
842 \constfunc{wxSize
}{GetClientSize
}{\void}
844 This gets the size of the window `client area' in pixels.
845 The client area is the area which may be drawn on by the programmer,
846 excluding title bar, border, scrollbars, etc.
848 \wxheading{Parameters
}
850 \docparam{width
}{Receives the client width in pixels.
}
852 \docparam{height
}{Receives the client height in pixels.
}
854 \pythonnote{In place of a single overloaded method name, wxPython
855 implements the following methods:
\par
856 \indented{2cm
}{\begin{twocollist
}
857 \twocolitem{{\bf GetClientSizeTuple()
}}{Returns a
2-tuple of (width, height)
}
858 \twocolitem{{\bf GetClientSize()
}}{Returns a wxSize object
}
864 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
865 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
869 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
871 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
873 Returns a pointer to the window's layout constraints, or NULL if there are none.
876 \membersection{wxWindow::GetContainingSizer
}\label{wxwindowgetcontainingsizer
}
878 \constfunc{const wxSizer *
}{GetContainingSizer
}{\void}
880 Return the sizer that this window is a member of, if any, otherwise
884 \membersection{wxWindow::GetCursor
}\label{wxwindowgetcursor
}
886 \constfunc{const wxCursor\&
}{GetCursor
}{\void}
888 Return the cursor associated with this window.
892 \helpref{wxWindow::SetCursor
}{wxwindowsetcursor
}
895 \membersection{wxWindow::GetDefaultAttributes
}\label{wxwindowgetdefaultattributes
}
897 \constfunc{virtual wxVisualAttributes
}{GetDefaultAttributes
}{\void}
899 Currently this is the same as calling
900 \helpref{GetClassDefaultAttributes
}{wxwindowgetclassdefaultattributes
}(
\helpref{GetWindowVariant
}{wxwindowgetwindowvariant
}()).
902 One advantage of using this function compared to the static version is that
903 the call is automatically dispatched to the correct class (as usual with
904 virtual functions) and you don't have to specify the class name explicitly.
906 The other one is that in the future this function could return different
907 results, for example it might return a different font for an ``Ok'' button
908 than for a generic button if the users GUI is configured to show such buttons
909 in bold font. Of course, the down side is that it is impossible to call this
910 function without actually having an object to apply it to whereas the static
911 version can be used without having to create an object first.
914 \membersection{wxWindow::GetDropTarget
}\label{wxwindowgetdroptarget
}
916 \constfunc{wxDropTarget*
}{GetDropTarget
}{\void}
918 Returns the associated drop target, which may be NULL.
922 \helpref{wxWindow::SetDropTarget
}{wxwindowsetdroptarget
},
923 \helpref{Drag and drop overview
}{wxdndoverview
}
926 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
928 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
930 Returns the event handler for this window. By default, the window is its
935 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
936 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
937 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
938 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
939 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
942 \membersection{wxWindow::GetExtraStyle
}\label{wxwindowgetextrastyle
}
944 \constfunc{long
}{GetExtraStyle
}{\void}
946 Returns the extra style bits for the window.
949 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
951 \constfunc{wxFont
}{GetFont
}{\void}
953 Returns the font for this window.
957 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
960 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
962 \func{virtual wxColour
}{GetForegroundColour
}{\void}
964 Returns the foreground colour of the window.
968 The interpretation of foreground colour is open to interpretation according
969 to the window class; it may be the text colour or other colour, or it may not
974 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
975 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
976 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
979 \membersection{wxWindow::GetGrandParent
}\label{wxwindowgetgrandparent
}
981 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
983 Returns the grandparent of a window, or NULL if there isn't one.
986 \membersection{wxWindow::GetHandle
}\label{wxwindowgethandle
}
988 \constfunc{void*
}{GetHandle
}{\void}
990 Returns the platform-specific handle of the physical window. Cast it to an appropriate
991 handle, such as
{\bf HWND
} for Windows,
{\bf Widget
} for Motif or
{\bf GtkWidget
} for GTK.
993 \pythonnote{This method will return an integer in wxPython.
}
995 \perlnote{This method will return an integer in wxPerl.
}
998 \membersection{wxWindow::GetHelpText
}\label{wxwindowgethelptext
}
1000 \constfunc{virtual wxString
}{GetHelpText
}{\void}
1002 Gets the help text to be used as context-sensitive help for this window.
1004 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
1005 and not in the window object itself.
1007 \wxheading{See also
}
1009 \helpref{SetHelpText
}{wxwindowsethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
1012 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
1014 \constfunc{int
}{GetId
}{\void}
1016 Returns the identifier of the window.
1020 Each window has an integer identifier. If the application has not provided one
1021 (or the default Id -
1) an unique identifier with a negative value will be generated.
1023 \wxheading{See also
}
1025 \helpref{wxWindow::SetId
}{wxwindowsetid
},
\rtfsp
1026 \helpref{Window identifiers
}{windowids
}
1029 \membersection{wxWindow::GetLabel
}\label{wxwindowgetlabel
}
1031 \constfunc{virtual wxString
}{GetLabel
}{\void}
1033 Generic way of getting a label from any window, for
1034 identification purposes.
1038 The interpretation of this function differs from class to class.
1039 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
1040 the button text. This function can be useful for meta-programs (such as testing
1041 tools or special-needs access programs) which need to identify windows
1044 \membersection{wxWindow::GetMaxSize
}\label{wxwindowgetmaxsize
}
1046 \constfunc{wxSize
}{GetMaxSize
}{\void}
1048 Returns the maximum size of the window, an indication to the sizer layout mechanism
1049 that this is the maximum possible size.
1051 \membersection{wxWindow::GetMinSize
}\label{wxwindowgetminsize
}
1053 \constfunc{wxSize
}{GetMinSize
}{\void}
1055 Returns the minimum size of the window, an indication to the sizer layout mechanism
1056 that this is the minimum required size.
1058 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
1060 \constfunc{virtual wxString
}{GetName
}{\void}
1062 Returns the window's name.
1066 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
1067 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
1069 \wxheading{See also
}
1071 \helpref{wxWindow::SetName
}{wxwindowsetname
}
1074 \membersection{wxWindow::GetParent
}\label{wxwindowgetparent
}
1076 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
1078 Returns the parent of the window, or NULL if there is no parent.
1081 \membersection{wxWindow::GetPosition
}\label{wxwindowgetposition
}
1083 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
1085 \constfunc{wxPoint
}{GetPosition
}{\void}
1087 This gets the position of the window in pixels, relative to the parent window
1088 for the child windows or relative to the display origin for the top level
1091 \wxheading{Parameters
}
1093 \docparam{x
}{Receives the x position of the window.
}
1095 \docparam{y
}{Receives the y position of the window.
}
1097 \pythonnote{In place of a single overloaded method name, wxPython
1098 implements the following methods:
\par
1099 \indented{2cm
}{\begin{twocollist
}
1100 \twocolitem{{\bf GetPosition()
}}{Returns a wxPoint
}
1101 \twocolitem{{\bf GetPositionTuple()
}}{Returns a tuple (x, y)
}
1105 \perlnote{In wxPerl there are two methods instead of a single overloaded
1107 \indented{2cm
}{\begin{twocollist
}
1108 \twocolitem{{\bf GetPosition()
}}{Returns a Wx::Point
}
1109 \twocolitem{{\bf GetPositionXY()
}}{Returns a
2-element list
1115 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
1117 \constfunc{virtual wxRect
}{GetRect
}{\void}
1119 Returns the size and position of the window as a
\helpref{wxRect
}{wxrect
} object.
1122 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
1124 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
1126 Returns the built-in scrollbar position.
1128 \wxheading{See also
}
1130 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1133 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
1135 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
1137 Returns the built-in scrollbar range.
1139 \wxheading{See also
}
1141 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1144 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
1146 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
1148 Returns the built-in scrollbar thumb size.
1150 \wxheading{See also
}
1152 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
1155 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
1157 \constfunc{void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1159 \constfunc{wxSize
}{GetSize
}{\void}
1161 This gets the size of the entire window in pixels,
1162 including title bar, border, scrollbars, etc.
1164 \wxheading{Parameters
}
1166 \docparam{width
}{Receives the window width.
}
1168 \docparam{height
}{Receives the window height.
}
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 GetSize()
}}{Returns a wxSize
}
1174 \twocolitem{{\bf GetSizeTuple()
}}{Returns a
2-tuple (width, height)
}
1178 \perlnote{In wxPerl there are two methods instead of a single overloaded
1180 \indented{2cm
}{\begin{twocollist
}
1181 \twocolitem{{\bf GetSize()
}}{Returns a Wx::Size
}
1182 \twocolitem{{\bf GetSizeWH()
}}{Returns a
2-element list
1183 {\tt ( width, height )
}}
1187 \wxheading{See also
}
1189 \helpref{GetClientSize
}{wxwindowgetclientsize
},
\rtfsp
1190 \helpref{GetVirtualSize
}{wxwindowgetvirtualsize
}
1193 \membersection{wxWindow::GetSizer
}\label{wxwindowgetsizer
}
1195 \constfunc{wxSizer *
}{GetSizer
}{\void}
1197 Return the sizer associated with the window by a previous call to
1198 \helpref{SetSizer()
}{wxwindowsetsizer
} or
{\tt NULL
}.
1201 \membersection{wxWindow::GetTextExtent
}\label{wxwindowgettextextent
}
1203 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{x
},
\param{int*
}{y
},
1204 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
1205 \param{const wxFont*
}{font = NULL
},
\param{bool
}{ use16 =
{\tt false
}}}
1207 Gets the dimensions of the string as it would be drawn on the
1208 window with the currently selected font.
1210 \wxheading{Parameters
}
1212 \docparam{string
}{String whose extent is to be measured.
}
1214 \docparam{x
}{Return value for width.
}
1216 \docparam{y
}{Return value for height.
}
1218 \docparam{descent
}{Return value for descent (optional).
}
1220 \docparam{externalLeading
}{Return value for external leading (optional).
}
1222 \docparam{font
}{Font to use instead of the current window font (optional).
}
1224 \docparam{use16
}{If
{\tt true
},
{\it string
} contains
16-bit characters. The default is
{\tt false
}.
}
1226 \pythonnote{In place of a single overloaded method name, wxPython
1227 implements the following methods:
\par
1228 \indented{2cm
}{\begin{twocollist
}
1229 \twocolitem{{\bf GetTextExtent(string)
}}{Returns a
2-tuple, (width, height)
}
1230 \twocolitem{{\bf GetFullTextExtent(string, font=NULL)
}}{Returns a
1231 4-tuple, (width, height, descent, externalLeading)
}
1235 \perlnote{In wxPerl this method takes only the
{\tt string
} and optionally
1236 {\tt font
} parameters, and returns a
4-element list
1237 {\tt ( x, y, descent, externalLeading )
}.
}
1240 \membersection{wxWindow::GetTitle
}\label{wxwindowgettitle
}
1242 \func{virtual wxString
}{GetTitle
}{\void}
1244 Gets the window's title. Applicable only to frames and dialogs.
1246 \wxheading{See also
}
1248 \helpref{wxWindow::SetTitle
}{wxwindowsettitle
}
1251 \membersection{wxWindow::GetToolTip
}\label{wxwindowgettooltip
}
1253 \constfunc{wxToolTip*
}{GetToolTip
}{\void}
1255 Get the associated tooltip or NULL if none.
1258 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
1260 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
1262 Returns the region specifying which parts of the window have been damaged. Should
1263 only be called within an
\helpref{wxPaintEvent
}{wxpaintevent
} handler.
1265 \wxheading{See also
}
1267 \helpref{wxRegion
}{wxregion
},
\rtfsp
1268 \helpref{wxRegionIterator
}{wxregioniterator
}
1271 \membersection{wxWindow::GetValidator
}\label{wxwindowgetvalidator
}
1273 \constfunc{wxValidator*
}{GetValidator
}{\void}
1275 Returns a pointer to the current validator for the window, or NULL if there is none.
1278 \membersection{wxWindow::GetVirtualSize
}\label{wxwindowgetvirtualsize
}
1280 \constfunc{void
}{GetVirtualSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
1282 \constfunc{wxSize
}{GetVirtualSize
}{\void}
1284 This gets the virtual size of the window in pixels.
1286 \wxheading{Parameters
}
1288 \docparam{width
}{Receives the window virtual width.
}
1290 \docparam{height
}{Receives the window virtual height.
}
1292 \helpref{GetSize
}{wxwindowgetsize
},
\rtfsp
1293 \helpref{GetClientSize
}{wxwindowgetclientsize
}
1296 \membersection{wxWindow::GetWindowStyleFlag
}\label{wxwindowgetwindowstyleflag
}
1298 \constfunc{long
}{GetWindowStyleFlag
}{\void}
1300 Gets the window style that was passed to the constructor or
{\bf Create
}
1301 method.
{\bf GetWindowStyle()
} is another name for the same function.
1304 \membersection{wxWindow::GetWindowVariant
}\label{wxwindowgetwindowvariant
}
1306 \constfunc{wxWindowVariant
}{GetWindowVariant
}{\void}
1308 Returns the value previous passed to
1309 \helpref{wxWindow::SetWindowVariant
}{wxwindowsetwindowvariant
}.
1312 \membersection{wxWindow::HasCapture
}\label{wxwindowhascapture
}
1314 \constfunc{virtual bool
}{HasCapture
}{\void}
1316 Returns
{\tt true
} if this window has the current mouse capture.
1318 \wxheading{See also
}
1320 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
1321 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
1322 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
1325 \membersection{wxWindow::HasScrollbar
}\label{wxwindowhasscrollbar
}
1327 \constfunc{virtual bool
}{HasScrollbar
}{\param{int
}{orient
}}
1329 Returns
{\tt true
} if this window has a scroll bar for this orientation.
1331 \wxheading{Parameters
}
1333 \docparam{orient
}{Orientation to check, either
{\tt wxHORIZONTAL
} or
{\tt wxVERTICAL
}.
}
1336 \membersection{wxWindow::HasTransparentBackground
}\label{wxwindowhastransparentbackground
}
1338 \constfunc{virtual bool
}{HasTransparentBackground
}{\void}
1340 Returns
\true if this window background is transparent (as, for example, for
1341 wxStaticText) and should show the parent window background.
1343 This method is mostly used internally by the library itself and you normally
1344 shouldn't have to call it. You may, however, have to override it in your
1345 wxWindow-derived class to ensure that background is painted correctly.
1348 \membersection{wxWindow::Hide
}\label{wxwindowhide
}
1350 \func{bool
}{Hide
}{\void}
1352 Equivalent to calling
\helpref{Show
}{wxwindowshow
}(
{\tt false
}).
1355 \membersection{wxWindow::InheritAttributes
}\label{wxwindowinheritattributes
}
1357 \func{void
}{InheritAttributes
}{\void}
1359 This function is (or should be, in case of custom controls) called during
1360 window creation to intelligently set up the window visual attributes, that is
1361 the font and the foreground and background colours.
1363 By ``intelligently'' the following is meant: by default, all windows use their
1364 own
\helpref{default
}{wxwindowgetclassdefaultattributes
} attributes. However
1365 if some of the parents attributes are explicitly (that is, using
1366 \helpref{SetFont
}{wxwindowsetfont
} and not
1367 \helpref{SetOwnFont
}{wxwindowsetownfont
}) changed
\emph{and
} if the
1368 corresponding attribute hadn't been explicitly set for this window itself,
1369 then this window takes the same value as used by the parent. In addition, if
1370 the window overrides
\helpref{ShouldInheritColours
}{wxwindowshouldinheritcolours
}
1371 to return
\false, the colours will not be changed no matter what and only the
1374 This rather complicated logic is necessary in order to accommodate the
1375 different usage scenarios. The most common one is when all default attributes
1376 are used and in this case, nothing should be inherited as in modern GUIs
1377 different controls use different fonts (and colours) than their siblings so
1378 they can't inherit the same value from the parent. However it was also deemed
1379 desirable to allow to simply change the attributes of all children at once by
1380 just changing the font or colour of their common parent, hence in this case we
1381 do inherit the parents attributes.
1384 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
1386 \func{void
}{InitDialog
}{\void}
1388 Sends an
{\tt wxEVT
\_INIT\_DIALOG} event, whose handler usually transfers data
1389 to the dialog via validators.
1392 \membersection{wxWindow::InvalidateBestSize
}\label{wxwindowinvalidatebestsize
}
1394 \func{void
}{InvalidateBestSize
}{\void}
1396 Resets the cached best size value so it will be recalculated the next time it is needed.
1399 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
1401 \constfunc{virtual bool
}{IsEnabled
}{\void}
1403 Returns
{\tt true
} if the window is enabled for input,
{\tt false
} otherwise.
1405 \wxheading{See also
}
1407 \helpref{wxWindow::Enable
}{wxwindowenable
}
1410 \membersection{wxWindow::IsExposed
}\label{wxwindowisexposed
}
1412 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
}}
1414 \constfunc{bool
}{IsExposed
}{\param{wxPoint
}{\&pt
}}
1416 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
},
\param{int
}{w
},
\param{int
}{h
}}
1418 \constfunc{bool
}{IsExposed
}{\param{wxRect
}{\&rect
}}
1420 Returns
{\tt true
} if the given point or rectangle area has been exposed since the
1421 last repaint. Call this in an paint event handler to optimize redrawing by
1422 only redrawing those areas, which have been exposed.
1424 \pythonnote{In place of a single overloaded method name, wxPython
1425 implements the following methods:
\par
1426 \indented{2cm
}{\begin{twocollist
}
1427 \twocolitem{{\bf IsExposed(x,y, w=
0,h=
0)
}}{}
1428 \twocolitem{{\bf IsExposedPoint(pt)
}}{}
1429 \twocolitem{{\bf IsExposedRect(rect)
}}{}
1433 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
1435 \constfunc{virtual bool
}{IsRetained
}{\void}
1437 Returns
{\tt true
} if the window is retained,
{\tt false
} otherwise.
1441 Retained windows are only available on X platforms.
1444 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
1446 \constfunc{virtual bool
}{IsShown
}{\void}
1448 Returns
{\tt true
} if the window is shown,
{\tt false
} if it has been hidden.
1451 \membersection{wxWindow::IsTopLevel
}\label{wxwindowistoplevel
}
1453 \constfunc{bool
}{IsTopLevel
}{\void}
1455 Returns
{\tt true
} if the given window is a top-level one. Currently all frames and
1456 dialogs are considered to be top-level windows (even if they have a parent
1460 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
1462 \func{void
}{Layout
}{\void}
1464 Invokes the constraint-based layout algorithm or the sizer-based algorithm
1467 See
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
}: when auto
1468 layout is on, this function gets called automatically when the window is resized.
1471 \membersection{wxWindow::LineDown
}\label{wxwindowlinedown
}
1473 This is just a wrapper for
\helpref{ScrollLines()
}{wxwindowscrolllines
}$(
1)$.
1476 \membersection{wxWindow::LineUp
}\label{wxwindowlineup
}
1478 This is just a wrapper for
\helpref{ScrollLines()
}{wxwindowscrolllines
}$(-
1)$.
1481 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
1483 \func{void
}{Lower
}{\void}
1485 Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
1489 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
1491 \func{virtual void
}{MakeModal
}{\param{bool
}{flag
}}
1493 Disables all other windows in the application so that
1494 the user can only interact with this window.
1496 \wxheading{Parameters
}
1498 \docparam{flag
}{If
{\tt true
}, this call disables all other windows in the application so that
1499 the user can only interact with this window. If
{\tt false
}, the effect is reversed.
}
1502 \membersection{wxWindow::Move
}\label{wxwindowmove
}
1504 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
1506 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
1508 Moves the window to the given position.
1510 \wxheading{Parameters
}
1512 \docparam{x
}{Required x position.
}
1514 \docparam{y
}{Required y position.
}
1516 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
1520 Implementations of SetSize can also implicitly implement the
1521 wxWindow::Move function, which is defined in the base wxWindow class
1525 SetSize(x, y, -
1, -
1, wxSIZE_USE_EXISTING);
1528 \wxheading{See also
}
1530 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
1532 \pythonnote{In place of a single overloaded method name, wxPython
1533 implements the following methods:
\par
1534 \indented{2cm
}{\begin{twocollist
}
1535 \twocolitem{{\bf Move(point)
}}{Accepts a wxPoint
}
1536 \twocolitem{{\bf MoveXY(x, y)
}}{Accepts a pair of integers
}
1541 \membersection{wxWindow::MoveAfterInTabOrder
}\label{wxwindowmoveafterintaborder
}
1543 \func{void
}{MoveAfterInTabOrder
}{\param{wxWindow *
}{win
}}
1545 Moves this window in the tab navigation order after the specified
\arg{win
}.
1546 This means that when the user presses
\texttt{TAB
} key on that other window,
1547 the focus switches to this window.
1549 Default tab order is the same as creation order, this function and
1550 \helpref{MoveBeforeInTabOrder()
}{wxwindowmovebeforeintaborder
} allow to change
1551 it after creating all the windows.
1553 \wxheading{Parameters
}
1555 \docparam{win
}{A sibling of this window which should precede it in tab order,
1559 \membersection{wxWindow::MoveBeforeInTabOrder
}\label{wxwindowmovebeforeintaborder
}
1561 \func{void
}{MoveBeforeInTabOrder
}{\param{wxWindow *
}{win
}}
1563 Same as
\helpref{MoveAfterInTabOrder
}{wxwindowmoveafterintaborder
} except that
1564 it inserts this window just before
\arg{win
} instead of putting it right after
1568 \membersection{wxWindow::Navigate
}\label{wxwindownavigate
}
1570 \func{bool
}{Navigate
}{\param{int
}{ flags = wxNavigationKeyEvent::IsForward
}}
1572 Does keyboard navigation from this window to another, by sending
1573 a wxNavigationKeyEvent.
1575 \wxheading{Parameters
}
1577 \docparam{flags
}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.
}
1581 You may wish to call this from a text control custom keypress handler to do the default
1582 navigation behaviour for the tab key, since the standard default behaviour for
1583 a multiline text control with the wxTE
\_PROCESS\_TAB style is to insert a tab
1584 and not navigate to the next control.
1586 %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving
1587 %% the old docs here in case we want to move any still needed bits to
1588 %% the right location (i.e. probably the corresponding events docs)
1590 %% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
1592 %% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
1594 %% Called when a window is activated or deactivated.
1596 %% \wxheading{Parameters}
1598 %% \docparam{event}{Object containing activation information.}
1600 %% \wxheading{Remarks}
1602 %% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt true},
1603 %% otherwise it returns {\tt false} (it is being deactivated).
1605 %% \wxheading{See also}
1607 %% \helpref{wxActivateEvent}{wxactivateevent},\rtfsp
1608 %% \helpref{Event handling overview}{eventhandlingoverview}
1610 %% \membersection{wxWindow::OnChar}\label{wxwindowonchar}
1612 %% \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
1614 %% Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
1616 %% \wxheading{Parameters}
1618 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1619 %% details about this class.}
1621 %% \wxheading{Remarks}
1623 %% This member function is called in response to a keypress. To intercept this event,
1624 %% use the EVT\_CHAR macro in an event table definition. Your {\bf OnChar} handler may call this
1625 %% default function to achieve default keypress functionality.
1627 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1630 %% Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
1631 %% keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1632 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1634 %% Most, but not all, windows allow keypresses to be intercepted.
1636 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1637 %% otherwise menu shortcuts may cease to work under Windows.
1639 %% \wxheading{See also}
1641 %% \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1642 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1643 %% \helpref{Event handling overview}{eventhandlingoverview}
1645 %% \membersection{wxWindow::OnCharHook}\label{wxwindowoncharhook}
1647 %% \func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
1649 %% This member is called to allow the window to intercept keyboard events
1650 %% before they are processed by child windows.
1652 %% \wxheading{Parameters}
1654 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1655 %% details about this class.}
1657 %% \wxheading{Remarks}
1659 %% This member function is called in response to a keypress, if the window is active. To intercept this event,
1660 %% use the EVT\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
1661 %% keypress, call \helpref{wxEvent::Skip}{wxeventskip} to allow default processing.
1663 %% An example of using this function is in the implementation of escape-character processing for wxDialog,
1664 %% where pressing ESC dismisses the dialog by {\bf OnCharHook} 'forging' a cancel button press event.
1666 %% Note that the ASCII values do not have explicit key codes: they are passed as ASCII
1669 %% This function is only relevant to top-level windows (frames and dialogs), and under
1670 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
1671 %% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
1672 %% the window won't get the event.
1674 %% \wxheading{See also}
1676 %% \helpref{wxKeyEvent}{wxkeyevent},\rtfsp
1677 %% \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1678 %% %% GD: OnXXX functions are not documented
1679 %% %%\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp
1680 %% \helpref{Event handling overview}{eventhandlingoverview}
1682 %% \membersection{wxWindow::OnCommand}\label{wxwindowoncommand}
1684 %% \func{virtual void}{OnCommand}{\param{wxEvtHandler\& }{object}, \param{wxCommandEvent\& }{event}}
1686 %% This virtual member function is called if the control does not handle the command event.
1688 %% \wxheading{Parameters}
1690 %% \docparam{object}{Object receiving the command event.}
1692 %% \docparam{event}{Command event}
1694 %% \wxheading{Remarks}
1696 %% This virtual function is provided mainly for backward compatibility. You can also intercept commands
1697 %% from child controls by using an event table, with identifiers or identifier ranges to identify
1698 %% the control(s) in question.
1700 %% \wxheading{See also}
1702 %% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1703 %% \helpref{Event handling overview}{eventhandlingoverview}
1705 %% \membersection{wxWindow::OnClose}\label{wxwindowonclose}
1707 %% \func{virtual bool}{OnClose}{\void}
1709 %% Called when the user has tried to close a a frame
1710 %% or dialog box using the window manager (X) or system menu (Windows).
1712 %% {\bf Note:} This is an obsolete function.
1713 %% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
1716 %% \wxheading{Return value}
1718 %% If {\tt true} is returned by OnClose, the window will be deleted by the system, otherwise the
1719 %% attempt will be ignored. Do not delete the window from within this handler, although
1720 %% you may delete other windows.
1722 %% \wxheading{See also}
1724 %% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
1725 %% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
1726 %% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
1727 %% \helpref{wxCloseEvent}{wxcloseevent}
1729 %% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
1731 %% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
1733 %% Called when the user has pressed a key, before it is translated into an ASCII value using other
1734 %% modifier keys that might be pressed at the same time.
1736 %% \wxheading{Parameters}
1738 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1739 %% details about this class.}
1741 %% \wxheading{Remarks}
1743 %% This member function is called in response to a key down event. To intercept this event,
1744 %% use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this
1745 %% default function to achieve default keypress functionality.
1747 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
1748 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1749 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1751 %% Most, but not all, windows allow keypresses to be intercepted.
1753 %% {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function,
1754 %% otherwise menu shortcuts may cease to work under Windows.
1756 %% \wxheading{See also}
1758 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp
1759 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1760 %% \helpref{Event handling overview}{eventhandlingoverview}
1762 %% \membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup}
1764 %% \func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}}
1766 %% Called when the user has released a key.
1768 %% \wxheading{Parameters}
1770 %% \docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for
1771 %% details about this class.}
1773 %% \wxheading{Remarks}
1775 %% This member function is called in response to a key up event. To intercept this event,
1776 %% use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this
1777 %% default function to achieve default keypress functionality.
1779 %% Note that not all keypresses can be intercepted this way. If you wish to intercept special
1780 %% keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
1781 %% \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
1783 %% Most, but not all, windows allow key up events to be intercepted.
1785 %% \wxheading{See also}
1787 %% \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp
1788 %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
1789 %% \helpref{Event handling overview}{eventhandlingoverview}
1791 %% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
1793 %% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
1795 %% Default handler for the wxEVT\_INIT\_DIALOG event. Calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
1797 %% \wxheading{Parameters}
1799 %% \docparam{event}{Dialog initialisation event.}
1801 %% \wxheading{Remarks}
1803 %% Gives the window the default behaviour of transferring data to child controls via
1804 %% the validator that each control has.
1806 %% \wxheading{See also}
1808 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
1810 %% \membersection{wxWindow::OnMenuCommand}\label{wxwindowonmenucommand}
1812 %% \func{void}{OnMenuCommand}{\param{wxCommandEvent\& }{event}}
1814 %% Called when a menu command is received from a menu bar.
1816 %% \wxheading{Parameters}
1818 %% \docparam{event}{The menu command event. For more information, see \helpref{wxCommandEvent}{wxcommandevent}.}
1820 %% \wxheading{Remarks}
1822 %% A function with this name doesn't actually exist; you can choose any member function to receive
1823 %% menu command events, using the EVT\_COMMAND macro for individual commands or EVT\_COMMAND\_RANGE for
1824 %% a range of commands.
1826 %% \wxheading{See also}
1828 %% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
1829 %% \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight},\rtfsp
1830 %% \helpref{Event handling overview}{eventhandlingoverview}
1832 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
1834 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
1836 %% Called when a menu select is received from a menu bar: that is, the
1837 %% mouse cursor is over a menu item, but the left mouse button has not been
1840 %% \wxheading{Parameters}
1842 %% \docparam{event}{The menu highlight event. For more information, see \helpref{wxMenuEvent}{wxmenuevent}.}
1844 %% \wxheading{Remarks}
1846 %% You can choose any member function to receive
1847 %% menu select events, using the EVT\_MENU\_HIGHLIGHT macro for individual menu items or EVT\_MENU\_HIGHLIGHT\_ALL macro
1848 %% for all menu items.
1850 %% The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
1851 %% text in the first field of the status bar.
1853 %% This function was known as {\bf OnMenuSelect} in earlier versions of wxWidgets, but this was confusing
1854 %% since a selection is normally a left-click action.
1856 %% \wxheading{See also}
1858 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
1859 %% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp
1860 %% \helpref{Event handling overview}{eventhandlingoverview}
1863 %% \membersection{wxWindow::OnMouseEvent}\label{wxwindowonmouseevent}
1865 %% \func{void}{OnMouseEvent}{\param{wxMouseEvent\&}{ event}}
1867 %% Called when the user has initiated an event with the
1870 %% \wxheading{Parameters}
1872 %% \docparam{event}{The mouse event. See \helpref{wxMouseEvent}{wxmouseevent} for
1875 %% \wxheading{Remarks}
1877 %% Most, but not all, windows respond to this event.
1879 %% To intercept this event, use the EVT\_MOUSE\_EVENTS macro in an event table definition, or individual
1880 %% mouse event macros such as EVT\_LEFT\_DOWN.
1882 %% \wxheading{See also}
1884 %% \helpref{wxMouseEvent}{wxmouseevent},\rtfsp
1885 %% \helpref{Event handling overview}{eventhandlingoverview}
1887 %% \membersection{wxWindow::OnMove}\label{wxwindowonmove}
1889 %% \func{void}{OnMove}{\param{wxMoveEvent\& }{event}}
1891 %% Called when a window is moved.
1893 %% \wxheading{Parameters}
1895 %% \docparam{event}{The move event. For more information, see \helpref{wxMoveEvent}{wxmoveevent}.}
1897 %% \wxheading{Remarks}
1899 %% Use the EVT\_MOVE macro to intercept move events.
1901 %% \wxheading{Remarks}
1903 %% Not currently implemented.
1905 %% \wxheading{See also}
1907 %% \helpref{wxMoveEvent}{wxmoveevent},\rtfsp
1908 %% \helpref{wxFrame::OnSize}{wxframeonsize},\rtfsp
1909 %% \helpref{Event handling overview}{eventhandlingoverview}
1911 %% \membersection{wxWindow::OnPaint}\label{wxwindowonpaint}
1913 %% \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
1915 %% Sent to the event handler when the window must be refreshed.
1917 %% \wxheading{Parameters}
1919 %% \docparam{event}{Paint event. For more information, see \helpref{wxPaintEvent}{wxpaintevent}.}
1921 %% \wxheading{Remarks}
1923 %% Use the EVT\_PAINT macro in an event table definition to intercept paint events.
1925 %% Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
1926 %% even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
1932 %% void MyWindow::OnPaint(wxPaintEvent\& event)
1934 %% wxPaintDC dc(this);
1936 %% DrawMyDocument(dc);
1941 %% You can optimize painting by retrieving the rectangles
1942 %% that have been damaged and only repainting these. The rectangles are in
1943 %% terms of the client area, and are unscrolled, so you will need to do
1944 %% some calculations using the current view position to obtain logical,
1947 %% Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
1951 %% // Called when window needs to be repainted.
1952 %% void MyWindow::OnPaint(wxPaintEvent\& event)
1954 %% wxPaintDC dc(this);
1956 %% // Find Out where the window is scrolled to
1957 %% int vbX,vbY; // Top left corner of client
1958 %% GetViewStart(&vbX,&vbY);
1960 %% int vX,vY,vW,vH; // Dimensions of client area in pixels
1961 %% wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1970 %% // Alternatively we can do this:
1972 %% // upd.GetRect(&rect);
1974 %% // Repaint this rectangle
1983 %% \wxheading{See also}
1985 %% \helpref{wxPaintEvent}{wxpaintevent},\rtfsp
1986 %% \helpref{wxPaintDC}{wxpaintdc},\rtfsp
1987 %% \helpref{Event handling overview}{eventhandlingoverview}
1989 %% \membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
1991 %% \func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
1993 %% Called when a scroll window event is received from one of the window's built-in scrollbars.
1995 %% \wxheading{Parameters}
1997 %% \docparam{event}{Command event. Retrieve the new scroll position by
1998 %% calling \helpref{wxScrollEvent::GetPosition}{wxscrolleventgetposition}, and the
1999 %% scrollbar orientation by calling \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}.}
2001 %% \wxheading{Remarks}
2003 %% Note that it is not possible to distinguish between horizontal and vertical scrollbars
2004 %% until the function is executing (you can't have one function for vertical, another
2005 %% for horizontal events).
2007 %% \wxheading{See also}
2009 %% \helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp
2010 %% \helpref{Event handling overview}{eventhandlingoverview}
2012 %% \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus}
2014 %% \func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
2016 %% Called when a window's focus is being set.
2018 %% \wxheading{Parameters}
2020 %% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
2022 %% \wxheading{Remarks}
2024 %% To intercept this event, use the macro EVT\_SET\_FOCUS in an event table definition.
2026 %% Most, but not all, windows respond to this event.
2028 %% \wxheading{See also}
2030 %% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
2031 %% \helpref{Event handling overview}{eventhandlingoverview}
2033 %% \membersection{wxWindow::OnSize}\label{wxwindowonsize}
2035 %% \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
2037 %% Called when the window has been resized. This is not a virtual function; you should
2038 %% provide your own non-virtual OnSize function and direct size events to it using EVT\_SIZE
2039 %% in an event table definition.
2041 %% \wxheading{Parameters}
2043 %% \docparam{event}{Size event. For more information, see \helpref{wxSizeEvent}{wxsizeevent}.}
2045 %% \wxheading{Remarks}
2047 %% You may wish to use this for frames to resize their child windows as appropriate.
2049 %% Note that the size passed is of
2050 %% the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
2051 %% used by the application.
2053 %% When a window is resized, usually only a small part of the window is damaged and you
2054 %% may only need to repaint that area. However, if your drawing depends on the size of the window,
2055 %% you may need to clear the DC explicitly and repaint the whole window. In which case, you
2056 %% may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
2058 %% \wxheading{See also}
2060 %% \helpref{wxSizeEvent}{wxsizeevent},\rtfsp
2061 %% \helpref{Event handling overview}{eventhandlingoverview}
2063 %% \membersection{wxWindow::OnSysColourChanged}\label{wxwindowonsyscolourchanged}
2065 %% \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}}
2067 %% Called when the user has changed the system colours. Windows only.
2069 %% \wxheading{Parameters}
2071 %% \docparam{event}{System colour change event. For more information, see \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}.}
2073 %% \wxheading{See also}
2075 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
2076 %% \helpref{Event handling overview}{eventhandlingoverview}
2079 \membersection{wxWindow::OnInternalIdle
}\label{wxwindowoninternalidle
}
2081 \func{virtual void
}{OnInternalIdle
}{\void}
2083 This virtual function is normally only used internally, but
2084 sometimes an application may need it to implement functionality
2085 that should not be disabled by an application defining an OnIdle
2086 handler in a derived class.
2088 This function may be used to do delayed painting, for example,
2089 and most implementations call
\helpref{wxWindow::UpdateWindowUI
}{wxwindowupdatewindowui
}
2090 in order to send update events to the window in idle time.
2093 \membersection{wxWindow::PageDown
}\label{wxwindowpagedown
}
2095 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(
1)$.
2098 \membersection{wxWindow::PageUp
}\label{wxwindowpageup
}
2100 This is just a wrapper for
\helpref{ScrollPages()
}{wxwindowscrollpages
}$(-
1)$.
2103 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
2105 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler =
{\tt false
}}}
2107 Removes and returns the top-most event handler on the event handler stack.
2109 \wxheading{Parameters
}
2111 \docparam{deleteHandler
}{If this is
{\tt true
}, the handler will be deleted after it is removed. The
2112 default value is
{\tt false
}.
}
2114 \wxheading{See also
}
2116 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2117 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2118 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2119 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2120 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
2123 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
2125 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{const wxPoint\&
}{pos = wxDefaultPosition
}}
2127 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
2129 Pops up the given menu at the specified coordinates, relative to this
2130 window, and returns control when the user has dismissed the menu. If a
2131 menu item is selected, the corresponding menu event is generated and will be
2132 processed as usually. If the coordinates are not specified, current mouse
2133 cursor position is used.
2135 \wxheading{Parameters
}
2137 \docparam{menu
}{Menu to pop up.
}
2139 \docparam{pos
}{The position where the menu will appear.
}
2141 \docparam{x
}{Required x position for the menu to appear.
}
2143 \docparam{y
}{Required y position for the menu to appear.
}
2145 \wxheading{See also
}
2147 \helpref{wxMenu
}{wxmenu
}
2151 Just before the menu is popped up,
\helpref{wxMenu::UpdateUI
}{wxmenuupdateui
}
2152 is called to ensure that the menu items are in the correct state. The menu does
2153 not get deleted by the window.
2155 It is recommended to not explicitly specify coordinates when calling PopupMenu
2156 in response to mouse click, because some of the ports (namely, wxGTK) can do
2157 a better job of positioning the menu in that case.
2159 \pythonnote{In place of a single overloaded method name, wxPython
2160 implements the following methods:
\par
2161 \indented{2cm
}{\begin{twocollist
}
2162 \twocolitem{{\bf PopupMenu(menu, point)
}}{Specifies position with a wxPoint
}
2163 \twocolitem{{\bf PopupMenuXY(menu, x, y)
}}{Specifies position with two integers (x, y)
}
2168 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
2170 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2172 Pushes this event handler onto the event stack for the window.
2174 \wxheading{Parameters
}
2176 \docparam{handler
}{Specifies the handler to be pushed.
}
2180 An event handler is an object that is capable of processing the events
2181 sent to a window. By default, the window is its own event handler, but
2182 an application may wish to substitute another, for example to allow
2183 central implementation of event-handling for a variety of different
2186 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
2187 an application to set up a chain of event handlers, where an event not handled by one event handler is
2188 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
2189 remove the event handler.
2191 \wxheading{See also
}
2193 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
2194 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2195 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2196 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2197 \helpref{wxEvtHandler
}{wxevthandler
}
2200 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
2202 \func{void
}{Raise
}{\void}
2204 Raises the window to the top of the window hierarchy if it is a managed window (dialog
2208 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
2210 \func{virtual void
}{Refresh
}{\param{bool
}{ eraseBackground =
{\tt true
}},
\param{const wxRect*
}{rect
2213 Causes an event to be generated to repaint the
2216 \wxheading{Parameters
}
2218 \docparam{eraseBackground
}{If
{\tt true
}, the background will be
2221 \docparam{rect
}{If non-NULL, only the given rectangle will
2222 be treated as damaged.
}
2224 \wxheading{See also
}
2226 \helpref{wxWindow::RefreshRect
}{wxwindowrefreshrect
}
2229 \membersection{wxWindow::RefreshRect
}\label{wxwindowrefreshrect
}
2231 \func{void
}{RefreshRect
}{\param{const wxRect\&
}{rect
}}
2233 Redraws the contents of the given rectangle: the area inside it will be
2236 This is the same as
\helpref{Refresh
}{wxwindowrefresh
} but has a nicer syntax.
2239 \membersection{wxWindow::RegisterHotKey
}\label{wxwindowregisterhotkey
}
2241 \func{bool
}{RegisterHotKey
}{\param{int
}{ hotkeyId
},
\param{int
}{ modifiers
},
\param{int
}{ virtualKeyCode
}}
2243 Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window
2244 will receive a hotkey event. It will receive the event even if the application is in the background
2245 and does not have the input focus because the user is working with some other application.
2247 \wxheading{Parameters
}
2249 \docparam{hotkeyId
}{Numeric identifier of the hotkey. For applications this must be between
0 and
0xBFFF. If
2250 this function is called from a shared DLL, it must be a system wide unique identifier between
0xC000 and
0xFFFF.
2251 This is a MSW specific detail.
}
2253 \docparam{modifiers
}{A bitwise combination of
{\tt wxMOD
\_SHIFT},
{\tt wxMOD
\_CONTROL},
{\tt wxMOD
\_ALT}
2254 or
{\tt wxMOD
\_WIN} specifying the modifier keys that have to be pressed along with the key.
}
2256 \docparam{virtualKeyCode
}{The virtual key code of the hotkey.
}
2258 \wxheading{Return value
}
2260 {\tt true
} if the hotkey was registered successfully.
{\tt false
} if some other application already registered a
2261 hotkey with this modifier/virtualKeyCode combination.
2265 Use EVT
\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
2266 This function is currently only implemented under MSW.
2268 \wxheading{See also
}
2270 \helpref{wxWindow::UnregisterHotKey
}{wxwindowunregisterhotkey
}
2273 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
2275 \func{virtual void
}{ReleaseMouse
}{\void}
2277 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
2279 \wxheading{See also
}
2281 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
},
2282 \helpref{wxWindow::HasCapture
}{wxwindowhascapture
},
2283 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
},
2284 \helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}
2287 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
2289 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
2291 Removes a child window. This is called automatically by window deletion
2292 functions so should not be required by the application programmer.
2294 Notice that this function is mostly internal to wxWidgets and shouldn't be
2295 called by the user code.
2297 \wxheading{Parameters
}
2299 \docparam{child
}{Child window to remove.
}
2302 \membersection{wxWindow::RemoveEventHandler
}\label{wxwindowremoveeventhandler
}
2304 \func{bool
}{RemoveEventHandler
}{\param{wxEvtHandler *
}{handler
}}
2306 Find the given
{\it handler
} in the windows event handler chain and remove (but
2307 not delete) it from it.
2309 \wxheading{Parameters
}
2311 \docparam{handler
}{The event handler to remove, must be non
{\tt NULL
} and
2312 must be present in this windows event handlers chain
}
2314 \wxheading{Return value
}
2316 Returns
{\tt true
} if it was found and
{\tt false
} otherwise (this also results
2317 in an assert failure so this function should only be called when the
2318 handler is supposed to be there).
2320 \wxheading{See also
}
2322 \helpref{PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2323 \helpref{PopEventHandler
}{wxwindowpopeventhandler
}
2326 \membersection{wxWindow::Reparent
}\label{wxwindowreparent
}
2328 \func{virtual bool
}{Reparent
}{\param{wxWindow*
}{newParent
}}
2330 Reparents the window, i.e the window will be removed from its
2331 current parent window (e.g. a non-standard toolbar in a wxFrame)
2332 and then re-inserted into another. Available on Windows and GTK.
2334 \wxheading{Parameters
}
2336 \docparam{newParent
}{New parent.
}
2339 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
2341 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
2343 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
2345 Converts from screen to client window coordinates.
2347 \wxheading{Parameters
}
2349 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
2351 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
2353 \docparam{pt
}{The screen position for the second form of the function.
}
2355 \pythonnote{In place of a single overloaded method name, wxPython
2356 implements the following methods:
\par
2357 \indented{2cm
}{\begin{twocollist
}
2358 \twocolitem{{\bf ScreenToClient(point)
}}{Accepts and returns a wxPoint
}
2359 \twocolitem{{\bf ScreenToClientXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
2364 \membersection{wxWindow::ScrollLines
}\label{wxwindowscrolllines
}
2366 \func{virtual bool
}{ScrollLines
}{\param{int
}{lines
}}
2368 Scrolls the window by the given number of lines down (if
{\it lines
} is
2371 \wxheading{Return value
}
2373 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2374 on top/bottom and nothing was done.
2378 This function is currently only implemented under MSW and wxTextCtrl under
2379 wxGTK (it also works for wxScrolledWindow derived classes under all
2382 \wxheading{See also
}
2384 \helpref{ScrollPages
}{wxwindowscrollpages
}
2387 \membersection{wxWindow::ScrollPages
}\label{wxwindowscrollpages
}
2389 \func{virtual bool
}{ScrollPages
}{\param{int
}{pages
}}
2391 Scrolls the window by the given number of pages down (if
{\it pages
} is
2394 \wxheading{Return value
}
2396 Returns
{\tt true
} if the window was scrolled,
{\tt false
} if it was already
2397 on top/bottom and nothing was done.
2401 This function is currently only implemented under MSW and wxTextCtrl under
2402 wxGTK (it also works for wxScrolledWindow derived classes under all
2405 \wxheading{See also
}
2407 \helpref{ScrollLines
}{wxwindowscrolllines
}
2410 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
2412 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
2414 Physically scrolls the pixels in the window and move child windows accordingly.
2416 \wxheading{Parameters
}
2418 \docparam{dx
}{Amount to scroll horizontally.
}
2420 \docparam{dy
}{Amount to scroll vertically.
}
2422 \docparam{rect
}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
2423 pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
2424 can optimize painting by checking for the invalidated region. This parameter is ignored under GTK.
}
2428 Use this function to optimise your scrolling implementations, to minimise the area that must be
2429 redrawn. Note that it is rarely required to call this function from a user program.
2432 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
2434 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
2436 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
2439 \membersection{wxWindow::SetAccessible
}\label{wxwindowsetaccessible
}
2441 \func{void
}{SetAccessible
}{\param{wxAccessible*
}{ accessible
}}
2443 Sets the accessible for this window. Any existing accessible for this window
2444 will be deleted first, if not identical to
{\it accessible
}.
2446 See also
\helpref{wxAccessible
}{wxaccessible
}.
2449 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
2451 \func{void
}{SetAutoLayout
}{\param{bool
}{ autoLayout
}}
2453 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
2454 be called automatically when the window is resized. It is called implicitly by
2455 \helpref{wxWindow::SetSizer
}{wxwindowsetsizer
} but if you use
2456 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
} you should call it
2457 manually or otherwise the window layout won't be correctly updated when its
2460 \wxheading{Parameters
}
2462 \docparam{autoLayout
}{Set this to
{\tt true
} if you wish the Layout function to be called
2463 from within wxWindow::OnSize functions.
}
2465 \wxheading{See also
}
2467 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
2470 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
2472 \func{virtual bool
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
2474 Sets the background colour of the window.
2476 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
2477 explanation of the difference between this method and
2478 \helpref{SetOwnBackgroundColour
}{wxwindowsetownbackgroundcolour
}.
2480 \wxheading{Parameters
}
2482 \docparam{colour
}{The colour to be used as the background colour, pass
2483 {\tt wxNullColour
} to reset to the default colour.
}
2487 The background colour is usually painted by the default
\rtfsp
2488 \helpref{wxEraseEvent
}{wxeraseevent
} event handler function
2489 under Windows and automatically under GTK.
2491 Note that setting the background colour does not cause an immediate refresh, so you
2492 may wish to call
\helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
} or
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} after
2493 calling this function.
2495 Using this function will disable attempts to use themes for this
2496 window, if the system supports them. Use with care since usually the
2497 themes represent the appearance chosen by the user to be used for all
2498 applications on the system.
2501 \wxheading{See also
}
2503 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
2504 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
2505 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2506 \helpref{wxWindow::ClearBackground
}{wxwindowclearbackground
},
\rtfsp
2507 \helpref{wxWindow::Refresh
}{wxwindowrefresh
},
\rtfsp
2508 \helpref{wxEraseEvent
}{wxeraseevent
}
2510 \membersection{wxWindow::SetBackgroundStyle
}\label{wxwindowsetbackgroundstyle
}
2512 \func{virtual void
}{SetBackgroundStyle
}{\param{wxBackgroundStyle
}{ style
}}
2514 Sets the background style of the window. The background style indicates
2515 whether background colour should be determined by the system (wxBG
\_STYLE\_SYSTEM),
2516 be set to a specific colour (wxBG
\_STYLE\_COLOUR), or should be left to the
2517 application to implement (wxBG
\_STYLE\_CUSTOM).
2519 On GTK+, use of wxBG
\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
2520 background, such as a tiled bitmap. Currently the style has no effect on other platforms.
2522 \wxheading{See also
}
2524 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2525 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2526 \helpref{wxWindow::GetBackgroundStyle
}{wxwindowgetbackgroundstyle
}
2529 \membersection{wxWindow::SetBestFittingSize
}\label{wxwindowsetbestfittingsize
}
2531 \func{void
}{SetBestFittingSize
}{\param{const wxSize\&
}{size = wxDefaultSize
}}
2533 A
{\it smart
} SetSize that will fill in default size components with the
2534 window's
{\it best
} size values. Also sets the window's minsize to
2535 the value passed in for use with sizers. This means that if a full or
2536 partial size is passed to this function then the sizers will use that
2537 size instead of the results of GetBestSize to determine the minimum
2538 needs of the window for layout.
2540 \wxheading{See also
}
2542 \helpref{wxWindow::SetSize
}{wxwindowsetsize
},
\rtfsp
2543 \helpref{wxWindow::GetBestSize
}{wxwindowgetbestsize
},
\rtfsp
2544 \helpref{wxWindow::GetBestFittingSize
}{wxwindowgetbestfittingsize
},
\rtfsp
2545 \helpref{wxWindow::SetSizeHints
}{wxwindowsetsizehints
}
2548 \membersection{wxWindow::SetCaret
}\label{wxwindowsetcaret
}
2550 \constfunc{void
}{SetCaret
}{\param{wxCaret *
}{caret
}}
2552 Sets the
\helpref{caret
}{wxcaret
} associated with the window.
2555 \membersection{wxWindow::SetClientSize
}\label{wxwindowsetclientsize
}
2557 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
2559 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
2561 This sets the size of the window client area in pixels. Using this function to size a window
2562 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
2563 worry about what dimensions the border or title bar have when trying to fit the window
2564 around panel items, for example.
2566 \wxheading{Parameters
}
2568 \docparam{width
}{The required client area width.
}
2570 \docparam{height
}{The required client area height.
}
2572 \docparam{size
}{The required client size.
}
2574 \pythonnote{In place of a single overloaded method name, wxPython
2575 implements the following methods:
\par
2576 \indented{2cm
}{\begin{twocollist
}
2577 \twocolitem{{\bf SetClientSize(size)
}}{Accepts a wxSize
}
2578 \twocolitem{{\bf SetClientSizeWH(width, height)
}}{}
2583 \membersection{wxWindow::SetContainingSizer
}\label{wxwindowsetcontainingsizer
}
2585 \func{void
}{SetContainingSizer
}{\param{wxSizer*
}{sizer
}}
2587 This normally does not need to be called by user code. It is called
2588 when a window is added to a sizer, and is used so the window can
2589 remove itself from the sizer when it is destroyed.
2592 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
2594 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
2596 % VZ: the docs are correct, if the code doesn't behave like this, it must be
2598 Sets the window's cursor. Notice that the window cursor also sets it for the
2599 children of the window implicitly.
2601 The
{\it cursor
} may be
{\tt wxNullCursor
} in which case the window cursor will
2602 be reset back to default.
2604 \wxheading{Parameters
}
2606 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
2608 \wxheading{See also
}
2610 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
2613 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
2615 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
2617 Sets the window to have the given layout constraints. The window
2618 will then own the object, and will take care of its deletion.
2619 If an existing layout constraints object is already owned by the
2620 window, it will be deleted.
2622 \wxheading{Parameters
}
2624 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
2629 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
2630 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
2631 explicitly. When setting both a wxLayoutConstraints and a
\helpref{wxSizer
}{wxsizer
}, only the
2632 sizer will have effect.
2634 \membersection{wxWindow::SetInitialBestSize
}\label{wxwindowsetinitialbestsize
}
2636 \func{virtual void
}{SetInitialBestSize
}{\param{const wxSize\&
}{size
}}
2638 Sets the initial window size if none is given (i.e. at least one of the
2639 components of the size passed to ctor/Create() is wxDefaultCoord).
2641 \membersection{wxWindow::SetMaxSize
}\label{wxwindowsetmaxsize
}
2643 \func{void
}{SetMaxSize
}{\param{const wxSize\&
}{size
}}
2645 Sets the maximum size of the window, to indicate to the sizer layout mechanism
2646 that this is the maximum possible size.
2648 \membersection{wxWindow::SetMinSize
}\label{wxwindowsetminsize
}
2650 \func{void
}{SetMinSize
}{\param{const wxSize\&
}{size
}}
2652 Sets the minimum size of the window, to indicate to the sizer layout mechanism
2653 that this is the minimum required size. You may need to call this
2654 if you change the window size after construction and before adding
2655 to its parent sizer.
2657 \membersection{wxWindow::SetOwnBackgroundColour
}\label{wxwindowsetownbackgroundcolour
}
2659 \func{void
}{SetOwnBackgroundColour
}{\param{const wxColour\&
}{colour
}}
2661 Sets the background colour of the window but prevents it from being inherited
2662 by the children of this window.
2664 \wxheading{See also
}
2666 \helpref{SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2667 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
2670 \membersection{wxWindow::SetOwnFont
}\label{wxwindowsetownfont
}
2672 \func{void
}{SetOwnBackgroundColour
}{\param{const wxColour\&
}{colour
}}
2674 Sets the font of the window but prevents it from being inherited by the
2675 children of this window.
2677 \wxheading{See also
}
2679 \helpref{SetFont
}{wxwindowsetfont
},
\rtfsp
2680 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
2683 \membersection{wxWindow::SetOwnForegroundColour
}\label{wxwindowsetownforegroundcolour
}
2685 \func{void
}{SetOwnForegroundColour
}{\param{const wxColour\&
}{colour
}}
2687 Sets the foreground colour of the window but prevents it from being inherited
2688 by the children of this window.
2690 \wxheading{See also
}
2692 \helpref{SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
2693 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
2696 \membersection{wxWindow::SetDropTarget
}\label{wxwindowsetdroptarget
}
2698 \func{void
}{SetDropTarget
}{\param{wxDropTarget*
}{ target
}}
2700 Associates a drop target with this window.
2702 If the window already has a drop target, it is deleted.
2704 \wxheading{See also
}
2706 \helpref{wxWindow::GetDropTarget
}{wxwindowgetdroptarget
},
2707 \helpref{Drag and drop overview
}{wxdndoverview
}
2711 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
2713 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
2715 Sets the event handler for this window.
2717 \wxheading{Parameters
}
2719 \docparam{handler
}{Specifies the handler to be set.
}
2723 An event handler is an object that is capable of processing the events
2724 sent to a window. By default, the window is its own event handler, but
2725 an application may wish to substitute another, for example to allow
2726 central implementation of event-handling for a variety of different
2729 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
2730 this sets up a chain of event handlers, where an event not handled by one event handler is
2731 handed to the next one in the chain.
2733 \wxheading{See also
}
2735 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
2736 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2737 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
2738 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
2739 \helpref{wxEvtHandler
}{wxevthandler
}
2742 \membersection{wxWindow::SetExtraStyle
}\label{wxwindowsetextrastyle
}
2744 \func{void
}{SetExtraStyle
}{\param{long
}{exStyle
}}
2746 Sets the extra style bits for the window. The currently defined extra style
2750 \begin{twocollist
}\itemsep=
0pt
2751 \twocolitem{\windowstyle{wxWS
\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
2752 and Validate() methods will recursively descend into all children of the
2753 window if it has this style flag set.
}
2754 \twocolitem{\windowstyle{wxWS
\_EX\_BLOCK\_EVENTS}}{Normally, the command
2755 events are propagated upwards to the window parent recursively until a handler
2756 for them is found. Using this style allows to prevent them from being
2757 propagated beyond this window. Notice that wxDialog has this style on by
2758 default for the reasons explained in the
2759 \helpref{event processing overview
}{eventprocessing
}.
}
2760 \twocolitem{\windowstyle{wxWS
\_EX\_TRANSIENT}}{This can be used to prevent a
2761 window from being used as an implicit parent for the dialogs which were
2762 created without a parent. It is useful for the windows which can disappear at
2763 any moment as creating children of such windows results in fatal problems.
}
2764 \twocolitem{\windowstyle{wxFRAME
\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
2765 caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send
2766 a wxEVT
\_HELP event if the user clicked on an application window.
2767 This style cannot be used together with wxMAXIMIZE
\_BOX or wxMINIMIZE
\_BOX, so
2768 you should use the style of
2769 {\tt wxDEFAULT
\_FRAME\_STYLE \&
\textasciitilde(wxMINIMIZE
\_BOX | wxMAXIMIZE
\_BOX)
} for the
2770 frames having this style (the dialogs don't have minimize nor maximize box by
2772 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
2773 if the mode set by
\helpref{wxIdleEvent::SetMode
}{wxidleeventsetmode
} is wxIDLE
\_PROCESS\_SPECIFIED.
}
2774 \twocolitem{\windowstyle{wxWS
\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
2775 even if the mode set by
\helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} is wxUPDATE
\_UI\_PROCESS\_SPECIFIED.
}
2779 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
2781 \func{virtual void
}{SetFocus
}{\void}
2783 This sets the window to receive keyboard input.
2785 \wxheading{See also
}
2787 \helpref{wxFocusEvent
}{wxfocusevent
}
2788 \helpref{wxPanel::SetFocus
}{wxpanelsetfocus
}
2789 \helpref{wxPanel::SetFocusIgnoringChildren
}{wxpanelsetfocusignoringchildren
}
2792 \membersection{wxWindow::SetFocusFromKbd
}\label{wxwindowsetfocusfromkbd
}
2794 \func{virtual void
}{SetFocusFromKbd
}{\void}
2796 This function is called by wxWidgets keyboard navigation code when the user
2797 gives the focus to this window from keyboard (e.g. using
{\tt TAB
} key).
2798 By default this method simply calls
\helpref{SetFocus
}{wxwindowsetfocus
} but
2799 can be overridden to do something in addition to this in the derived classes.
2802 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
2804 \func{void
}{SetFont
}{\param{const wxFont\&
}{font
}}
2806 Sets the font for this window. This function should not be called for the
2807 parent window if you don't want its font to be inherited by its children,
2808 use
\helpref{SetOwnFont
}{wxwindowsetownfont
} instead in this case and
2809 see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for more
2812 \wxheading{Parameters
}
2814 \docparam{font
}{Font to associate with this window, pass
2815 {\tt wxNullFont
} to reset to the default font.
}
2817 \wxheading{See also
}
2819 \helpref{wxWindow::GetFont
}{wxwindowgetfont
},\\
2820 \helpref{InheritAttributes
}{wxwindowinheritattributes
}
2823 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
2825 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
2827 Sets the foreground colour of the window.
2829 Please see
\helpref{InheritAttributes
}{wxwindowinheritattributes
} for
2830 explanation of the difference between this method and
2831 \helpref{SetOwnForegroundColour
}{wxwindowsetownforegroundcolour
}.
2833 \wxheading{Parameters
}
2835 \docparam{colour
}{The colour to be used as the foreground colour, pass
2836 {\tt wxNullColour
} to reset to the default colour.
}
2840 The interpretation of foreground colour is open to interpretation according
2841 to the window class; it may be the text colour or other colour, or it may not
2844 Using this function will disable attempts to use themes for this
2845 window, if the system supports them. Use with care since usually the
2846 themes represent the appearance chosen by the user to be used for all
2847 applications on the system.
2849 \wxheading{See also
}
2851 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
2852 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
2853 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
2854 \helpref{wxWindow::ShouldInheritColours
}{wxwindowshouldinheritcolours
}
2857 \membersection{wxWindow::SetHelpText
}\label{wxwindowsethelptext
}
2859 \func{virtual void
}{SetHelpText
}{\param{const wxString\&
}{helpText
}}
2861 Sets the help text to be used as context-sensitive help for this window.
2863 Note that the text is actually stored by the current
\helpref{wxHelpProvider
}{wxhelpprovider
} implementation,
2864 and not in the window object itself.
2866 \wxheading{See also
}
2868 \helpref{GetHelpText
}{wxwindowgethelptext
},
\helpref{wxHelpProvider
}{wxhelpprovider
}
2871 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
2873 \func{void
}{SetId
}{\param{int
}{ id
}}
2875 Sets the identifier of the window.
2879 Each window has an integer identifier. If the application has not provided one,
2880 an identifier will be generated. Normally, the identifier should be provided
2881 on creation and should not be modified subsequently.
2883 \wxheading{See also
}
2885 \helpref{wxWindow::GetId
}{wxwindowgetid
},
\rtfsp
2886 \helpref{Window identifiers
}{windowids
}
2890 \membersection{wxWindow::SetLabel
}\label{wxwindowsetlabel
}
2892 \func{virtual void
}{SetLabel
}{\param{const wxString\&
}{label
}}
2894 Sets the window's label.
2896 \wxheading{Parameters
}
2898 \docparam{label
}{The window label.
}
2900 \wxheading{See also
}
2902 \helpref{wxWindow::GetLabel
}{wxwindowgetlabel
}
2905 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
2907 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
2909 Sets the window's name.
2911 \wxheading{Parameters
}
2913 \docparam{name
}{A name to set for the window.
}
2915 \wxheading{See also
}
2917 \helpref{wxWindow::GetName
}{wxwindowgetname
}
2920 \membersection{wxWindow::SetPalette
}\label{wxwindowsetpalette
}
2922 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
2924 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
2927 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
2929 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
2930 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
2931 \param{bool
}{refresh =
{\tt true
}}}
2933 Sets the scrollbar properties of a built-in scrollbar.
2935 \wxheading{Parameters
}
2937 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2939 \docparam{position
}{The position of the scrollbar in scroll units.
}
2941 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
2943 \docparam{range
}{The maximum position of the scrollbar.
}
2945 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
2949 Let's say you wish to display
50 lines of text, using the same font.
2950 The window is sized so that you can only see
16 lines at a time.
2956 SetScrollbar(wxVERTICAL,
0,
16,
50);
2960 Note that with the window at this size, the thumb position can never go
2961 above
50 minus
16, or
34.
2963 You can determine how many lines are currently visible by dividing the current view
2964 size by the character height in pixels.
2966 When defining your own scrollbar behaviour, you will always need to recalculate
2967 the scrollbar settings when the window size changes. You could therefore put your
2968 scrollbar calculations and SetScrollbar
2969 call into a function named AdjustScrollbars, which can be called initially and also
2970 from your
\helpref{wxSizeEvent
}{wxsizeevent
} handler function.
2972 \wxheading{See also
}
2974 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
2975 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2980 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
2982 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{bool
}{refresh =
{\tt true
}}}
2984 Sets the page size of one of the built-in scrollbars.
2986 \wxheading{Parameters
}
2988 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2990 \docparam{pageSize
}{Page size in scroll units.
}
2992 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
2996 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
2997 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
2998 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
2999 value has to be adjusted when the window is resized, since the page size will have changed.
3001 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
3002 the thumb changes size to reflect the page size relative to the length of the
document. When the
3003 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
3004 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
3007 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
3008 handling of pages and ranges.
3010 \wxheading{See also
}
3012 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3013 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3014 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
3015 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3019 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
3021 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{bool
}{refresh =
{\tt true
}}}
3023 Sets the position of one of the built-in scrollbars.
3025 \wxheading{Parameters
}
3027 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3029 \docparam{pos
}{Position in scroll units.
}
3031 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3035 This function does not directly affect the contents of the window: it is up to the
3036 application to take note of scrollbar attributes and redraw contents accordingly.
3038 \wxheading{See also
}
3040 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
3041 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3042 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
3043 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3048 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
3050 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{bool
}{refresh =
{\tt true
}}}
3052 Sets the range of one of the built-in scrollbars.
3054 \wxheading{Parameters
}
3056 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
3058 \docparam{range
}{Scroll range.
}
3060 \docparam{refresh
}{{\tt true
} to redraw the scrollbar,
{\tt false
} otherwise.
}
3064 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
3065 object length of the scrollbar. If you are implementing a scrolling window, for example, you
3066 would adjust the scroll range when the window is resized, by subtracting the window view size from the
3067 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
3068 and usually the scrollbar will be automatically hidden.
3070 \wxheading{See also
}
3072 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3073 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
3074 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
3075 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
3076 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
3080 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
3082 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
3083 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
3085 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
3087 Sets the size and position of the window in pixels.
3089 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3091 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
3093 Sets the size of the window in pixels.
3095 \wxheading{Parameters
}
3097 \docparam{x
}{Required x position in pixels, or -
1 to indicate that the existing
3098 value should be used.
}
3100 \docparam{y
}{Required y position in pixels, or -
1 to indicate that the existing
3101 value should be used.
}
3103 \docparam{width
}{Required width in pixels, or -
1 to indicate that the existing
3104 value should be used.
}
3106 \docparam{height
}{Required height position in pixels, or -
1 to indicate that the existing
3107 value should be used.
}
3109 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
3111 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
3113 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
3115 {\bf wxSIZE
\_AUTO\_WIDTH}: a -
1 width value is taken to indicate
3116 a wxWidgets-supplied default width.\\
3117 {\bf wxSIZE
\_AUTO\_HEIGHT}: a -
1 height value is taken to indicate
3118 a wxWidgets-supplied default width.\\
3119 {\bf wxSIZE
\_AUTO}: -
1 size values are taken to indicate
3120 a wxWidgets-supplied default size.\\
3121 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
3122 if -
1 values are supplied.\\
3123 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow dimensions of -
1 and less to be interpreted
3124 as real dimensions, not default values.
3129 The second form is a convenience for calling the first form with default
3130 x and y parameters, and must be used with non-default width and height values.
3132 The first form sets the position and optionally size, of the window.
3133 Parameters may be -
1 to indicate either that a default should be supplied
3134 by wxWidgets, or that the current value of the dimension should be used.
3136 \wxheading{See also
}
3138 \helpref{wxWindow::Move
}{wxwindowmove
}
3140 \pythonnote{In place of a single overloaded method name, wxPython
3141 implements the following methods:
\par
3142 \indented{2cm
}{\begin{twocollist
}
3143 \twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE
\_AUTO)
}}{}
3144 \twocolitem{{\bf SetSize(size)
}}{}
3145 \twocolitem{{\bf SetPosition(point)
}}{}
3150 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
3152 \func{virtual void
}{SetSizeHints
}{\param{int
}{ minW=-
1},
\param{int
}{ minH=-
1},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1},
3153 \param{int
}{ incW=-
1},
\param{int
}{ incH=-
1}}
3155 \func{void
}{SetSizeHints
}{\param{const wxSize\&
}{ minSize
},
3156 \param{const wxSize\&
}{ maxSize=wxDefaultSize
},
\param{const wxSize\&
}{ incSize=wxDefaultSize
}}
3159 Allows specification of minimum and maximum window sizes, and window size increments.
3160 If a pair of values is not set (or set to -
1), the default values will be used.
3162 \wxheading{Parameters
}
3164 \docparam{minW
}{Specifies the minimum width allowable.
}
3166 \docparam{minH
}{Specifies the minimum height allowable.
}
3168 \docparam{maxW
}{Specifies the maximum width allowable.
}
3170 \docparam{maxH
}{Specifies the maximum height allowable.
}
3172 \docparam{incW
}{Specifies the increment for sizing the width (Motif/Xt only).
}
3174 \docparam{incH
}{Specifies the increment for sizing the height (Motif/Xt only).
}
3176 \docparam{minSize
}{Minimum size.
}
3178 \docparam{maxSize
}{Maximum size.
}
3180 \docparam{incSize
}{Increment size (Motif/Xt only).
}
3184 If this function is called, the user will not be able to size the window outside the
3187 The resizing increments are only significant under Motif or Xt.
3190 \membersection{wxWindow::SetSizer
}\label{wxwindowsetsizer
}
3192 \func{void
}{SetSizer
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3194 Sets the window to have the given layout sizer. The window
3195 will then own the object, and will take care of its deletion.
3196 If an existing layout constraints object is already owned by the
3197 window, it will be deleted if the deleteOld parameter is true.
3199 Note that this function will also call
3200 \helpref{SetAutoLayout
}{wxwindowsetautolayout
} implicitly with
{\tt true
}
3201 parameter if the
{\it sizer
}\/ is non-NULL and
{\tt false
} otherwise.
3203 \wxheading{Parameters
}
3205 \docparam{sizer
}{The sizer to set. Pass NULL to disassociate and conditionally delete
3206 the window's sizer. See below.
}
3208 \docparam{deleteOld
}{If true (the default), this will delete any prexisting sizer.
3209 Pass false if you wish to handle deleting the old sizer yourself.
}
3213 SetSizer now enables and disables Layout automatically, but prior to wxWidgets
2.3.3
3214 the following applied:
3216 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
3217 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
3218 explicitly. When setting both a wxSizer and a
\helpref{wxLayoutConstraints
}{wxlayoutconstraints
},
3219 only the sizer will have effect.
3222 \membersection{wxWindow::SetSizerAndFit
}\label{wxwindowsetsizerandfit
}
3224 \func{void
}{SetSizerAndFit
}{\param{wxSizer*
}{sizer
},
\param{bool
}{deleteOld=true
}}
3226 The same as
\helpref{SetSizer
}{wxwindowsetsizer
}, except it also sets the size hints
3227 for the window based on the sizer's minimum size.
3230 \membersection{wxWindow::SetTitle
}\label{wxwindowsettitle
}
3232 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{title
}}
3234 Sets the window's title. Applicable only to frames and dialogs.
3236 \wxheading{Parameters
}
3238 \docparam{title
}{The window's title.
}
3240 \wxheading{See also
}
3242 \helpref{wxWindow::GetTitle
}{wxwindowgettitle
}
3245 \membersection{wxWindow::SetThemeEnabled
}\label{wxwindowsetthemeenabled
}
3247 \func{virtual void
}{SetThemeEnabled
}{\param{bool
}{enable
}}
3249 This function tells a window if it should use the system's "theme" code
3250 to draw the windows' background instead if its own background drawing
3251 code. This does not always have any effect since the underlying platform
3252 obviously needs to support the notion of themes in user defined windows.
3253 One such platform is GTK+ where windows can have (very colourful) backgrounds
3254 defined by a user's selected theme.
3256 Dialogs, notebook pages and the status bar have this flag set to true
3257 by default so that the default look and feel is simulated best.
3260 \membersection{wxWindow::SetToolTip
}\label{wxwindowsettooltip
}
3262 \func{void
}{SetToolTip
}{\param{const wxString\&
}{tip
}}
3264 \func{void
}{SetToolTip
}{\param{wxToolTip*
}{tip
}}
3266 Attach a tooltip to the window.
3268 See also:
\helpref{GetToolTip
}{wxwindowgettooltip
},
3269 \helpref{wxToolTip
}{wxtooltip
}
3272 \membersection{wxWindow::SetValidator
}\label{wxwindowsetvalidator
}
3274 \func{virtual void
}{SetValidator
}{\param{const wxValidator\&
}{ validator
}}
3276 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
3277 create a new validator of this type.
3280 \membersection{wxWindow::SetVirtualSize
}\label{wxwindowsetvirtualsize
}
3282 \func{void
}{SetVirtualSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
3284 \func{void
}{SetVirtualSize
}{\param{const wxSize\&
}{ size
}}
3286 Sets the virtual size of the window in pixels.
3289 \membersection{wxWindow::SetVirtualSizeHints
}\label{wxwindowsetvirtualsizehints
}
3291 \func{virtual void
}{SetVirtualSizeHints
}{\param{int
}{ minW
},
\param{int
}{ minH
},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1}}
3293 \func{void
}{SetVirtualSizeHints
}{\param{const wxSize\&
}{ minSize=wxDefaultSize
},
3294 \param{const wxSize\&
}{ maxSize=wxDefaultSize
}}
3297 Allows specification of minimum and maximum virtual window sizes.
3298 If a pair of values is not set (or set to -
1), the default values
3301 \wxheading{Parameters
}
3303 \docparam{minW
}{Specifies the minimum width allowable.
}
3305 \docparam{minH
}{Specifies the minimum height allowable.
}
3307 \docparam{maxW
}{Specifies the maximum width allowable.
}
3309 \docparam{maxH
}{Specifies the maximum height allowable.
}
3311 \docparam{minSize
}{Minimum size.
}
3313 \docparam{maxSize
}{Maximum size.
}
3317 If this function is called, the user will not be able to size the virtual area
3318 of the window outside the given bounds.
3321 \membersection{wxWindow::SetWindowStyle
}\label{wxwindowsetwindowstyle
}
3323 \func{void
}{SetWindowStyle
}{\param{long
}{ style
}}
3325 Identical to
\helpref{SetWindowStyleFlag
}{wxwindowsetwindowstyleflag
}.
3328 \membersection{wxWindow::SetWindowStyleFlag
}\label{wxwindowsetwindowstyleflag
}
3330 \func{virtual void
}{SetWindowStyleFlag
}{\param{long
}{ style
}}
3332 Sets the style of the window. Please note that some styles cannot be changed
3333 after the window creation and that
\helpref{Refresh()
}{wxwindowrefresh
} might
3334 be called after changing the others for the change to take place immediately.
3336 See
\helpref{Window styles
}{windowstyles
} for more information about flags.
3338 \wxheading{See also
}
3340 \helpref{GetWindowStyleFlag
}{wxwindowgetwindowstyleflag
}
3343 \membersection{wxWindow::SetWindowVariant
}\label{wxwindowsetwindowvariant
}
3345 \func{void
}{SetWindowVariant
}{\param{wxWindowVariant
}{variant
}}
3347 This function can be called under all platforms but only does anything under
3348 Mac OS X
10.3+ currently. Under this system, each of the standard control can
3349 exist in several sizes which correspond to the elements of wxWindowVariant
3352 enum wxWindowVariant
3354 wxWINDOW_VARIANT_NORMAL, // Normal size
3355 wxWINDOW_VARIANT_SMALL, // Smaller size (about
25 % smaller than normal )
3356 wxWINDOW_VARIANT_MINI, // Mini size (about
33 % smaller than normal )
3357 wxWINDOW_VARIANT_LARGE, // Large size (about
25 % larger than normal )
3361 By default the controls use the normal size, of course, but this function can
3362 be used to change this.
3365 \membersection{wxWindow::ShouldInheritColours
}\label{wxwindowshouldinheritcolours
}
3367 \func{virtual bool
}{ShouldInheritColours
}{\void}
3369 Return
\true from here to allow the colours of this window to be changed by
3370 \helpref{InheritAttributes
}{wxwindowinheritattributes
}, returning
\false
3371 forbids inheriting them from the parent window.
3373 The base class version returns
\false, but this method is overridden in
3374 \helpref{wxControl
}{wxcontrol
} where it returns
\true.
3377 \membersection{wxWindow::Show
}\label{wxwindowshow
}
3379 \func{virtual bool
}{Show
}{\param{bool
}{ show =
{\tt true
}}}
3381 Shows or hides the window. You may need to call
\helpref{Raise
}{wxwindowraise
}
3382 for a top level window if you want to bring it to top, although this is not
3383 needed if Show() is called immediately after the frame creation.
3385 \wxheading{Parameters
}
3387 \docparam{show
}{If
{\tt true
} displays the window. Otherwise, hides it.
}
3389 \wxheading{Return value
}
3391 {\tt true
} if the window has been shown or hidden or
{\tt false
} if nothing was
3392 done because it already was in the requested state.
3394 \wxheading{See also
}
3396 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
3400 \membersection{wxWindow::Thaw
}\label{wxwindowthaw
}
3402 \func{virtual void
}{Thaw
}{\void}
3404 Reenables window updating after a previous call to
3405 \helpref{Freeze
}{wxwindowfreeze
}. To really thaw the control, it must be called
3406 exactly the same number of times as
\helpref{Freeze
}{wxwindowfreeze
}.
3409 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
3411 \func{virtual bool
}{TransferDataFromWindow
}{\void}
3413 Transfers values from child controls to data areas specified by their validators. Returns
3414 {\tt false
} if a transfer failed.
3416 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3417 the method will also call TransferDataFromWindow() of all child windows.
3419 \wxheading{See also
}
3421 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3422 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3425 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
3427 \func{virtual bool
}{TransferDataToWindow
}{\void}
3429 Transfers values to child controls from data areas specified by their validators.
3431 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3432 the method will also call TransferDataToWindow() of all child windows.
3434 \wxheading{Return value
}
3436 Returns
{\tt false
} if a transfer failed.
3438 \wxheading{See also
}
3440 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3441 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
3444 \membersection{wxWindow::UnregisterHotKey
}\label{wxwindowunregisterhotkey
}
3446 \func{bool
}{UnregisterHotKey
}{\param{int
}{ hotkeyId
}}
3448 Unregisters a system wide hotkey.
3450 \wxheading{Parameters
}
3452 \docparam{hotkeyId
}{Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey.
}
3454 \wxheading{Return value
}
3456 {\tt true
} if the hotkey was unregistered successfully,
{\tt false
} if the id was invalid.
3460 This function is currently only implemented under MSW.
3462 \wxheading{See also
}
3464 \helpref{wxWindow::RegisterHotKey
}{wxwindowregisterhotkey
}
3467 \membersection{wxWindow::Update
}\label{wxwindowupdate
}
3469 \func{virtual void
}{Update
}{\void}
3471 Calling this method immediately repaints the invalidated area of the window
3472 while this would usually only happen when the flow of control returns to the
3473 event loop. Notice that this function doesn't refresh the window and does
3474 nothing if the window hadn't been already repainted. Use
3475 \helpref{Refresh
}{wxwindowrefresh
} first if you want to immediately redraw the
3476 window unconditionally.
3479 \membersection{wxWindow::UpdateWindowUI
}\label{wxwindowupdatewindowui
}
3481 \func{virtual void
}{UpdateWindowUI
}{\param{long
}{ flags = wxUPDATE
\_UI\_NONE}}
3483 This function sends
\helpref{wxUpdateUIEvents
}{wxupdateuievent
} to
3484 the window. The particular implementation depends on the window; for
3485 example a wxToolBar will send an update UI event for each toolbar button,
3486 and a wxFrame will send an update UI event for each menubar menu item.
3487 You can call this function from your application to ensure that your
3488 UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers
3489 are concerned). This may be necessary if you have called
3490 \helpref{wxUpdateUIEvent::SetMode
}{wxupdateuieventsetmode
} or
3491 \helpref{wxUpdateUIEvent::SetUpdateInterval
}{wxupdateuieventsetupdateinterval
} to
3492 limit the overhead that wxWidgets incurs by sending update UI events in idle time.
3494 {\it flags
} should be a bitlist of one or more of the following values.
3499 wxUPDATE_UI_NONE =
0x0000, // No particular value
3500 wxUPDATE_UI_RECURSE =
0x0001, // Call the function for descendants
3501 wxUPDATE_UI_FROMIDLE =
0x0002 // Invoked from On(Internal)Idle
3505 If you are calling this function from an OnInternalIdle or OnIdle
3506 function, make sure you pass the wxUPDATE
\_UI\_FROMIDLE flag, since
3507 this tells the window to only update the UI elements that need
3508 to be updated in idle time. Some windows update their elements
3509 only when necessary, for example when a menu is about to be shown.
3510 The following is an example of how to call UpdateWindowUI from
3514 void MyWindow::OnInternalIdle()
3516 if (wxUpdateUIEvent::CanUpdate(this))
3517 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
3521 \wxheading{See also
}
3523 \helpref{wxUpdateUIEvent
}{wxupdateuievent
},
3524 \helpref{wxWindow::DoUpdateWindowUI
}{wxwindowdoupdatewindowui
},
3525 \helpref{wxWindow::OnInternalIdle
}{wxwindowoninternalidle
}
3528 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
3530 \func{virtual bool
}{Validate
}{\void}
3532 Validates the current values of the child controls using their validators.
3534 If the window has
{\tt wxWS
\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
3535 the method will also call Validate() of all child windows.
3537 \wxheading{Return value
}
3539 Returns
{\tt false
} if any of the validations failed.
3541 \wxheading{See also
}
3543 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
3544 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
3545 \helpref{wxValidator
}{wxvalidator
}
3548 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
3550 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
3552 Moves the pointer to the given position on the window.
3554 {\bf NB:
} This function is not supported under Mac because Apple Human
3555 Interface Guidelines forbid moving the mouse cursor programmatically.
3557 \wxheading{Parameters
}
3559 \docparam{x
}{The new x position for the cursor.
}
3561 \docparam{y
}{The new y position for the cursor.
}