// Purpose: interface of wxWindow
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
wxSHOW_EFFECT_EXPAND
};
+
+
+/**
+ struct containing all the visual attributes of a control
+*/
+struct wxVisualAttributes
+{
+ // the font used for control label/text inside it
+ wxFont font;
+
+ // the foreground colour
+ wxColour colFg;
+
+ // the background colour, may be wxNullColour if the controls background
+ // colour is not solid
+ wxColour colBg;
+};
+
+
/**
Different window variants, on platforms like eg mac uses different
rendering sizes.
@class wxWindow
wxWindow is the base class for all windows and represents any visible object
- om screen. All controls, top level windows and so on are windows. Sizers and
+ on screen. All controls, top level windows and so on are windows. Sizers and
device contexts are not, however, as they don't appear on screen themselves.
Please note that all children of the window will be deleted automatically by
@style{wxWS_EX_TRANSIENT}
Don't use this window as an implicit parent for the other windows:
this must be used with transient windows as otherwise there is the
- risk of creating a dialog/frame with this window as a parent which
- would lead to a crash if the parent is destroyed before the child.
+ risk of creating a dialog/frame with this window as a parent, which
+ would lead to a crash if the parent were destroyed before the child.
@style{wxWS_EX_CONTEXTHELP}
Under Windows, puts a query button on the caption. When pressed,
Windows will go into a context-sensitive help mode and wxWidgets
See wxKeyEvent.
@event{EVT_KEY_UP(func)}
Process a @c wxEVT_KEY_UP event (any key has been released).
+ See wxKeyEvent.
@event{EVT_CHAR(func)}
Process a @c wxEVT_CHAR event.
See wxKeyEvent.
+ @event{EVT_CHAR_HOOK(func)}
+ Process a @c wxEVT_CHAR_HOOK event.
+ See wxKeyEvent.
@event{EVT_MOUSE_CAPTURE_LOST(func)}
Process a @c wxEVT_MOUSE_CAPTURE_LOST event. See wxMouseCaptureLostEvent.
@event{EVT_MOUSE_CAPTURE_CHANGED(func)}
Process scroll events. See wxScrollWinEvent.
@event{EVT_SET_CURSOR(func)}
Process a @c wxEVT_SET_CURSOR event. See wxSetCursorEvent.
- @event{EVT_SHOW(func)}
- Process a @c wxEVT_SHOW event. See wxShowEvent.
@event{EVT_SIZE(func)}
Process a @c wxEVT_SIZE event. See wxSizeEvent.
@event{EVT_SYS_COLOUR_CHANGED(func)}
virtual ~wxWindow();
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxPanelNameStr);
+
/**
@name Focus functions
virtual bool AcceptsFocusFromKeyboard() const;
/**
- Overridden to indicate wehter this window or one of its children accepts
+ Overridden to indicate whether this window or one of its children accepts
focus. Usually it's the same as AcceptsFocus() but is overridden for
container windows.
*/
wxWindow* GetGrandParent() const;
/**
- Returns the next window after this one among the parent children or @NULL
+ Returns the next window after this one among the parent's children or @NULL
if this window is the last child.
@since 2.8.8
wxWindow* GetParent() const;
/**
- Returns the previous window before this one among the parent children or @c
+ Returns the previous window before this one among the parent's children or @c
@NULL if this window is the first child.
@since 2.8.8
*/
wxWindow* GetPrevSibling() const;
/**
- Reparents the window, i.e the window will be removed from its
+ Reparents the window, i.e. the window will be removed from its
current parent window (e.g. a non-standard toolbar in a wxFrame)
and then re-inserted into another.
wxPanel), the size returned by this function will be the same as the size
the window would have had after calling Fit().
- Note that when you write your own widget you need to overload the
+ Note that when you write your own widget you need to override the
DoGetBestSize() function instead of this (non-virtual!) function.
@see CacheBestSize(), @ref overview_windowsizing
/**
Merges the window's best size into the min size and returns the result.
This is the value used by sizers to determine the appropriate
- ammount of space to allocate for the widget.
+ amount of space to allocate for the widget.
- This is the method called by any wxSizer when they query the size
- of a certain window or control.
+ This is the method called by a wxSizer when it queries the size
+ of a window or control.
@see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
*/
*/
virtual wxSize GetMinSize() const;
+ int GetMinWidth() const;
+ int GetMinHeight() const;
+ int GetMaxWidth() const;
+ int GetMaxHeight() const;
+
/**
Returns the size of the entire window in pixels, including title bar, border,
scrollbars, etc.
*/
void GetVirtualSize(int* width, int* height) const;
+ /**
+ Return the largest of ClientSize and BestSize (as determined
+ by a sizer, interior children, or other means)
+ */
+ virtual wxSize GetBestVirtualSize() const;
+
/**
Returns the size of the left/right and top/bottom borders of this window in x
and y components of the result respectively.
*/
virtual wxSize GetWindowBorderSize() const;
+ /**
+ wxSizer and friends use this to give a chance to a component to recalc
+ its min size once one of the final size components is known. Override
+ this function when that is useful (such as for wxStaticText which can
+ stretch over several lines). Parameter availableOtherDir
+ tells the item how much more space there is available in the opposite
+ direction (-1 if unknown).
+ */
+ virtual bool
+ InformFirstDirection(int direction,
+ int size,
+ int availableOtherDir);
+
/**
Resets the cached best size value so it will be recalculated the next time it
is needed.
@see @ref overview_windowsizing
*/
- virtual void SetClientSize(int width, int height);
+ void SetClientSize(int width, int height);
/**
@overload
*/
- virtual void SetClientSize(const wxSize& size);
+ void SetClientSize(const wxSize& size);
+
+ /**
+ @overload
+ */
+ void SetClientSize(const wxRect& rect);
/**
This normally does not need to be called by user code.
@see Move(), @ref overview_windowsizing
*/
- virtual void SetSize(const wxRect& rect);
+ void SetSize(const wxRect& rect);
/**
@overload
*/
- virtual void SetSize(const wxSize& size);
+ void SetSize(const wxSize& size);
/**
@overload
*/
- virtual void SetSize(int width, int height);
+ void SetSize(int width, int height);
/**
Use of this function for windows which are not toplevel windows
@see wxTopLevelWindow::SetSizeHints, @ref overview_windowsizing
*/
- void SetSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize,
- const wxSize& incSize=wxDefaultSize);
+ virtual void SetSizeHints( const wxSize& minSize,
+ const wxSize& maxSize=wxDefaultSize,
+ const wxSize& incSize=wxDefaultSize);
+ virtual void SetSizeHints( int minW, int minH,
+ int maxW = -1, int maxH = -1,
+ int incW = -1, int incH = -1 );
/**
Sets the virtual size of the window in pixels.
Centres the window.
@param direction
- Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
- or wxBOTH. It may also include wxCENTRE_ON_SCREEN flag
- if you want to center the window on the entire screen and not on its
+ Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL
+ or wxBOTH. It may also include the wxCENTRE_ON_SCREEN flag
+ if you want to centre the window on the entire screen and not on its
parent window.
@remarks If the window is a top level one (i.e. doesn't have a parent),
- it will be centered relative to the screen anyhow.
+ it will be centred relative to the screen anyhow.
@see Center()
*/
Centres the window on its parent. This is a more readable synonym for Centre().
@param direction
- Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
+ Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL
or wxBOTH.
- @remarks This methods provides for a way to center top level windows over
+ @remarks This methods provides for a way to centre top level windows over
their parents instead of the entire screen. If there
is no parent or if the window is not a top level
window, then behaviour is the same as Centre().
@see wxTopLevelWindow::CentreOnScreen
*/
void CentreOnParent(int direction = wxBOTH);
+
/**
This gets the position of the window in pixels, relative to the parent window
for the child windows or relative to the display origin for the top level windows.
*/
wxRect GetScreenRect() const;
+ /**
+ Get the origin of the client area of the window relative to the
+ window top left corner (the client area may be shifted because of
+ the borders, scrollbars, other decorations...)
+ */
+ virtual wxPoint GetClientAreaOrigin() const;
+
+ /**
+ Get the client rectangle in window (i.e. client) coordinates
+ */
+ wxRect GetClientRect() const;
+
+
+
/**
Moves the window to the given position.
*/
void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING);
+ void SetPosition(const wxPoint& pt);
+
//@}
@see ConvertPixelsToDialog()
*/
- wxPoint ConvertDialogToPixels(const wxPoint& pt);
+ wxPoint ConvertDialogToPixels(const wxPoint& pt) const;
/**
@overload
*/
- wxSize ConvertDialogToPixels(const wxSize& sz);
+ wxSize ConvertDialogToPixels(const wxSize& sz) const;
/**
Converts a point or size from pixels to dialog units.
@see ConvertDialogToPixels()
*/
- wxPoint ConvertPixelsToDialog(const wxPoint& pt);
+ wxPoint ConvertPixelsToDialog(const wxPoint& pt) const;
/**
@overload
*/
- wxSize ConvertPixelsToDialog(const wxSize& sz);
+ wxSize ConvertPixelsToDialog(const wxSize& sz) const;
/**
Converts from screen to client window coordinates.
//@{
/**
- Clears the window by filling it with the current background colour. Does not
- cause an erase background event to be generated.
+ Clears the window by filling it with the current background colour.
+
+ Does not cause an erase background event to be generated.
+
+ Notice that this uses wxClientDC to draw on the window and the results
+ of doing it while also drawing on wxPaintDC for this window are
+ undefined. Hence this method shouldn't be used from EVT_PAINT handlers,
+ just use wxDC::Clear() on the wxPaintDC you already use there instead.
*/
virtual void ClearBackground();
void Freeze();
/**
- Reenables window updating after a previous call to Freeze().
+ Re-enables window updating after a previous call to Freeze().
To really thaw the control, it must be called exactly the same number
of times as Freeze().
- If the window has any children, they are recursively thawn too.
+ If the window has any children, they are recursively thawed too.
@see wxWindowUpdateLocker, Freeze(), IsFrozen()
*/
/**
Returns the foreground colour of the window.
- @remarks The interpretation of foreground colour is open to
- interpretation according to the window class; it may be
- the text colour or other colour, or it may not be used at all.
+ @remarks The meaning of foreground colour varies according to the window class;
+ it may be the text colour or other colour, or it may not be used at all.
@see SetForegroundColour(), SetBackgroundColour(),
GetBackgroundColour()
Gets the dimensions of the string as it would be drawn on the
window with the currently selected font.
- The text extent is returned in @a w and @a h pointers.
+ The text extent is returned in the @a w and @a h pointers.
@param string
String whose extent is to be measured.
@endWxPerlOnly
*/
void GetTextExtent(const wxString& string,
- int* w, int* h,
+ int* w, int* h,
int* descent = NULL,
int* externalLeading = NULL,
const wxFont* font = NULL) const;
*/
const wxRegion& GetUpdateRegion() const;
+ /**
+ Get the update rectangle bounding box in client coords
+ */
+ wxRect GetUpdateClientRect() const;
+
/**
Returns @true if this window background is transparent (as, for example,
for wxStaticText) and should show the parent window background.
/**
Calling this method immediately repaints the invalidated area of the window and
- all of its children recursively while this would usually only happen when the
- flow of control returns to the event loop.
+ all of its children recursively (this normally only happens when the
+ flow of control returns to the event loop).
Notice that this function doesn't invalidate any area of the window so
nothing happens if nothing has been invalidated (i.e. marked as requiring
this method and SetOwnBackgroundColour().
@param colour
- The colour to be used as the background colour, pass
+ The colour to be used as the background colour; pass
wxNullColour to reset to the default colour.
+ Note that you may want to use wxSystemSettings::GetColour() to retrieve
+ a suitable colour to use rather than setting an hard-coded one.
@remarks The background colour is usually painted by the default
wxEraseEvent event handler function under Windows and
@see GetBackgroundColour(), SetForegroundColour(),
GetForegroundColour(), ClearBackground(),
- Refresh(), wxEraseEvent
+ Refresh(), wxEraseEvent, wxSystemSettings
*/
virtual bool SetBackgroundColour(const wxColour& colour);
/**
Sets the background style of the window.
- The default background style is wxBG_STYLE_ERASE which indicates that
- the window background may be erased in EVT_ERASE_BACKGROUND handler.
- This is a safe compatibility default however you may want to change it
- to wxBG_STYLE_SYSTEM if you don't define any erase background event
- handlers at all to avoid unnecessary generation of erase background
+ The default background style is @c wxBG_STYLE_ERASE which indicates that
+ the window background may be erased in @c EVT_ERASE_BACKGROUND handler.
+ This is a safe, compatibility default; however you may want to change it
+ to @c wxBG_STYLE_SYSTEM if you don't define any erase background event
+ handlers at all, to avoid unnecessary generation of erase background
events and always let system erase the background. And you should
- change the background style to wxBG_STYLE_PAINT if you define an
- EVT_PAINT handler which completely overwrites the window background as
- in this case erasing it previously, either in EVT_ERASE_BACKGROUND
+ change the background style to @c wxBG_STYLE_PAINT if you define an
+ @c EVT_PAINT handler which completely overwrites the window background as
+ in this case erasing it previously, either in @c EVT_ERASE_BACKGROUND
handler or in the system default handler, would result in flicker as
the background pixels will be repainted twice every time the window is
redrawn. Do ensure that the background is entirely erased by your
- EVT_PAINT handler in this case however as otherwise garbage may be left
+ @c EVT_PAINT handler in this case however as otherwise garbage may be left
on screen.
Notice that in previous versions of wxWidgets a common way to work
around the above mentioned flickering problem was to define an empty
- EVT_ERASE_BACKGROUND handler. Setting background style to
- wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
+ @c EVT_ERASE_BACKGROUND handler. Setting background style to
+ @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
problem.
@see SetBackgroundColour(), GetForegroundColour(),
this method and SetOwnForegroundColour().
@param colour
- The colour to be used as the foreground colour, pass
+ The colour to be used as the foreground colour; pass
wxNullColour to reset to the default colour.
- @remarks The interpretation of foreground colour is open to
- interpretation according to the window class; it may be
- the text colour or other colour, or it may not be used at all.
+ @remarks The meaning of foreground colour varies according to the window class;
+ it may be the text colour or other colour, or it may not be used at all.
@return @true if the colour was really changed, @false if it was already set
to this colour and nothing was done.
/**
Return @true from here to allow the colours of this window to be changed by
- InheritAttributes(), returning @false forbids inheriting them from the parent window.
+ InheritAttributes(). Returning @false forbids inheriting them from the parent window.
The base class version returns @false, but this method is overridden in
wxControl where it returns @true.
/**
This function tells a window if it should use the system's "theme" code
- to draw the windows' background instead if its own background drawing
+ to draw the windows' background instead of its own background drawing
code. This does not always have any effect since the underlying platform
obviously needs to support the notion of themes in user defined windows.
One such platform is GTK+ where windows can have (very colourful) backgrounds
*/
virtual void SetThemeEnabled(bool enable);
+ /**
+ */
+ virtual bool GetThemeEnabled() const;
+
/**
Returns @true if the system supports transparent windows and calling
SetTransparent() may succeed. If this function returns @false, transparent
This is the same as writing @code GetEventHandler()->ProcessEvent(event);
@endcode but more convenient. Notice that ProcessEvent() itself can't
be called for wxWindow objects as it ignores the event handlers
- associated with the window, use this function instead.
+ associated with the window; use this function instead.
*/
bool ProcessWindowEvent(wxEvent& event);
+ /**
+ Wrapper for wxEvtHandler::ProcessEventLocally().
+
+ This method is similar to ProcessWindowEvent() but can be used to
+ search for the event handler only in this window and any event handlers
+ pushed on top of it. Unlike ProcessWindowEvent() it won't propagate the
+ event upwards. But it will use the validator and event handlers
+ associated with this window, if any.
+
+ @since 2.9.1
+ */
+ bool ProcessWindowEventLocally(wxEvent& event);
+
/**
Removes and returns the top-most event handler on the event handler stack.
/**
Sets the style of the window. Please note that some styles cannot be changed
- after the window creation and that Refresh() might need to be be called
+ after the window creation and that Refresh() might need to be called
after changing the others for the change to take place immediately.
See @ref overview_windowstyles "Window styles" for more information about flags.
control. See also wxNavigationKeyEvent and
HandleAsNavigationKey.
*/
- bool Navigate(int flags = IsForward);
+ bool Navigate(int flags = wxNavigationKeyEvent::IsForward);
/**
Performs a keyboard navigation action inside this window.
See Navigate() for more information.
*/
- bool NavigateIn(int flags = IsForward);
+ bool NavigateIn(int flags = wxNavigationKeyEvent::IsForward);
//@}
/**
Raises the window to the top of the window hierarchy (Z-order).
+ Notice that this function only requests the window manager to raise
+ this window to the top of Z-order. Depending on its configuration, the
+ window manager may raise the window, not do it at all or indicate that
+ a window requested to be raised in some other way, e.g. by flashing its
+ icon if it is minimized.
+
@remarks
This function only works for wxTopLevelWindow-derived classes.
for a top level window if you want to bring it to top, although this is not
needed if Show() is called immediately after the frame creation.
+ Notice that the default state of newly created top level windows is hidden
+ (to allow you to create their contents without flicker) unlike for
+ all the other, not derived from wxTopLevelWindow, windows that
+ are by default created in the shown state.
+
@param show
If @true displays the window. Otherwise, hides it.
Attach a tooltip to the window.
wxToolTip pointer can be @NULL in the overload taking the pointer,
- meaning to unset any existing tooltips, however UnsetToolTip() provides
+ meaning to unset any existing tooltips; however UnsetToolTip() provides
a more readable alternative to this operation.
Notice that these methods are always available, even if wxWidgets was
The parameter @a menu is the menu to show.
The parameter @a pos (or the parameters @a x and @a y) is the
position at which to show the menu in client coordinates.
+ It is recommended to not explicitly specify coordinates when
+ calling this method in response to mouse click, because some of
+ the ports (namely, wxGTK) can do a better job of positioning
+ the menu in that case.
@return
The selected menu item id or @c wxID_NONE if none selected or an
@since 2.9.0
*/
- int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);
+ int GetPopupMenuSelectionFromUser(wxMenu& menu,
+ const wxPoint& pos = wxDefaultPosition);
/**
@overload
window, and returns control when the user has dismissed the menu.
If a menu item is selected, the corresponding menu event is generated and will be
- processed as usually. If the coordinates are not specified, current mouse
+ processed as usual. If coordinates are not specified, the current mouse
cursor position is used.
@a menu is the menu to pop up.
Returns the identifier of the window.
@remarks Each window has an integer identifier. If the application
- has not provided one (or the default wxID_ANY) an unique
+ has not provided one (or the default wxID_ANY) a unique
identifier with a negative value will be generated.
@see SetId(), @ref overview_windowids
/**
Returns true if this window is in process of being destroyed.
- The top level windows are not deleted immediately but are rather
+ Top level windows are not deleted immediately but are rather
scheduled for later destruction to give them time to process any
- pending messages, see Destroy() description.
+ pending messages; see Destroy() description.
This function returns @true if this window, or one of its parent
windows, is scheduled for destruction and can be useful to avoid
/**
- @name Constraints, sizers and window layouting functions
+ @name Constraints, sizers and window layout functions
*/
//@{
/**
- Return the sizer that this window is a member of, if any, otherwise @NULL.
+ Returns the sizer of which this window is a member, if any, otherwise @NULL.
*/
wxSizer* GetContainingSizer() const;
/**
- Return the sizer associated with the window by a previous call to
- SetSizer() or @NULL.
+ Returns the sizer associated with the window by a previous call to
+ SetSizer(), or @NULL.
*/
wxSizer* GetSizer() const;
This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial
window size to the size needed to accommodate all sizer elements and sets the
size hints which, if this window is a top level one, prevent the user from
- resizing it to be less than this minimial size.
+ resizing it to be less than this minimal size.
*/
void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true);
*/
void SetConstraints(wxLayoutConstraints* constraints);
-
/**
Invokes the constraint-based layout algorithm or the sizer-based algorithm
for this window.
*/
void SetAutoLayout(bool autoLayout);
+ bool GetAutoLayout() const;
+
//@}
*/
//@{
+ wxHitTest HitTest(wxCoord x, wxCoord y) const;
+ wxHitTest HitTest(const wxPoint& pt) const;
+
+ /**
+ Get the window border style from the given flags: this is different from
+ simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
+ translate wxBORDER_DEFAULT to something reasonable
+ */
+ wxBorder GetBorder(long flags) const;
+
+ /**
+ Get border for the flags of this window
+ */
+ wxBorder GetBorder() const;
+
+
/**
Does the window-specific updating after processing the update event.
This function is called by UpdateWindowUI() in order to check return
This method should be overridden to return @true if this window has
multiple pages. All standard class with multiple pages such as
wxNotebook, wxListbook and wxTreebook already override it to return @true
- and user-defined classes with similar behaviour should do it as well to
+ and user-defined classes with similar behaviour should also do so, to
allow the library to handle such windows appropriately.
*/
virtual bool HasMultiplePages() const;
*/
virtual bool IsDoubleBuffered() const;
+ void SetDoubleBuffered(bool on);
+
/**
Returns @true if the window is retained, @false otherwise.
*/
virtual void MakeModal(bool modal = true);
+
/**
This virtual function is normally only used internally, but
sometimes an application may need it to implement functionality
The search is recursive in both cases.
@see FindWindow()
+
+ @return Window with the given @a id or @NULL if not found.
*/
static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);
The search is recursive in both cases.
@see FindWindow()
+
+ @return Window with the given @a label or @NULL if not found.
*/
static wxWindow* FindWindowByLabel(const wxString& label,
const wxWindow* parent = 0);
FindWindowByLabel() is called.
@see FindWindow()
+
+ @return Window with the given @a name or @NULL if not found.
*/
static wxWindow* FindWindowByName(const wxString& name,
const wxWindow* parent = 0);
@param count
The number of sequential IDs to reserve.
- @return Returns the ID or the first ID of the range, or wxID_NONE if the
- specified number of identifiers couldn't be allocated.
+ @return Returns the ID or the first ID of the range (i.e. the most negative),
+ or wxID_NONE if the specified number of identifiers couldn't be allocated.
@see UnreserveControlId(), wxIdManager,
@ref overview_windowids
protected:
+ /**
+ Centres the window.
+
+ @param direction
+ Specifies the direction for the centring. May be wxHORIZONTAL,
+ wxVERTICAL or wxBOTH. It may also include the wxCENTRE_ON_SCREEN
+ flag.
+
+ @remarks This function is not meant to be called directly by user code,
+ but via Centre, Center, CentreOnParent, or CenterOnParent.
+ This function can be overridden to fine-tune centring behaviour.
+ */
+ virtual void DoCentre(int direction);
+
/**
Gets the size which best suits the window: for a control, it would be
the minimal size which doesn't truncate the control, for a panel - the
itself.
For convenience, a ProcessWindowEvent() method is provided as a synonym
- for @code GetEventHandler()->ProcessEvent() @endcode.
+ for @code GetEventHandler()->ProcessEvent() @endcode
Note that it's still possible to call these functions directly on the
wxWindow object (e.g. casting it to wxEvtHandler) but doing that will
projects / wxWidgets.git / blobdiff