]>
git.saurik.com Git - wxWidgets.git/blob - interface/window.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxWindow
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 wxWindow is the base class for all windows and represents any visible object on
14 screen. All controls, top level windows and so on are windows. Sizers and
15 device contexts are not, however, as they don't appear on screen themselves.
17 Please note that all children of the window will be deleted automatically by
18 the destructor before the window itself is deleted which means that you don't
19 have to worry about deleting them manually. Please see the @ref
20 overview_windowdeletionoverview "window
21 deletion overview" for more information.
23 Also note that in this, and many others, wxWidgets classes some
24 @c GetXXX() methods may be overloaded (as, for example,
26 wxWindow::GetClientSize). In this case, the overloads
27 are non-virtual because having multiple virtual functions with the same name
28 results in a virtual function name hiding at the derived class level (in
29 English, this means that the derived class has to override all overloaded
30 variants if it overrides any of them). To allow overriding them in the derived
31 class, wxWidgets uses a unique protected virtual @c DoGetXXX() method
32 and all @c GetXXX() ones are forwarded to it, so overriding the former
33 changes the behaviour of the latter.
36 @style{wxBORDER_DEFAULT}
37 The window class will decide the kind of border to show, if any.
38 @style{wxBORDER_SIMPLE}
39 Displays a thin border around the window. wxSIMPLE_BORDER is the
40 old name for this style.
41 @style{wxBORDER_SUNKEN}
42 Displays a sunken border. wxSUNKEN_BORDER is the old name for this
44 @style{wxBORDER_RAISED}
45 Displays a raised border. wxRAISED_BORDER is the old name for this
47 @style{wxBORDER_STATIC}
48 Displays a border suitable for a static control. wxSTATIC_BORDER
49 is the old name for this style. Windows only.
50 @style{wxBORDER_THEME}
51 Displays a native border suitable for a control, on the current
52 platform. On Windows XP or Vista, this will be a themed border; on
53 most other platforms a sunken border will be used. For more
54 information for themed borders on Windows, please see Themed
57 Displays no border, overriding the default border style for the
58 window. wxNO_BORDER is the old name for this style.
59 @style{wxBORDER_DOUBLE}
60 This style is obsolete and should not be used.
61 @style{wxTRANSPARENT_WINDOW}
62 The window is transparent, that is, it will not receive paint
64 @style{wxTAB_TRAVERSAL}
65 Use this to enable tab traversal for non-dialog windows.
67 Use this to indicate that the window wants to get all char/key
68 events for all keys - even for keys like TAB or ENTER which are
69 usually used for dialog navigation and which wouldn't be generated
70 without this style. If you need to use this style in order to get
71 the arrows or etc., but would still like to have normal keyboard
72 navigation take place, you should call Navigate in response to the
73 key events for Tab and Shift-Tab.
74 @style{wxNO_FULL_REPAINT_ON_RESIZE}
75 On Windows, this style used to disable repainting the window
76 completely when its size is changed. Since this behaviour is now
77 the default, the style is now obsolete and no longer has an effect.
79 Use this style to enable a vertical scrollbar. Notice that this
80 style cannot be used with native controls which don't support
81 scrollbars nor with top-level windows in most ports.
83 Use this style to enable a horizontal scrollbar. The same
84 limitations as for wxVSCROLL apply to this style.
85 @style{wxALWAYS_SHOW_SB}
86 If a window has scrollbars, disable them instead of hiding them
87 when they are not needed (i.e. when the size of the window is big
88 enough to not require the scrollbars to navigate it). This style is
89 currently implemented for wxMSW, wxGTK and wxUniversal and does
90 nothing on the other platforms.
91 @style{wxCLIP_CHILDREN}
92 Use this style to eliminate flicker caused by the background being
93 repainted, then children being painted over them. Windows only.
94 @style{wxFULL_REPAINT_ON_RESIZE}
95 Use this style to force a complete redraw of the window whenever it
96 is resized instead of redrawing just the part of the window
97 affected by resizing. Note that this was the behaviour by default
98 before 2.5.1 release and that if you experience redraw problems
99 with code which previously used to work you may want to try this.
100 Currently this style applies on GTK+ 2 and Windows only, and full
101 repainting is always done on other platforms.
104 @beginExtraStyleTable
105 @style{wxWS_EX_VALIDATE_RECURSIVELY}
106 By default, Validate/TransferDataTo/FromWindow() only work on
107 direct children of the window (compatible behaviour). Set this flag
108 to make them recursively descend into all subwindows.
109 @style{wxWS_EX_BLOCK_EVENTS}
110 wxCommandEvents and the objects of the derived classes are
111 forwarded to the parent window and so on recursively by default.
112 Using this flag for the given window allows to block this
113 propagation at this window, i.e. prevent the events from being
114 propagated further upwards. Dialogs have this flag on by default.
115 @style{wxWS_EX_TRANSIENT}
116 Don't use this window as an implicit parent for the other windows:
117 this must be used with transient windows as otherwise there is the
118 risk of creating a dialog/frame with this window as a parent which
119 would lead to a crash if the parent is destroyed before the child.
120 @style{wxWS_EX_PROCESS_IDLE}
121 This window should always process idle events, even if the mode set
122 by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.
123 @style{wxWS_EX_PROCESS_UI_UPDATES}
124 This window should always process UI update events, even if the
125 mode set by wxUpdateUIEvent::SetMode is
126 wxUPDATE_UI_PROCESS_SPECIFIED.
132 @see @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview
133 "Window sizing overview"
135 class wxWindow
: public wxEvtHandler
140 Constructs a window, which can be a child of a frame, dialog or any other
144 Pointer to a parent window.
146 Window identifier. If wxID_ANY, will automatically create an identifier.
148 Window position. wxDefaultPosition indicates that wxWidgets
149 should generate a default position for the window. If using the wxWindow
150 class directly, supply
153 Window size. wxDefaultSize indicates that wxWidgets
154 should generate a default size for the window. If no suitable size can be
156 window will be sized to 20x20 pixels so that the window is visible but
160 Window style. For generic window styles, please see wxWindow.
165 wxWindow(wxWindow
* parent
, wxWindowID id
,
166 const wxPoint
& pos
= wxDefaultPosition
,
167 const wxSize
& size
= wxDefaultSize
,
169 const wxString
& name
= wxPanelNameStr
);
173 Destructor. Deletes all sub-windows, then deletes itself. Instead of using
174 the @b delete operator explicitly, you should normally
175 use Destroy() so that wxWidgets
176 can delete a window only when it is safe to do so, in idle time.
178 @see @ref overview_windowdeletionoverview "Window deletion overview",
179 Destroy(), wxCloseEvent
184 This method may be overridden in the derived classes to return @false to
185 indicate that this control doesn't accept input at all (i.e. behaves like e.g.
186 wxStaticText) and so doesn't need focus.
188 @see AcceptsFocusFromKeyboard()
190 bool AcceptsFocus() const;
193 This method may be overridden in the derived classes to return @false to
194 indicate that while this control can, in principle, have focus if the user
195 clicks it with the mouse, it shouldn't be included in the TAB traversal chain
196 when using the keyboard.
198 bool AcceptsFocusFromKeyboard() const;
201 Adds a child window. This is called automatically by window creation
202 functions so should not be required by the application programmer.
203 Notice that this function is mostly internal to wxWidgets and shouldn't be
204 called by the user code.
209 virtual void AddChild(wxWindow
* child
);
212 Call this function to force one or both scrollbars to be always shown, even if
213 the window is big enough to show its entire contents without scrolling.
218 Whether the horizontal scroll bar should always be visible.
220 Whether the vertical scroll bar should always be visible.
222 @remarks This function is currently only implemented under Mac/Carbon.
224 void AlwaysShowScrollbars(bool hflag
, bool vflag
);
227 Sets the cached best size value.
229 void CacheBestSize(const wxSize
& size
) const;
232 Returns @true if the system supports transparent windows and calling
233 SetTransparent() may succeed. If this function
234 returns @false, transparent windows are definitely not supported by the
238 bool CanSetTransparent();
241 Directs all mouse input to this window. Call ReleaseMouse() to
243 Note that wxWidgets maintains the stack of windows having captured the mouse
244 and when the mouse is released the capture returns to the window which had had
245 captured it previously and it is only really released if there were no previous
246 window. In particular, this means that you must release the mouse as many times
247 as you capture it, unless the window receives
248 the wxMouseCaptureLostEvent event.
249 Any application which captures the mouse in the beginning of some operation
250 must handle wxMouseCaptureLostEvent
251 and cancel this operation when it receives the event. The event handler must
254 @see ReleaseMouse(), wxMouseCaptureLostEvent
256 virtual void CaptureMouse();
259 A synonym for Centre().
261 void Center(int direction
);
264 A synonym for CentreOnParent().
266 void CenterOnParent(int direction
);
272 Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
273 or wxBOTH. It may also include wxCENTRE_ON_SCREEN flag
274 if you want to center the window on the entire screen and not on its
277 @remarks If the window is a top level one (i.e. doesn't have a parent),
278 it will be centered relative to the screen anyhow.
282 void Centre(int direction
= wxBOTH
);
285 Centres the window on its parent. This is a more readable synonym for
289 Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
292 @remarks This methods provides for a way to center top level windows over
293 their parents instead of the entire screen. If there
294 is no parent or if the window is not a top level
295 window, then behaviour is the same as Centre().
297 @see wxTopLevelWindow::CentreOnScreen
299 void CentreOnParent(int direction
= wxBOTH
);
302 Clears the window by filling it with the current background colour. Does not
303 cause an erase background event to be generated.
305 void ClearBackground();
309 Converts to screen coordinates from coordinates relative to this window.
312 A pointer to a integer value for the x coordinate. Pass the client
314 a screen coordinate will be passed out.
316 A pointer to a integer value for the y coordinate. Pass the client
318 a screen coordinate will be passed out.
320 The client position for the second form of the function.
322 virtual void ClientToScreen(int* x
, int* y
) const;
323 const virtual wxPoint
ClientToScreen(const wxPoint
& pt
) const;
327 Converts client area size @a size to corresponding window size. In
328 other words, the returned value is what would GetSize() return if this
329 window had client area of given size. Components with wxDefaultCoord
330 value are left unchanged. Note that the conversion is not always
331 exact, it assumes that non-client area doesn't change and so doesn't
332 take into account things like menu bar (un)wrapping or (dis)appearance
337 @see WindowToClientSize()
339 virtual wxSize
ClientToWindowSize(const wxSize
& size
);
342 Converts window size @a size to corresponding client area size. In
343 other words, the returned value is what would GetClientSize() return if
344 this window had given window size. Components with wxDefaultCoord value
347 Note that the conversion is not always exact, it assumes that
348 non-client area doesn't change and so doesn't take into account things
349 like menu bar (un)wrapping or (dis)appearance of the scrollbars.
353 @see ClientToWindowSize()
355 virtual wxSize
WindowToClientSize(const wxSize
& size
);
358 This function simply generates a wxCloseEvent whose
359 handler usually tries to close the window. It doesn't close the window
363 @false if the window's close handler should be able to veto the destruction
364 of this window, @true if it cannot.
366 @remarks Close calls the close handler for the window, providing an
367 opportunity for the window to choose whether to destroy
368 the window. Usually it is only used with the top level
369 windows (wxFrame and wxDialog classes) as the others
370 are not supposed to have any special OnClose() logic.
372 @see @ref overview_windowdeletionoverview "Window deletion overview",
373 Destroy(), wxCloseEvent
375 bool Close(bool force
= false);
379 Converts a point or size from dialog units to pixels.
380 For the x dimension, the dialog units are multiplied by the average character
382 and then divided by 4.
383 For the y dimension, the dialog units are multiplied by the average character
385 and then divided by 8.
387 @remarks Dialog units are used for maintaining a dialog's proportions
388 even if the font changes.
390 @see ConvertPixelsToDialog()
392 wxPoint
ConvertDialogToPixels(const wxPoint
& pt
);
393 wxSize
ConvertDialogToPixels(const wxSize
& sz
);
398 Converts a point or size from pixels to dialog units.
399 For the x dimension, the pixels are multiplied by 4 and then divided by the
402 For the y dimension, the pixels are multiplied by 8 and then divided by the
406 @remarks Dialog units are used for maintaining a dialog's proportions
407 even if the font changes.
409 @see ConvertDialogToPixels()
411 wxPoint
ConvertPixelsToDialog(const wxPoint
& pt
);
412 wxSize
ConvertPixelsToDialog(const wxSize
& sz
);
416 Destroys the window safely. Use this function instead of the delete operator,
418 different window classes can be destroyed differently. Frames and dialogs
419 are not destroyed immediately when this function is called -- they are added
420 to a list of windows to be deleted on idle time, when all the window's events
421 have been processed. This prevents problems with events being sent to
425 @returns @true if the window has either been successfully deleted, or it
426 has been added to the list of windows pending real
429 virtual bool Destroy();
432 Destroys all children of a window. Called automatically by the destructor.
434 virtual void DestroyChildren();
437 Disables the window, same as @ref enable() Enable(@false).
439 @returns Returns @true if the window has been disabled, @false if it had
440 been already disabled before the call to this function.
445 Gets the size which best suits the window: for a control, it would be
446 the minimal size which doesn't truncate the control, for a panel - the
447 same size as it would have after a call to Fit().
449 The default implementation of this function is designed for use in container
450 windows, such as wxPanel, and works something like this:
451 -# If the window has a sizer then it is used to calculate the best size.
452 -# Otherwise if the window has layout constraints then those are used to
453 calculate the best size.
454 -# Otherwise if the window has children then the best size is set to be large
455 enough to show all the children.
456 -# Otherwise if there are no children then the window's minimal size will be
457 used as its best size.
458 -# Otherwise if there is no minimal size set, then the current size is used
461 @see @ref overview_windowsizing
463 virtual wxSize
DoGetBestSize() const;
466 Does the window-specific updating after processing the update event.
467 This function is called by UpdateWindowUI()
468 in order to check return values in the wxUpdateUIEvent and
469 act appropriately. For example, to allow frame and dialog title updating,
471 implements this function as follows:
473 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
476 Enables or disables eligibility for drop file events (OnDropFiles).
479 If @true, the window is eligible for drop file events. If @false, the window
480 will not accept drop file events.
482 @remarks Windows only.
484 virtual void DragAcceptFiles(bool accept
);
487 Enable or disable the window for user input. Note that when a parent window is
488 disabled, all of its children are disabled as well and they are reenabled again
492 If @true, enables the window for input. If @false, disables the window.
494 @returns Returns @true if the window has been enabled or disabled, @false
495 if nothing was done, i.e. if the window had already
496 been in the specified state.
498 @see IsEnabled(), Disable(), wxRadioBox::Enable
500 virtual bool Enable(bool enable
= true);
503 Finds the window or control which currently has the keyboard focus.
505 @remarks Note that this is a static function, so it can be called without
506 needing a wxWindow pointer.
508 @see SetFocus(), HasFocus()
510 static wxWindow
* FindFocus();
514 Find a child of this window, by name.
516 wxWindow
* FindWindow(long id
) const;
517 const wxWindow
* FindWindow(const wxString
& name
) const;
521 Find the first window with the given @e id.
522 If @a parent is @NULL, the search will start from all top-level
523 frames and dialog boxes; if non-@NULL, the search will be limited to the given
525 The search is recursive in both cases.
529 static wxWindow
* FindWindowById(long id
, wxWindow
* parent
= NULL
);
532 Find a window by its label. Depending on the type of window, the label may be a
534 or panel item label. If @a parent is @NULL, the search will start from all
536 frames and dialog boxes; if non-@NULL, the search will be limited to the given
538 The search is recursive in both cases.
542 static wxWindow
* FindWindowByLabel(const wxString
& label
,
543 wxWindow
* parent
= NULL
);
546 Find a window by its name (as given in a window constructor or @b Create
548 If @a parent is @NULL, the search will start from all top-level
549 frames and dialog boxes; if non-@NULL, the search will be limited to the given
551 The search is recursive in both cases.
552 If no window with such name is found,
553 FindWindowByLabel() is called.
557 static wxWindow
* FindWindowByName(const wxString
& name
,
558 wxWindow
* parent
= NULL
);
561 Sizes the window so that it fits around its subwindows.
563 This function won't do anything if there are no subwindows and will only really
564 work correctly if sizers are used for the subwindows layout.
566 Also, if the window has exactly one subwindow it is better (faster and the result
567 is more precise as Fit() adds some margin to account for fuzziness of its calculations)
571 window->SetClientSize(child->GetSize());
574 instead of calling Fit().
576 @see @ref overview_windowsizing
581 Similar to Fit(), but sizes the interior (virtual) size
582 of a window. Mainly useful with scrolled windows to reset scrollbars after
583 sizing changes that do not trigger a size event, and/or scrolled windows without
584 an interior sizer. This function similarly won't do anything if there are no
587 virtual void FitInside();
590 Freezes the window or, in other words, prevents any updates from taking
591 place on screen, the window is not redrawn at all.
593 Thaw() must be called to reenable window redrawing. Calls to these two
594 functions may be nested but to ensure that the window is properly
595 repainted again, you must thaw it exactly as many times as you froze
598 If the window has any children, they are recursively frozen too.
600 This method is useful for visual appearance optimization (for example,
601 it is a good idea to use it before doing many large text insertions in
602 a row into a wxTextCtrl under wxGTK) but is not implemented on all
603 platforms nor for all controls so it is mostly just a hint to wxWidgets
604 and not a mandatory directive.
606 @see wxWindowUpdateLocker, Thaw(), IsFrozen()
608 virtual void Freeze();
611 Gets the accelerator table for this window. See wxAcceleratorTable.
613 wxAcceleratorTable
* GetAcceleratorTable() const;
616 Returns the accessible object for this window, if any.
617 See also wxAccessible.
619 wxAccessible
* GetAccessible();
622 This method is deprecated, use GetEffectiveMinSize() instead.
624 wxSize
GetAdjustedBestSize() const;
627 Returns the background colour of the window.
629 @see SetBackgroundColour(), SetForegroundColour(),
630 GetForegroundColour()
632 virtual wxColour
GetBackgroundColour() const;
635 Returns the background style of the window. The background style can be one of:
639 Use the default background, as determined by
640 the system or the current theme.
644 Use a solid colour for the background, this
645 style is set automatically if you call
646 SetBackgroundColour() so you only need to
647 set it explicitly if you had changed the background style to something else
652 Don't draw the background at all, it's
653 supposed that it is drawn by the user-defined erase background event handler.
654 This style should be used to avoid flicker when the background is entirely
657 wxBG_STYLE_TRANSPARET
659 The background is (partially) transparent,
660 this style is automatically set if you call
661 SetTransparent() which is used to set the
664 @see SetBackgroundColour(), GetForegroundColour(),
665 SetBackgroundStyle(), SetTransparent()
667 virtual wxBackgroundStyle
GetBackgroundStyle() const;
670 This functions returns the best acceptable minimal size for the window. For
671 example, for a static control, it will be the minimal size such that the
672 control label is not truncated. For windows containing subwindows (typically
673 wxPanel), the size returned by this function will be the
674 same as the size the window would have had after calling
677 wxSize
GetBestSize() const;
680 Returns the currently captured window.
682 @see HasCapture(), CaptureMouse(), ReleaseMouse(),
683 wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
685 static wxWindow
* GetCapture();
688 Returns the caret() associated with the window.
690 wxCaret
* GetCaret() const;
693 Returns the character height for this window.
695 virtual int GetCharHeight() const;
698 Returns the average character width for this window.
700 virtual int GetCharWidth() const;
704 Returns a reference to the list of the window's children. @c wxWindowList
705 is a type-safe wxList-like class whose elements are of type
708 wxWindowList
GetChildren() const;
709 const wxWindowList
GetChildren() const;
713 Returns the default font and colours which are used by the control. This is
714 useful if you want to use the same font or colour in your own control as in a
715 standard control -- which is a much better idea than hard coding specific
716 colours or fonts which might look completely out of place on the users
717 system, especially if it uses themes.
718 The @a variant parameter is only relevant under Mac currently and is
719 ignore under other platforms. Under Mac, it will change the size of the
720 returned font. See SetWindowVariant()
722 This static method is "overridden" in many derived classes and so calling,
723 for example, wxButton::GetClassDefaultAttributes() will typically
724 return the values appropriate for a button which will be normally different
725 from those returned by, say, wxListCtrl::GetClassDefaultAttributes().
726 The @c wxVisualAttributes structure has at least the fields
727 @c font, @c colFg and @c colBg. All of them may be invalid
728 if it was not possible to determine the default control appearance or,
729 especially for the background colour, if the field doesn't make sense as is
730 the case for @c colBg for the controls with themed background.
732 @see InheritAttributes()
734 static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
738 Returns the size of the window 'client area' in pixels. The client area is the
739 area which may be drawn on by the programmer, excluding title bar, border,
741 Note that if this window is a top-level one and it is currently minimized, the
742 return size is empty (both width and height are 0).
745 Receives the client width in pixels.
747 Receives the client height in pixels.
749 @see GetSize(), GetVirtualSize()
751 void GetClientSize(int* width
, int* height
) const;
752 const wxSize
GetClientSize() const;
756 Returns a pointer to the window's layout constraints, or @NULL if there are none.
758 wxLayoutConstraints
* GetConstraints() const;
761 Return the sizer that this window is a member of, if any, otherwise
764 const wxSizer
* GetContainingSizer() const;
767 Return the cursor associated with this window.
771 const wxCursor
GetCursor() const;
774 Currently this is the same as calling
775 wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).
776 One advantage of using this function compared to the static version is that
777 the call is automatically dispatched to the correct class (as usual with
778 virtual functions) and you don't have to specify the class name explicitly.
779 The other one is that in the future this function could return different
780 results, for example it might return a different font for an "Ok" button
781 than for a generic button if the users GUI is configured to show such buttons
782 in bold font. Of course, the down side is that it is impossible to call this
783 function without actually having an object to apply it to whereas the static
784 version can be used without having to create an object first.
786 virtual wxVisualAttributes
GetDefaultAttributes() const;
789 Returns the associated drop target, which may be @NULL.
791 @see SetDropTarget(), @ref overview_wxdndoverview
793 wxDropTarget
* GetDropTarget() const;
796 Merges the window's best size into the min size and returns the result.
797 This is the value used by sizers to determine the appropriate
798 ammount of space to allocate for the widget.
800 @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
802 wxSize
GetEffectiveMinSize() const;
805 Returns the event handler for this window. By default, the window is its
808 @see SetEventHandler(), PushEventHandler(),
809 PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
811 wxEvtHandler
* GetEventHandler() const;
814 Returns the extra style bits for the window.
816 long GetExtraStyle() const;
819 Returns the font for this window.
823 wxFont
GetFont() const;
826 Returns the foreground colour of the window.
828 @remarks The interpretation of foreground colour is open to
829 interpretation according to the window class; it may be
830 the text colour or other colour, or it may not be used
833 @see SetForegroundColour(), SetBackgroundColour(),
834 GetBackgroundColour()
836 virtual wxColour
GetForegroundColour();
839 Returns the grandparent of a window, or @NULL if there isn't one.
841 wxWindow
* GetGrandParent() const;
844 Returns the platform-specific handle of the physical window. Cast it to an
846 handle, such as @b HWND for Windows, @b Widget for Motif, @b GtkWidget for GTK
847 or @b WinHandle for PalmOS.
849 void* GetHandle() const;
852 Gets the help text to be used as context-sensitive help for this window.
853 Note that the text is actually stored by the current wxHelpProvider
855 and not in the window object itself.
857 @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider
859 virtual wxString
GetHelpText() const;
862 Gets the help text to be used as context-sensitive help for this window. This
863 method should be overridden if the help message depends on the position inside
864 the window, otherwise GetHelpText() can be used.
867 Coordinates of the mouse at the moment of help event emission.
869 Help event origin, see also wxHelpEvent::GetOrigin.
871 virtual wxString
GetHelpTextAtPoint(const wxPoint point
,
872 wxHelpEvent::Origin origin
) const;
875 Returns the identifier of the window.
877 @remarks Each window has an integer identifier. If the application has
878 not provided one (or the default wxID_ANY) an unique
879 identifier with a negative value will be generated.
881 @see SetId(), @ref overview_windowids "Window identifiers"
886 Generic way of getting a label from any window, for
887 identification purposes.
889 @remarks The interpretation of this function differs from class to class.
890 For frames and dialogs, the value returned is the
891 title. For buttons or static text controls, it is the
892 button text. This function can be useful for
893 meta-programs (such as testing tools or special-needs
894 access programs) which need to identify windows by name.
896 virtual wxString
GetLabel() const;
899 Returns the maximum size of window's client area.
900 This is an indication to the sizer layout mechanism that this is the maximum
901 possible size as well as the upper bound on window's size settable using
906 wxSize
GetMaxClientSize() const;
909 Returns the maximum size of the window. This is an indication to the sizer
910 layout mechanism that this is the maximum possible size as well as the upper
911 bound on window's size settable using SetSize().
913 @see GetMaxClientSize()
915 wxSize
GetMaxSize() const;
918 Returns the minimum size of window's client area, an indication to the sizer
919 layout mechanism that this is the minimum required size of its client area. It
920 normally just returns the value set by
921 SetMinClientSize(), but it can be overridden
922 to do the calculation on demand.
926 virtual wxSize
GetMinClientSize() const;
929 Returns the minimum size of the window, an indication to the sizer layout
931 that this is the minimum required size. It normally just returns the value set
932 by SetMinSize(), but it can be overridden to do the
933 calculation on demand.
935 @see GetMinClientSize()
937 virtual wxSize
GetMinSize() const;
940 Returns the window's name.
942 @remarks This name is not guaranteed to be unique; it is up to the
943 programmer to supply an appropriate name in the window
944 constructor or via SetName().
948 virtual wxString
GetName() const;
951 Returns the next window after this one among the parent children or @NULL if
952 this window is the last child.
956 @see GetPrevSibling()
958 wxWindow
* GetNextSibling() const;
961 Returns the parent of the window, or @NULL if there is no parent.
963 virtual wxWindow
* GetParent() const;
967 This function shows a popup menu at the given position in this window and
968 returns the selected id. It can be more convenient than the general purpose
969 PopupMenu() function for simple menus proposing a
970 choice in a list of strings to the user.
975 The position at which to show the menu in client coordinates
977 The horizontal position of the menu
979 The vertical position of the menu
981 @returns The selected menu item id or wxID_NONE if none selected or an
984 int GetPopupMenuSelectionFromUser(wxMenu
& menu
,
986 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
);
991 This gets the position of the window in pixels, relative to the parent window
992 for the child windows or relative to the display origin for the top level
996 Receives the x position of the window if non-@NULL.
998 Receives the y position of the window if non-@NULL.
1000 @see GetScreenPosition()
1002 virtual void GetPosition(int* x
, int* y
) const;
1003 const wxPoint
GetPosition() const;
1007 Returns the previous window before this one among the parent children or @c
1009 this window is the first child.
1013 @see GetNextSibling()
1015 wxWindow
* GetPrevSibling() const;
1018 Returns the position and size of the window as a wxRect object.
1020 @see GetScreenRect()
1022 virtual wxRect
GetRect() const;
1026 Returns the window position in screen coordinates, whether the window is a
1027 child window or a top level one.
1030 Receives the x position of the window on the screen if non-@NULL.
1032 Receives the y position of the window on the screen if non-@NULL.
1036 virtual void GetScreenPosition(int* x
, int* y
) const;
1037 const wxPoint
GetScreenPosition() const;
1041 Returns the position and size of the window on the screen as a
1046 virtual wxRect
GetScreenRect() const;
1049 Returns the built-in scrollbar position.
1051 @see See SetScrollbar()
1053 virtual int GetScrollPos(int orientation
);
1056 Returns the built-in scrollbar range.
1060 virtual int GetScrollRange(int orientation
);
1063 Returns the built-in scrollbar thumb size.
1067 virtual int GetScrollThumb(int orientation
);
1071 Returns the size of the entire window in pixels, including title bar, border,
1073 Note that if this window is a top-level one and it is currently minimized, the
1074 returned size is the restored window size, not the size of the window icon.
1077 Receives the window width.
1079 Receives the window height.
1081 @see GetClientSize(), GetVirtualSize()
1083 void GetSize(int* width
, int* height
) const;
1084 const wxSize
GetSize() const;
1088 Return the sizer associated with the window by a previous call to
1089 SetSizer() or @NULL.
1091 wxSizer
* GetSizer() const;
1095 Gets the dimensions of the string as it would be drawn on the
1096 window with the currently selected font.
1097 The text extent is returned in @a w and @a h pointers (first form) or as a
1098 wxSize object (second form).
1101 String whose extent is to be measured.
1103 Return value for width.
1105 Return value for height.
1107 Return value for descent (optional).
1108 @param externalLeading
1109 Return value for external leading (optional).
1111 Font to use instead of the current window font (optional).
1113 If @true, string contains 16-bit characters. The default is @false.
1115 virtual void GetTextExtent(const wxString
& string
, int* w
,
1117 int* descent
= NULL
,
1118 int* externalLeading
= NULL
,
1119 const wxFont
* font
= NULL
,
1120 bool use16
= false) const;
1121 const wxSize
GetTextExtent(const wxString
& string
) const;
1125 Get the associated tooltip or @NULL if none.
1127 wxToolTip
* GetToolTip() const;
1130 Returns the region specifying which parts of the window have been damaged.
1132 only be called within an wxPaintEvent handler.
1134 @see wxRegion, wxRegionIterator
1136 virtual wxRegion
GetUpdateRegion() const;
1139 Returns a pointer to the current validator for the window, or @NULL if there is
1142 wxValidator
* GetValidator() const;
1146 This gets the virtual size of the window in pixels. By default it
1147 returns the client size of the window, but after a call to
1148 SetVirtualSize() it will return
1152 Receives the window virtual width.
1154 Receives the window virtual height.
1156 void GetVirtualSize(int* width
, int* height
) const;
1157 const wxSize
GetVirtualSize() const;
1161 Returns the size of the left/right and top/bottom borders of this window in x
1162 and y components of the result respectively.
1164 wxSize
GetWindowBorderSize() const;
1167 Gets the window style that was passed to the constructor or @b Create
1168 method. @b GetWindowStyle() is another name for the same function.
1170 long GetWindowStyleFlag() const;
1173 Returns the value previously passed to
1176 wxWindowVariant
GetWindowVariant() const;
1179 This function will generate the appropriate call to
1180 Navigate() if the key event is one normally used for
1181 keyboard navigation and return @true in this case.
1183 @returns Returns @true if the key pressed was for navigation and was
1184 handled, @false otherwise.
1188 bool HandleAsNavigationKey(const wxKeyEvent
& event
);
1192 wxWindow::GetEventHandler()-wxEvtHandler::SafelyProcessEvent(event).
1194 bool HandleWindowEvent(wxEvent
& event
);
1197 Returns @true if this window has the current mouse capture.
1199 @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent,
1200 wxMouseCaptureChangedEvent
1202 virtual bool HasCapture() const;
1205 Returns @true if the window has the given @a exFlag bit set in its
1208 @see SetExtraStyle()
1210 bool HasExtraStyle(int exFlag
) const;
1213 Returns @true if the window has the given @a flag bit set.
1215 bool HasFlag(int flag
) const;
1218 Returns @true if the window (or in case of composite controls, its main
1219 child window) has focus.
1223 virtual bool HasFocus() const;
1226 This method should be overridden to return @true if this window has
1227 multiple pages. All standard class with multiple pages such as
1228 wxNotebook, wxListbook and
1229 wxTreebook already override it to return @true
1230 and user-defined classes with similar behaviour should do it as well to allow
1231 the library to handle such windows appropriately.
1233 virtual bool HasMultiplePages() const;
1236 Returns @true if this window has a scroll bar for this orientation.
1239 Orientation to check, either wxHORIZONTAL or wxVERTICAL.
1241 virtual bool HasScrollbar(int orient
) const;
1244 Returns @true if this window background is transparent (as, for example, for
1245 wxStaticText) and should show the parent window background.
1246 This method is mostly used internally by the library itself and you normally
1247 shouldn't have to call it. You may, however, have to override it in your
1248 wxWindow-derived class to ensure that background is painted correctly.
1250 virtual bool HasTransparentBackground() const;
1253 Equivalent to calling wxWindow::Show(@false).
1258 This function hides a window, like Hide(), but using a
1259 special visual effect if possible.
1260 The parameters of this function are the same as for
1261 ShowWithEffect(), please see their
1266 virtual bool HideWithEffect(wxShowEffect effect
,
1267 unsigned timeout
= 0,
1268 wxDirection dir
= wxBOTTOM
);
1271 This function is (or should be, in case of custom controls) called during
1272 window creation to intelligently set up the window visual attributes, that is
1273 the font and the foreground and background colours.
1274 By "intelligently" the following is meant: by default, all windows use their
1275 own @ref getclassdefaultattributes() default attributes. However
1276 if some of the parents attributes are explicitly (that is, using
1278 wxWindow::SetOwnFont) changed and if the
1279 corresponding attribute hadn't been explicitly set for this window itself,
1280 then this window takes the same value as used by the parent. In addition, if
1281 the window overrides ShouldInheritColours()
1282 to return @false, the colours will not be changed no matter what and only the
1284 This rather complicated logic is necessary in order to accommodate the
1285 different usage scenarios. The most common one is when all default attributes
1286 are used and in this case, nothing should be inherited as in modern GUIs
1287 different controls use different fonts (and colours) than their siblings so
1288 they can't inherit the same value from the parent. However it was also deemed
1289 desirable to allow to simply change the attributes of all children at once by
1290 just changing the font or colour of their common parent, hence in this case we
1291 do inherit the parents attributes.
1293 void InheritAttributes();
1296 Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data
1297 to the dialog via validators.
1302 Resets the cached best size value so it will be recalculated the next time it
1305 void InvalidateBestSize();
1308 Returns @true if the window contents is double-buffered by the system, i.e. if
1309 any drawing done on the window is really done on a temporary backing surface
1310 and transferred to the screen all at once later.
1314 virtual bool IsDoubleBuffered() const;
1317 Returns @true if the window is enabled, i.e. if it accepts user input, @c
1320 Notice that this method can return @false even if this window itself hadn't
1321 been explicitly disabled when one of its parent windows is disabled. To get the
1322 intrinsic status of this window, use
1327 virtual bool IsEnabled() const;
1331 Returns @true if the given point or rectangle area has been exposed since the
1332 last repaint. Call this in an paint event handler to optimize redrawing by
1333 only redrawing those areas, which have been exposed.
1335 bool IsExposed(int x
, int y
) const;
1336 const bool IsExposed(wxPoint amp
;pt
) const;
1337 const bool IsExposed(int x
, int y
, int w
, int h
) const;
1338 const bool IsExposed(wxRect amp
;rect
) const;
1342 Returns @true if the window is currently frozen by a call to
1345 @see Freeze(), Thaw()
1347 virtual bool IsFrozen() const;
1350 Returns @true if the window is retained, @false otherwise.
1352 @remarks Retained windows are only available on X platforms.
1354 virtual bool IsRetained() const;
1357 Return whether a scrollbar is always shown.
1360 Orientation to check, either wxHORIZONTAL or wxVERTICAL.
1362 @see AlwaysShowScrollbars()
1364 bool IsScrollbarAlwaysShown(int orient
);
1367 Returns @true if the window is shown, @false if it has been hidden.
1369 @see IsShownOnScreen()
1371 virtual bool IsShown() const;
1374 Returns @true if the window is physically visible on the screen, i.e. it
1375 is shown and all its parents up to the toplevel window are shown as well.
1379 virtual bool IsShownOnScreen() const;
1382 Returns @true if this window is intrinsically enabled, @false otherwise,
1384 if @ref enable() Enable(@false) had been called. This method is
1385 mostly used for wxWidgets itself, user code should normally use
1386 IsEnabled() instead.
1388 bool IsThisEnabled() const;
1391 Returns @true if the given window is a top-level one. Currently all frames and
1392 dialogs are considered to be top-level windows (even if they have a parent
1395 bool IsTopLevel() const;
1398 Invokes the constraint-based layout algorithm or the sizer-based algorithm
1401 See SetAutoLayout(): when auto layout is on, this function gets called automatically
1402 when the window is resized.
1404 @see @ref overview_windowsizing
1409 Lowers the window to the bottom of the window hierarchy (Z-order).
1416 Disables all other windows in the application so that
1417 the user can only interact with this window.
1420 If @true, this call disables all other windows in the application so that
1421 the user can only interact with this window. If @false, the effect is
1424 virtual void MakeModal(bool flag
);
1428 Moves the window to the given position.
1431 Required x position.
1433 Required y position.
1435 wxPoint object representing the position.
1437 @remarks Implementations of SetSize can also implicitly implement the
1438 Move() function, which is defined in the base
1439 wxWindow class as the call:
1443 void Move(int x
, int y
);
1444 void Move(const wxPoint
& pt
);
1448 Moves this window in the tab navigation order after the specified @e win.
1449 This means that when the user presses @c TAB key on that other window,
1450 the focus switches to this window.
1451 Default tab order is the same as creation order, this function and
1452 MoveBeforeInTabOrder() allow to change
1453 it after creating all the windows.
1456 A sibling of this window which should precede it in tab order,
1459 void MoveAfterInTabOrder(wxWindow
* win
);
1462 Same as MoveAfterInTabOrder() except that
1463 it inserts this window just before @a win instead of putting it right after
1466 void MoveBeforeInTabOrder(wxWindow
* win
);
1469 Performs a keyboard navigation action starting from this window. This method is
1470 equivalent to calling NavigateIn() method on the
1474 A combination of wxNavigationKeyEvent::IsForward and
1475 wxNavigationKeyEvent::WinChange.
1477 @returns Returns @true if the focus was moved to another window or @false
1480 @remarks You may wish to call this from a text control custom keypress
1481 handler to do the default navigation behaviour for the
1482 tab key, since the standard default behaviour for a
1483 multiline text control with the wxTE_PROCESS_TAB style
1484 is to insert a tab and not navigate to the next
1485 control. See also wxNavigationKeyEvent and
1486 HandleAsNavigationKey.
1488 bool Navigate(int flags
= wxNavigationKeyEvent::IsForward
);
1491 Performs a keyboard navigation action inside this window.
1492 See Navigate() for more information.
1494 bool NavigateIn(int flags
= wxNavigationKeyEvent::IsForward
);
1497 Create a new ID or range of IDs that are not currently in use. The
1498 IDs will be reserved until assigned to a wxWindowIDRef()
1499 or unreserved with UnreserveControlId().
1500 See @ref overview_windowidsoverview "Window IDs overview" for more information.
1503 The number of sequential IDs to reserve.
1505 @returns Returns the ID or the first ID of the range, or wxID_NONE if the
1506 specified number of identifiers couldn't be allocated.
1508 @see UnreserveControlId(), wxIdManager, @ref overview_windowidsoverview
1509 "Window IDs overview"
1511 static wxWindowID
NewControlId(int count
= 1);
1514 This virtual function is normally only used internally, but
1515 sometimes an application may need it to implement functionality
1516 that should not be disabled by an application defining an OnIdle
1517 handler in a derived class.
1518 This function may be used to do delayed painting, for example,
1519 and most implementations call UpdateWindowUI()
1520 in order to send update events to the window in idle time.
1522 virtual void OnInternalIdle();
1525 Same as #ScrollLines (-1).
1530 Same as #ScrollLines (1).
1535 Same as #ScrollPages (-1).
1540 Same as #ScrollPages (1).
1546 Removes and returns the top-most event handler on the event handler stack.
1548 @param deleteHandler
1549 If this is @true, the handler will be deleted after it is removed. The
1550 default value is @false.
1552 @see SetEventHandler(), GetEventHandler(),
1553 PushEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
1555 wxEvtHandler
* PopEventHandler(bool deleteHandler
= false) const;
1559 Pops up the given menu at the specified coordinates, relative to this
1560 window, and returns control when the user has dismissed the menu. If a
1561 menu item is selected, the corresponding menu event is generated and will be
1562 processed as usually. If the coordinates are not specified, current mouse
1563 cursor position is used.
1568 The position where the menu will appear.
1570 Required x position for the menu to appear.
1572 Required y position for the menu to appear.
1574 @remarks Just before the menu is popped up, wxMenu::UpdateUI is called to
1575 ensure that the menu items are in the correct state.
1576 The menu does not get deleted by the window.
1580 bool PopupMenu(wxMenu
* menu
,
1581 const wxPoint
& pos
= wxDefaultPosition
);
1582 bool PopupMenu(wxMenu
* menu
, int x
, int y
);
1586 Pushes this event handler onto the event stack for the window.
1589 Specifies the handler to be pushed.
1591 @remarks An event handler is an object that is capable of processing the
1592 events sent to a window. By default, the window is its
1593 own event handler, but an application may wish to
1594 substitute another, for example to allow central
1595 implementation of event-handling for a variety of
1596 different window classes.
1598 @see SetEventHandler(), GetEventHandler(),
1599 PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
1601 void PushEventHandler(wxEvtHandler
* handler
);
1604 Raises the window to the top of the window hierarchy (Z-order).
1605 In current version of wxWidgets this works both for managed and child windows.
1612 Causes this window, and all of its children recursively (except under wxGTK1
1613 where this is not implemented), to be repainted. Note that repainting doesn't
1614 happen immediately but only during the next event loop iteration, if you need
1615 to update the window immediately you should use Update()
1618 @param eraseBackground
1619 If @true, the background will be
1622 If non-@NULL, only the given rectangle will
1623 be treated as damaged.
1627 virtual void Refresh(bool eraseBackground
= true,
1628 const wxRect
* rect
= NULL
);
1631 Redraws the contents of the given rectangle: only the area inside it will be
1633 This is the same as Refresh() but has a nicer syntax
1634 as it can be called with a temporary wxRect object as argument like this
1635 @c RefreshRect(wxRect(x, y, w, h)).
1637 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true);
1640 Registers a system wide hotkey. Every time the user presses the hotkey
1641 registered here, this window
1642 will receive a hotkey event. It will receive the event even if the application
1643 is in the background
1644 and does not have the input focus because the user is working with some other
1648 Numeric identifier of the hotkey. For applications this must be between 0
1650 this function is called from a shared DLL, it must be a system wide unique
1651 identifier between 0xC000 and 0xFFFF.
1652 This is a MSW specific detail.
1654 A bitwise combination of wxMOD_SHIFT, wxMOD_CONTROL, wxMOD_ALT
1655 or wxMOD_WIN specifying the modifier keys that have to be pressed along
1657 @param virtualKeyCode
1658 The virtual key code of the hotkey.
1660 @returns @true if the hotkey was registered successfully. @false if some
1661 other application already registered a hotkey with this
1662 modifier/virtualKeyCode combination.
1664 @remarks Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the
1665 event. This function is currently only implemented
1666 under Windows. It is used in the Windows CE port for
1667 detecting hardware button presses.
1669 @see UnregisterHotKey()
1671 bool RegisterHotKey(int hotkeyId
, int modifiers
,
1672 int virtualKeyCode
);
1675 Releases mouse input captured with CaptureMouse().
1677 @see CaptureMouse(), HasCapture(), ReleaseMouse(),
1678 wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
1680 virtual void ReleaseMouse();
1683 Removes a child window. This is called automatically by window deletion
1684 functions so should not be required by the application programmer.
1685 Notice that this function is mostly internal to wxWidgets and shouldn't be
1686 called by the user code.
1689 Child window to remove.
1691 virtual void RemoveChild(wxWindow
* child
);
1694 Find the given @a handler in the windows event handler chain and remove (but
1695 not delete) it from it.
1698 The event handler to remove, must be non-@NULL and
1699 must be present in this windows event handlers chain
1701 @returns Returns @true if it was found and @false otherwise (this also
1702 results in an assert failure so this function should
1703 only be called when the handler is supposed to be
1706 @see PushEventHandler(), PopEventHandler()
1708 bool RemoveEventHandler(wxEvtHandler
* handler
);
1711 Reparents the window, i.e the window will be removed from its
1712 current parent window (e.g. a non-standard toolbar in a wxFrame)
1713 and then re-inserted into another.
1718 virtual bool Reparent(wxWindow
* newParent
);
1722 Converts from screen to client window coordinates.
1725 Stores the screen x coordinate and receives the client x coordinate.
1727 Stores the screen x coordinate and receives the client x coordinate.
1729 The screen position for the second form of the function.
1731 virtual void ScreenToClient(int* x
, int* y
) const;
1732 const virtual wxPoint
ScreenToClient(const wxPoint
& pt
) const;
1736 Scrolls the window by the given number of lines down (if @a lines is
1739 @returns Returns @true if the window was scrolled, @false if it was already
1740 on top/bottom and nothing was done.
1742 @remarks This function is currently only implemented under MSW and
1743 wxTextCtrl under wxGTK (it also works for wxScrolled classes
1744 under all platforms).
1748 virtual bool ScrollLines(int lines
);
1751 Scrolls the window by the given number of pages down (if @a pages is
1754 @returns Returns @true if the window was scrolled, @false if it was already
1755 on top/bottom and nothing was done.
1757 @remarks This function is currently only implemented under MSW and wxGTK.
1761 virtual bool ScrollPages(int pages
);
1764 Physically scrolls the pixels in the window and move child windows accordingly.
1767 Amount to scroll horizontally.
1769 Amount to scroll vertically.
1771 Rectangle to scroll, if it is @NULL, the whole window is
1772 scrolled (this is always the case under wxGTK which doesn't support this
1775 @remarks Note that you can often use wxScrolled instead of using this
1778 virtual void ScrollWindow(int dx
, int dy
,
1779 const wxRect
* rect
= NULL
);
1782 Sets the accelerator table for this window. See wxAcceleratorTable.
1784 virtual void SetAcceleratorTable(const wxAcceleratorTable
& accel
);
1787 Sets the accessible for this window. Any existing accessible for this window
1788 will be deleted first, if not identical to @e accessible.
1789 See also wxAccessible.
1791 void SetAccessible(wxAccessible
* accessible
);
1794 Determines whether the Layout() function will
1795 be called automatically when the window is resized. Please note that this only
1796 happens for the windows usually used to contain children, namely
1797 wxPanel and wxTopLevelWindow
1798 (and the classes deriving from them).
1799 This method is called implicitly by
1800 SetSizer() but if you use
1801 SetConstraints() you should call it
1802 manually or otherwise the window layout won't be correctly updated when its
1806 Set this to @true if you wish the Layout function to be
1807 called automatically when the window is resized.
1809 @see SetConstraints()
1811 void SetAutoLayout(bool autoLayout
);
1814 Sets the background colour of the window.
1815 Please see InheritAttributes() for
1816 explanation of the difference between this method and
1817 SetOwnBackgroundColour().
1820 The colour to be used as the background colour, pass
1821 wxNullColour to reset to the default colour.
1823 @remarks The background colour is usually painted by the default
1824 wxEraseEvent event handler function under Windows and
1825 automatically under GTK.
1827 @see GetBackgroundColour(), SetForegroundColour(),
1828 GetForegroundColour(), ClearBackground(),
1829 Refresh(), wxEraseEvent
1831 virtual bool SetBackgroundColour(const wxColour
& colour
);
1834 Sets the background style of the window. see
1835 GetBackgroundStyle() for the description
1836 of the possible style values.
1838 @see SetBackgroundColour(), GetForegroundColour(),
1841 virtual void SetBackgroundStyle(wxBackgroundStyle style
);
1844 This method is only implemented by ports which have support for
1845 native TAB traversal (such as GTK+ 2.0). It is called by wxWidgets'
1846 container control code to give the native system a hint when
1847 doing TAB traversal. A call to this does not disable or change
1848 the effect of programmatically calling
1851 @see wxFocusEvent, wxPanel::SetFocus, wxPanel::SetFocusIgnoringChildren
1853 virtual void SetCanFocus(bool canFocus
);
1856 Sets the caret() associated with the window.
1858 void SetCaret(wxCaret
* caret
) const;
1862 This sets the size of the window client area in pixels. Using this function to
1864 tends to be more device-independent than SetSize(), since the application need
1866 worry about what dimensions the border or title bar have when trying to fit the
1868 around panel items, for example.
1871 The required client area width.
1873 The required client area height.
1875 The required client size.
1877 virtual void SetClientSize(int width
, int height
);
1878 virtual void SetClientSize(const wxSize
& size
);
1882 Sets the window to have the given layout constraints. The window
1883 will then own the object, and will take care of its deletion.
1884 If an existing layout constraints object is already owned by the
1885 window, it will be deleted.
1888 The constraints to set. Pass @NULL to disassociate and delete the window's
1891 @remarks You must call SetAutoLayout() to tell a window to use
1892 the constraints automatically in OnSize; otherwise, you
1893 must override OnSize and call Layout() explicitly. When
1894 setting both a wxLayoutConstraints and a wxSizer, only
1895 the sizer will have effect.
1897 void SetConstraints(wxLayoutConstraints
* constraints
);
1900 This normally does not need to be called by user code. It is called
1901 when a window is added to a sizer, and is used so the window can
1902 remove itself from the sizer when it is destroyed.
1904 void SetContainingSizer(wxSizer
* sizer
);
1907 Sets the window's cursor. Notice that the window cursor also sets it for the
1908 children of the window implicitly.
1909 The @a cursor may be @c wxNullCursor in which case the window cursor will
1910 be reset back to default.
1913 Specifies the cursor that the window should normally display.
1915 @see ::wxSetCursor, wxCursor
1917 virtual void SetCursor(const wxCursor
& cursor
);
1920 Associates a drop target with this window.
1921 If the window already has a drop target, it is deleted.
1923 @see GetDropTarget(), @ref overview_wxdndoverview
1925 void SetDropTarget(wxDropTarget
* target
);
1928 Sets the event handler for this window.
1931 Specifies the handler to be set.
1933 @remarks An event handler is an object that is capable of processing the
1934 events sent to a window. By default, the window is its
1935 own event handler, but an application may wish to
1936 substitute another, for example to allow central
1937 implementation of event-handling for a variety of
1938 different window classes.
1940 @see GetEventHandler(), PushEventHandler(),
1941 PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
1943 void SetEventHandler(wxEvtHandler
* handler
);
1946 Sets the extra style bits for the window. The currently defined extra style
1949 @b wxWS_EX_VALIDATE_RECURSIVELY
1951 TransferDataTo/FromWindow()
1952 and Validate() methods will recursively descend into all children of the
1953 window if it has this style flag set.
1955 @b wxWS_EX_BLOCK_EVENTS
1957 Normally, the command
1958 events are propagated upwards to the window parent recursively until a handler
1959 for them is found. Using this style allows to prevent them from being
1960 propagated beyond this window. Notice that wxDialog has this style on by
1961 default for the reasons explained in the
1962 @ref overview_eventprocessing "event processing overview".
1964 @b wxWS_EX_TRANSIENT
1966 This can be used to prevent a
1967 window from being used as an implicit parent for the dialogs which were
1968 created without a parent. It is useful for the windows which can disappear at
1969 any moment as creating children of such windows results in fatal problems.
1971 @b wxWS_EX_CONTEXTHELP
1973 Under Windows, puts a query
1974 button on the caption. When pressed, Windows will go into a context-sensitive
1975 help mode and wxWidgets will send a wxEVT_HELP event if the user clicked on an
1977 This style cannot be used together with wxMAXIMIZE_BOX or wxMINIMIZE_BOX, so
1978 these two styles are automatically turned of if this one is used.
1980 @b wxWS_EX_PROCESS_IDLE
1982 This window should always process idle events, even
1983 if the mode set by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.
1985 @b wxWS_EX_PROCESS_UI_UPDATES
1987 This window should always process UI update events,
1988 even if the mode set by wxUpdateUIEvent::SetMode is
1989 wxUPDATE_UI_PROCESS_SPECIFIED.
1991 void SetExtraStyle(long exStyle
);
1994 This sets the window to receive keyboard input.
1996 @see HasFocus(), wxFocusEvent, wxPanel::SetFocus,
1997 wxPanel::SetFocusIgnoringChildren
1999 virtual void SetFocus();
2002 This function is called by wxWidgets keyboard navigation code when the user
2003 gives the focus to this window from keyboard (e.g. using @c TAB key).
2004 By default this method simply calls SetFocus() but
2005 can be overridden to do something in addition to this in the derived classes.
2007 virtual void SetFocusFromKbd();
2010 Sets the font for this window. This function should not be called for the
2011 parent window if you don't want its font to be inherited by its children,
2012 use SetOwnFont() instead in this case and
2013 see InheritAttributes() for more
2015 Please notice that the given font is not automatically used for
2016 wxPaintDC objects associated with this window, you need to
2017 call wxDC::SetFont too. However this font is used by
2018 any standard controls for drawing their text as well as by
2022 Font to associate with this window, pass
2023 wxNullFont to reset to the default font.
2025 @returns @true if the want was really changed, @false if it was already set
2026 to this font and so nothing was done.
2028 @see GetFont(), InheritAttributes()
2030 bool SetFont(const wxFont
& font
);
2033 Sets the foreground colour of the window.
2034 Please see InheritAttributes() for
2035 explanation of the difference between this method and
2036 SetOwnForegroundColour().
2039 The colour to be used as the foreground colour, pass
2040 wxNullColour to reset to the default colour.
2042 @remarks The interpretation of foreground colour is open to
2043 interpretation according to the window class; it may be
2044 the text colour or other colour, or it may not be used
2047 @see GetForegroundColour(), SetBackgroundColour(),
2048 GetBackgroundColour(), ShouldInheritColours()
2050 virtual void SetForegroundColour(const wxColour
& colour
);
2053 Sets the help text to be used as context-sensitive help for this window.
2054 Note that the text is actually stored by the current wxHelpProvider
2056 and not in the window object itself.
2058 @see GetHelpText(), wxHelpProvider::AddHelp()
2060 virtual void SetHelpText(const wxString
& helpText
);
2063 Sets the identifier of the window.
2065 @remarks Each window has an integer identifier. If the application has
2066 not provided one, an identifier will be generated.
2067 Normally, the identifier should be provided on creation
2068 and should not be modified subsequently.
2070 @see GetId(), @ref overview_windowids "Window identifiers"
2075 Sets the initial window size if none is given (i.e. at least one of the
2076 components of the size passed to ctor/Create() is wxDefaultCoord).
2078 virtual void SetInitialBestSize(const wxSize
& size
);
2081 A @e smart SetSize that will fill in default size components with the
2082 window's @e best size values.
2084 Also sets the window's minsize to the value passed in for use with sizers.
2085 This means that if a full or partial size is passed to this function then
2086 the sizers will use that size instead of the results of GetBestSize() to
2087 determine the minimum needs of the window for layout.
2089 Most controls will use this to set their initial size, and their min
2090 size to the passed in value (if any.)
2092 @see SetSize(), GetBestSize(), GetEffectiveMinSize(),
2093 @ref overview_windowsizing
2095 void SetInitialSize(const wxSize
& size
= wxDefaultSize
);
2098 Sets the window's label.
2105 virtual void SetLabel(const wxString
& label
);
2108 Sets the maximum client size of the window, to indicate to the sizer
2109 layout mechanism that this is the maximum possible size of its client area.
2113 void SetMaxClientSize(const wxSize
& size
);
2116 Sets the maximum size of the window, to indicate to the sizer layout mechanism
2117 that this is the maximum possible size.
2119 @see SetMaxClientSize()
2121 void SetMaxSize(const wxSize
& size
);
2124 Sets the minimum client size of the window, to indicate to the sizer
2125 layout mechanism that this is the minimum required size of window's client
2126 area. You may need to call this if you change the window size after
2127 construction and before adding to its parent sizer.
2131 void SetMinClientSize(const wxSize
& size
);
2134 Sets the minimum size of the window, to indicate to the sizer layout mechanism
2135 that this is the minimum required size. You may need to call this
2136 if you change the window size after construction and before adding
2137 to its parent sizer.
2139 @see SetMinClientSize()
2141 void SetMinSize(const wxSize
& size
);
2144 Sets the window's name.
2147 A name to set for the window.
2151 virtual void SetName(const wxString
& name
);
2154 Sets the background colour of the window but prevents it from being inherited
2155 by the children of this window.
2157 @see SetBackgroundColour(), InheritAttributes()
2159 void SetOwnBackgroundColour(const wxColour
& colour
);
2162 Sets the font of the window but prevents it from being inherited by the
2163 children of this window.
2165 @see SetFont(), InheritAttributes()
2167 void SetOwnFont(const wxFont
& font
);
2170 Sets the foreground colour of the window but prevents it from being inherited
2171 by the children of this window.
2173 @see SetForegroundColour(), InheritAttributes()
2175 void SetOwnForegroundColour(const wxColour
& colour
);
2178 Obsolete - use wxDC::SetPalette instead.
2180 virtual void SetPalette(wxPalette
* palette
);
2183 Sets the position of one of the built-in scrollbars.
2186 Determines the scrollbar whose position is to be set. May be wxHORIZONTAL
2189 Position in scroll units.
2191 @true to redraw the scrollbar, @false otherwise.
2193 @remarks This function does not directly affect the contents of the
2194 window: it is up to the application to take note of
2195 scrollbar attributes and redraw contents accordingly.
2197 @see SetScrollbar(), GetScrollPos(), GetScrollThumb(), wxScrollBar,
2200 virtual void SetScrollPos(int orientation
, int pos
,
2201 bool refresh
= true);
2204 Sets the scrollbar properties of a built-in scrollbar.
2207 Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL
2210 The position of the scrollbar in scroll units.
2212 The size of the thumb, or visible portion of the scrollbar, in scroll units.
2214 The maximum position of the scrollbar.
2216 @true to redraw the scrollbar, @false otherwise.
2218 @remarks Let's say you wish to display 50 lines of text, using the same
2219 font. The window is sized so that you can only see 16
2222 @see @ref overview_scrolling, wxScrollBar, wxScrolled, wxScrollWinEvent
2224 virtual void SetScrollbar(int orientation
, int position
,
2227 bool refresh
= true);
2231 Sets the size of the window in pixels.
2234 Required x position in pixels, or wxDefaultCoord to indicate that the
2236 value should be used.
2238 Required y position in pixels, or wxDefaultCoord to indicate that the
2240 value should be used.
2242 Required width in pixels, or wxDefaultCoord to indicate that the existing
2243 value should be used.
2245 Required height position in pixels, or wxDefaultCoord to indicate that the
2247 value should be used.
2249 wxSize object for setting the size.
2251 wxRect object for setting the position and size.
2253 Indicates the interpretation of other parameters. It is a bit list of the
2255 wxSIZE_AUTO_WIDTH: a wxDefaultCoord width value is taken to indicate
2256 a wxWidgets-supplied default width.
2258 wxSIZE_AUTO_HEIGHT: a wxDefaultCoord height value is taken to indicate
2259 a wxWidgets-supplied default height.
2261 wxSIZE_AUTO: wxDefaultCoord size values are taken to indicate
2262 a wxWidgets-supplied default size.
2264 wxSIZE_USE_EXISTING: existing dimensions should be used
2265 if wxDefaultCoord values are supplied.
2267 wxSIZE_ALLOW_MINUS_ONE: allow negative dimensions (i.e. value of
2268 wxDefaultCoord) to be interpreted
2269 as real dimensions, not default values.
2270 wxSIZE_FORCE: normally, if the position and the size of the window are
2271 already the same as the parameters of this function, nothing is done. but
2273 this flag a window resize may be forced even in this case (supported in wx
2274 2.6.2 and later and only implemented for MSW and ignored elsewhere
2277 @remarks The second form is a convenience for calling the first form with
2278 default x and y parameters, and must be used with
2279 non-default width and height values.
2283 virtual void SetSize(int x
, int y
, int width
, int height
,
2284 int sizeFlags
= wxSIZE_AUTO
);
2285 virtual void SetSize(const wxRect
& rect
);
2286 virtual void SetSize(int width
, int height
);
2287 virtual void SetSize(const wxSize
& size
);
2291 Use of this function for windows which are not toplevel windows
2292 (such as wxDialog or wxFrame) is discouraged. Please use
2293 SetMinSize() and SetMaxSize()
2296 @see wxTopLevelWindow::SetSizeHints.
2301 Sets the window to have the given layout sizer. The window
2302 will then own the object, and will take care of its deletion.
2303 If an existing layout constraints object is already owned by the
2304 window, it will be deleted if the deleteOld parameter is @true.
2305 Note that this function will also call
2306 SetAutoLayout() implicitly with @true
2307 parameter if the @a sizer is non-@NULL and @false otherwise.
2310 The sizer to set. Pass @NULL to disassociate and conditionally delete
2311 the window's sizer. See below.
2313 If @true (the default), this will delete any pre-existing sizer.
2314 Pass @false if you wish to handle deleting the old sizer yourself.
2316 @remarks SetSizer now enables and disables Layout automatically, but
2317 prior to wxWidgets 2.3.3 the following applied:
2319 void SetSizer(wxSizer
* sizer
, bool deleteOld
= true);
2322 This method calls SetSizer() and then
2323 wxSizer::SetSizeHints which sets the initial
2324 window size to the size needed to accommodate all sizer elements and sets the
2325 size hints which, if this window is a top level one, prevent the user from
2326 resizing it to be less than this minimial size.
2328 void SetSizerAndFit(wxSizer
* sizer
, bool deleteOld
= true);
2331 This function tells a window if it should use the system's "theme" code
2332 to draw the windows' background instead if its own background drawing
2333 code. This does not always have any effect since the underlying platform
2334 obviously needs to support the notion of themes in user defined windows.
2335 One such platform is GTK+ where windows can have (very colourful) backgrounds
2336 defined by a user's selected theme.
2337 Dialogs, notebook pages and the status bar have this flag set to @true
2338 by default so that the default look and feel is simulated best.
2340 virtual void SetThemeEnabled(bool enable
);
2344 Attach a tooltip to the window.
2345 See also: GetToolTip(),
2348 void SetToolTip(const wxString
& tip
);
2349 void SetToolTip(wxToolTip
* tip
);
2353 Set the transparency of the window. If the system supports transparent windows,
2354 returns @true, otherwise returns @false and the window remains fully opaque.
2355 See also CanSetTransparent().
2356 The parameter @a alpha is in the range 0..255 where 0 corresponds to a
2357 fully transparent window and 255 to the fully opaque one. The constants
2358 @c wxIMAGE_ALPHA_TRANSPARENT and @c wxIMAGE_ALPHA_OPAQUE can be
2361 bool SetTransparent(wxByte alpha
);
2364 Deletes the current validator (if any) and sets the window validator, having
2365 called wxValidator::Clone to
2366 create a new validator of this type.
2368 virtual void SetValidator(const wxValidator
& validator
);
2372 Sets the virtual size of the window in pixels.
2374 void SetVirtualSize(int width
, int height
);
2375 void SetVirtualSize(const wxSize
& size
);
2380 Allows specification of minimum and maximum virtual window sizes.
2381 If a pair of values is not set (or set to -1), the default values
2385 Specifies the minimum width allowable.
2387 Specifies the minimum height allowable.
2389 Specifies the maximum width allowable.
2391 Specifies the maximum height allowable.
2397 @remarks If this function is called, the user will not be able to size
2398 the virtual area of the window outside the given bounds.
2400 virtual void SetVirtualSizeHints(int minW
, int minH
, int maxW
= -1,
2402 void SetVirtualSizeHints(const wxSize
& minSize
= wxDefaultSize
,
2403 const wxSize
& maxSize
= wxDefaultSize
);
2407 Identical to SetWindowStyleFlag().
2409 void SetWindowStyle(long style
);
2412 Sets the style of the window. Please note that some styles cannot be changed
2413 after the window creation and that Refresh() might
2414 need to be be called after changing the others for the change to take place
2416 See @ref overview_windowstyles "Window styles" for more information about flags.
2418 @see GetWindowStyleFlag()
2420 virtual void SetWindowStyleFlag(long style
);
2423 This function can be called under all platforms but only does anything under
2424 Mac OS X 10.3+ currently. Under this system, each of the standard control can
2425 exist in several sizes which correspond to the elements of wxWindowVariant
2428 By default the controls use the normal size, of course, but this function can
2429 be used to change this.
2431 void SetWindowVariant(wxWindowVariant variant
);
2434 Return @true from here to allow the colours of this window to be changed by
2435 InheritAttributes(), returning @false
2436 forbids inheriting them from the parent window.
2437 The base class version returns @false, but this method is overridden in
2438 wxControl where it returns @true.
2440 virtual bool ShouldInheritColours();
2443 Shows or hides the window. You may need to call Raise()
2444 for a top level window if you want to bring it to top, although this is not
2445 needed if Show() is called immediately after the frame creation.
2448 If @true displays the window. Otherwise, hides it.
2450 @returns @true if the window has been shown or hidden or @false if nothing
2451 was done because it already was in the requested state.
2453 @see IsShown(), Hide(), wxRadioBox::Show
2455 virtual bool Show(bool show
= true);
2458 This function shows a window, like Show(), but using a
2459 special visual effect if possible.
2460 Possible values for @a effect are:
2468 Sliding window effect
2472 Fade in or out effect
2474 wxSHOW_EFFECT_EXPAND
2476 Expanding or collapsing effect
2478 For the roll and slide effects the @a dir parameter specifies the animation
2479 direction: it can be one of @c wxTOP, @c wxBOTTOM, @c wxLEFT
2480 or @c wxRIGHT. For the other effects, this parameter is unused.
2481 The @a timeout parameter specifies the time of the animation, in
2482 milliseconds. If the default value of 0 is used, the default animation time
2483 for the current platform is used.
2484 Currently this function is only implemented in wxMSW and does the same thing as
2485 Show() in the other ports.
2489 @see HideWithEffect()
2491 virtual bool ShowWithEffect(wxShowEffect effect
,
2492 unsigned timeout
= 0,
2493 wxDirection dir
= wxBOTTOM
);
2496 Reenables window updating after a previous call to Freeze().
2498 To really thaw the control, it must be called exactly the same number
2499 of times as Freeze().
2501 If the window has any children, they are recursively thawn too.
2503 @see wxWindowUpdateLocker, Freeze(), IsFrozen()
2505 virtual void Thaw();
2508 Turns the given @a flag on if it's currently turned off and vice versa.
2509 This function cannot be used if the value of the flag is 0 (which is often
2510 the case for default flags).
2511 Also, please notice that not all styles can be changed after the control
2514 @returns Returns @true if the style was turned on by this function, @false
2515 if it was switched off.
2517 @see SetWindowStyleFlag(), HasFlag()
2519 bool ToggleWindowStyle(int flag
);
2522 Transfers values from child controls to data areas specified by their
2524 @false if a transfer failed.
2525 If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set,
2526 the method will also call TransferDataFromWindow() of all child windows.
2528 @see TransferDataToWindow(), wxValidator, Validate()
2530 virtual bool TransferDataFromWindow();
2533 Transfers values to child controls from data areas specified by their
2535 If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set,
2536 the method will also call TransferDataToWindow() of all child windows.
2538 @returns Returns @false if a transfer failed.
2540 @see TransferDataFromWindow(), wxValidator, Validate()
2542 virtual bool TransferDataToWindow();
2545 Unregisters a system wide hotkey.
2548 Numeric identifier of the hotkey. Must be the same id that was passed to
2551 @returns @true if the hotkey was unregistered successfully, @false if the
2554 @remarks This function is currently only implemented under MSW.
2556 @see RegisterHotKey()
2558 bool UnregisterHotKey(int hotkeyId
);
2561 Unreserve an ID or range of IDs that was reserved by NewControlId().
2562 See @ref overview_windowidsoverview "Window IDs overview" for more information.
2565 The starting ID of the range of IDs to unreserve.
2567 The number of sequential IDs to unreserve.
2569 @see NewControlId(), wxIdManager, @ref overview_windowidsoverview
2570 "Window IDs overview"
2572 static void UnreserveControlId(wxWindowID id
, int count
= 1);
2575 Calling this method immediately repaints the invalidated area of the window and
2576 all of its children recursively while this would usually only happen when the
2577 flow of control returns to the event loop.
2578 Notice that this function doesn't invalidate any area of the window so
2579 nothing happens if nothing has been invalidated (i.e. marked as requiring
2580 a redraw). Use Refresh() first if you want to
2581 immediately redraw the window unconditionally.
2583 virtual void Update();
2586 This function sends wxUpdateUIEvents() to
2587 the window. The particular implementation depends on the window; for
2588 example a wxToolBar will send an update UI event for each toolbar button,
2589 and a wxFrame will send an update UI event for each menubar menu item.
2590 You can call this function from your application to ensure that your
2591 UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers
2592 are concerned). This may be necessary if you have called
2593 wxUpdateUIEvent::SetMode or
2594 wxUpdateUIEvent::SetUpdateInterval to
2595 limit the overhead that wxWidgets incurs by sending update UI events in idle
2597 @a flags should be a bitlist of one or more of the following values.
2599 If you are calling this function from an OnInternalIdle or OnIdle
2600 function, make sure you pass the wxUPDATE_UI_FROMIDLE flag, since
2601 this tells the window to only update the UI elements that need
2602 to be updated in idle time. Some windows update their elements
2603 only when necessary, for example when a menu is about to be shown.
2604 The following is an example of how to call UpdateWindowUI from
2607 @see wxUpdateUIEvent, DoUpdateWindowUI(), OnInternalIdle()
2609 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
2612 Validates the current values of the child controls using their validators.
2613 If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set,
2614 the method will also call Validate() of all child windows.
2616 @returns Returns @false if any of the validations failed.
2618 @see TransferDataFromWindow(), TransferDataToWindow(),
2621 virtual bool Validate();
2624 Moves the pointer to the given position on the window.
2625 @note This function is not supported under Mac because Apple Human
2626 Interface Guidelines forbid moving the mouse cursor programmatically.
2629 The new x position for the cursor.
2631 The new y position for the cursor.
2633 void WarpPointer(int x
, int y
);
2638 // ============================================================================
2639 // Global functions/macros
2640 // ============================================================================
2642 /** @ingroup group_funcmacro_misc */
2646 Find the deepest window at the mouse pointer position, returning the window
2647 and current pointer position in screen coordinates.
2649 @header{wx/window.h}
2651 wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
2654 Gets the currently active window (implemented for MSW and GTK only
2655 currently, always returns @NULL in the other ports).
2657 @header{wx/window.h}
2659 wxWindow
* wxGetActiveWindow();
2662 Returns the first top level parent of the given window, or in other words,
2663 the frame or dialog containing it, or @NULL.
2665 @header{wx/window.h}
2667 wxWindow
* wxGetTopLevelParent(wxWindow
* window
);