// Name: window.h
// Purpose: interface of wxWindow
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-/**
- Background styles. See wxWindow::SetBackgroundStyle().
-*/
-enum wxBackgroundStyle
-{
- /// Use the default background, as determined by
- /// the system or the current theme.
- wxBG_STYLE_SYSTEM,
-
- /// Use a solid colour for the background, this style is set automatically if you call
- /// SetBackgroundColour() so you only need to set it explicitly if you had
- /// changed the background style to something else before.
- wxBG_STYLE_COLOUR,
-
- /// Don't draw the background at all, it's supposed that it is drawn by
- /// the user-defined erase background event handler.
- /// This style should be used to avoid flicker when the background is entirely
- /// custom-drawn.
- wxBG_STYLE_CUSTOM,
-
- /// The background is (partially) transparent,this style is automatically set if you call
- /// SetTransparent() which is used to set the transparency level.
- wxBG_STYLE_TRANSPARENT
-};
-
-
/**
Valid values for wxWindow::ShowWithEffect() and wxWindow::HideWithEffect().
*/
enum wxShowEffect
{
+ /**
+ No effect, equivalent to normal wxWindow::Show() or Hide() call.
+
+ @since 2.9.1
+ */
+ wxSHOW_EFFECT_NONE,
+
/// Roll window to the left
wxSHOW_EFFECT_ROLL_TO_LEFT,
wxSHOW_EFFECT_BLEND,
/// Expanding or collapsing effect
- wxSHOW_EFFECT_EXPAND
+ wxSHOW_EFFECT_EXPAND,
+
+ wxSHOW_EFFECT_MAX
+};
+
+
+/**
+ flags for SendSizeEvent()
+*/
+enum
+{
+ wxSEND_EVENT_POST = 1
};
+
+
+
+/**
+ 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.
};
-/**
- Flags which can be used in wxWindow::UpdateWindowUI().
-*/
-enum wxUpdateUI
-{
- wxUPDATE_UI_NONE,
- wxUPDATE_UI_RECURSE,
- wxUPDATE_UI_FROMIDLE /**< Invoked from On(Internal)Idle */
-};
-
-
/**
@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
@beginExtraStyleTable
@style{wxWS_EX_VALIDATE_RECURSIVELY}
- By default, Validate/TransferDataTo/FromWindow() only work on
- direct children of the window (compatible behaviour). Set this flag
- to make them recursively descend into all subwindows.
+ By default, wxWindow::Validate(), wxWindow::TransferDataTo() and
+ wxWindow::TransferDataFromWindow() only work on
+ direct children of the window (compatible behaviour).
+ Set this flag to make them recursively descend into all subwindows.
@style{wxWS_EX_BLOCK_EVENTS}
wxCommandEvents and the objects of the derived classes are
forwarded to the parent window and so on recursively by default.
Using this flag for the given window allows to block this
propagation at this window, i.e. prevent the events from being
propagated further upwards. Dialogs have this flag on by default
- for the reasons explained in the @ref overview_eventhandling "Event Handling Overview".
+ for the reasons explained in the @ref overview_events.
@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
- will send a wxEVT_HELP event if the user clicked on an application window.
+ will send a @c wxEVT_HELP event if the user clicked on an application window.
This style cannot be used (because of the underlying native behaviour)
together with @c wxMAXIMIZE_BOX or @c wxMINIMIZE_BOX, so these two styles
are automatically turned off if this one is used.
@style{wxWS_EX_PROCESS_IDLE}
This window should always process idle events, even if the mode set
- by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.
+ by wxIdleEvent::SetMode is @c wxIDLE_PROCESS_SPECIFIED.
@style{wxWS_EX_PROCESS_UI_UPDATES}
This window should always process UI update events, even if the
- mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED.
+ mode set by wxUpdateUIEvent::SetMode is @c wxUPDATE_UI_PROCESS_SPECIFIED.
@endExtraStyleTable
+ @beginEventEmissionTable
+ @event{EVT_ACTIVATE(id, func)}
+ Process a @c wxEVT_ACTIVATE event. See wxActivateEvent.
+ @event{EVT_CHILD_FOCUS(func)}
+ Process a @c wxEVT_CHILD_FOCUS event. See wxChildFocusEvent.
+ @event{EVT_CONTEXT_MENU(func)}
+ A right click (or other context menu command depending on platform) has been detected.
+ See wxContextMenuEvent.
+ @event{EVT_HELP(id, func)}
+ Process a @c wxEVT_HELP event. See wxHelpEvent.
+ @event{EVT_HELP_RANGE(id1, id2, func)}
+ Process a @c wxEVT_HELP event for a range of ids. See wxHelpEvent.
+ @event{EVT_DROP_FILES(func)}
+ Process a @c wxEVT_DROP_FILES event. See wxDropFilesEvent.
+ @event{EVT_ERASE_BACKGROUND(func)}
+ Process a @c wxEVT_ERASE_BACKGROUND event. See wxEraseEvent.
+ @event{EVT_SET_FOCUS(func)}
+ Process a @c wxEVT_SET_FOCUS event. See wxFocusEvent.
+ @event{EVT_KILL_FOCUS(func)}
+ Process a @c wxEVT_KILL_FOCUS event. See wxFocusEvent.
+ @event{EVT_IDLE(func)}
+ Process a @c wxEVT_IDLE event. See wxIdleEvent.
+ @event{EVT_JOY_*(func)}
+ Processes joystick events. See wxJoystickEvent.
+ @event{EVT_KEY_DOWN(func)}
+ Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
+ 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 a @c wxEVT_MOUSE_CAPTURE_CHANGED event. See wxMouseCaptureChangedEvent.
+ @event{EVT_MOUSE_*(func)}
+ See wxMouseEvent.
+ @event{EVT_PAINT(func)}
+ Process a @c wxEVT_PAINT event. See wxPaintEvent.
+ @event{EVT_POWER_*(func)}
+ The system power state changed. See wxPowerEvent.
+ @event{EVT_SCROLLWIN_*(func)}
+ Process scroll events. See wxScrollWinEvent.
+ @event{EVT_SET_CURSOR(func)}
+ Process a @c wxEVT_SET_CURSOR event. See wxSetCursorEvent.
+ @event{EVT_SIZE(func)}
+ Process a @c wxEVT_SIZE event. See wxSizeEvent.
+ @event{EVT_SYS_COLOUR_CHANGED(func)}
+ Process a @c wxEVT_SYS_COLOUR_CHANGED event. See wxSysColourChangedEvent.
+ @endEventTable
+
@library{wxcore}
@category{miscwnd}
- @see @ref overview_eventhandling "Event handling overview",
- @ref overview_windowsizing "Window sizing overview"
+ @see @ref overview_events, @ref overview_windowsizing
*/
class wxWindow : public wxEvtHandler
{
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
/**
This method may be overridden in the derived classes to return @false to
- indicate that this control doesn't accept input at all (i.e. behaves like
- e.g. wxStaticText) and so doesn't need focus.
+ indicate that this control doesn't accept input at all (i.e.\ behaves like
+ e.g.\ wxStaticText) and so doesn't need focus.
@see AcceptsFocusFromKeyboard()
*/
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.
*/
virtual bool AcceptsFocusRecursively() const;
+
+ /**
+ Can this window itself have focus?
+ */
+ bool IsFocusable() const;
+
+ /**
+ Can this window have focus right now?
+
+ If this method returns true, it means that calling SetFocus() will
+ put focus either to this window or one of its children, if you need
+ to know whether this window accepts focus itself, use IsFocusable()
+ */
+ bool CanAcceptFocus() const;
+
+ /**
+ Can this window be assigned focus from keyboard right now?
+ */
+ bool CanAcceptFocusFromKeyboard() const;
+
/**
Returns @true if the window (or in case of composite controls, its main
child window) has focus.
+ @since 2.9.0
+
@see FindFocus()
*/
virtual bool HasFocus() const;
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
@see GetNextSibling()
*/
wxWindow* GetPrevSibling() const;
+
+ /**
+ Check if the specified window is a descendant of this one.
+
+ Returns @true if the window is a descendant (i.e. a child or
+ grand-child or grand-grand-child or ...) of this one.
+
+ Notice that a window can never be a descendant of another one if they
+ are in different top level windows, i.e. a child of a wxDialog is not
+ considered to be a descendant of dialogs parent wxFrame.
+
+ @param win Any window, possible @NULL (@false is always returned then).
+
+ @since 2.9.4
+ */
+ bool IsDescendant(wxWindowBase* win) 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.
+ Notice that currently you need to explicitly call
+ wxNotebook::RemovePage() before reparenting a notebook page.
+
@param newParent
New parent.
*/
/**
@name Scrolling and scrollbars functions
+
+ Note that these methods don't work with native controls which don't use
+ wxWidgets scrolling framework (i.e. don't derive from wxScrolledWindow).
*/
//@{
/**
Returns the built-in scrollbar position.
- @see See SetScrollbar()
+ @see SetScrollbar()
*/
virtual int GetScrollPos(int orientation) const;
virtual int GetScrollThumb(int orientation) const;
/**
- Returns @true if this window has a scroll bar for this orientation.
+ Returns @true if this window can have a scroll bar in this orientation.
+
+ @param orient
+ Orientation to check, either wxHORIZONTAL or wxVERTICAL.
+
+ @since 2.9.1
+ */
+ bool CanScroll(int orient) const;
+
+ /**
+ Returns @true if this window currently has a scroll bar for this
+ orientation.
+
+ This method may return @false even when CanScroll() for the same
+ orientation returns @true, but if CanScroll() returns @false, i.e.
+ scrolling in this direction is not enabled at all, HasScrollbar()
+ always returns @false as well.
@param orient
Orientation to check, either wxHORIZONTAL or wxVERTICAL.
/**
@name Sizing functions
- See also the protected functions DoGetBestSize() and SetInitialBestSize().
+ See also the protected functions DoGetBestSize() and
+ DoGetBestClientSize().
*/
//@{
+ /**
+ Helper for ensuring EndRepositioningChildren() is called correctly.
+
+ This class wraps the calls to BeginRepositioningChildren() and
+ EndRepositioningChildren() by performing the former in its constructor
+ and the latter in its destructor if, and only if, the first call
+ returned @true. This is the simplest way to call these methods and if
+ this class is created as a local variable, it also ensures that
+ EndRepositioningChildren() is correctly called (or not) on scope exit,
+ so its use instead of calling these methods manually is highly
+ recommended.
+
+ @since 2.9.5
+ */
+ class ChildrenRepositioningGuard
+ {
+ public:
+ /**
+ Constructor calls wxWindow::BeginRepositioningChildren().
+
+ @param win The window to call BeginRepositioningChildren() on. If
+ it is @NULL, nothing is done.
+ */
+ explicit ChildrenRepositioningGuard(wxWindow* win);
+
+ /**
+ Destructor calls wxWindow::EndRepositioningChildren() if necessary.
+
+ EndRepositioningChildren() is called only if a valid window was
+ passed to the constructor and if BeginRepositioningChildren()
+ returned @true.
+ */
+ ~ChildrenRepositioningGuard();
+ };
+
+ /**
+ Prepare for changing positions of multiple child windows.
+
+ This method should be called before changing positions of multiple
+ child windows to reduce flicker and, in MSW case, even avoid display
+ corruption in some cases. It is used internally by wxWidgets and called
+ automatically when the window size changes but it can also be useful to
+ call it from outside of the library if a repositioning involving
+ multiple children is done without changing the window size.
+
+ If this method returns @true, then EndRepositioningChildren() must be
+ called after setting all children positions. Use
+ ChildrenRepositioningGuard class to ensure that this requirement is
+ satisfied.
+
+ @since 2.9.5
+ */
+ bool BeginRepositioningChildren();
+
+ /**
+ Fix child window positions after setting all of them at once.
+
+ This method must be called if and only if the previous call to
+ BeginRepositioningChildren() returned @true.
+
+ @since 2.9.5
+ */
+ void EndRepositioningChildren();
+
/**
Sets the cached best size value.
+
+ @see GetBestSize()
*/
void CacheBestSize(const wxSize& size) const;
control label is not truncated. For windows containing subwindows (typically
wxPanel), the size returned by this function will be the same as the size
the window would have had after calling Fit().
+
+ Override virtual DoGetBestSize() or, better, because it's usually more
+ convenient, DoGetBestClientSize() when writing your own custom window
+ class to change the value returned by this public non-virtual method.
+
+ Notice that the best size respects the minimal and maximal size
+ explicitly set for the window, if any. So even if some window believes
+ that it needs 200 pixels horizontally, calling SetMaxSize() with a
+ width of 100 would ensure that GetBestSize() returns the width of at
+ most 100 pixels.
+
+ @see CacheBestSize(), @ref overview_windowsizing
*/
wxSize GetBestSize() const;
+ /**
+ Returns the best height needed by this window if it had the given width.
+
+ @see DoGetBestClientHeight()
+
+ @since 2.9.4
+ */
+ int GetBestHeight(int width) const;
+
+ /**
+ Returns the best width needed by this window if it had the given height.
+
+ @see DoGetBestClientWidth()
+
+ @since 2.9.4
+ */
+ int GetBestWidth(int height) const;
+
/**
Returns the size of the window 'client area' in pixels.
Note that if this window is a top-level one and it is currently minimized, the
return size is empty (both width and height are 0).
+ @beginWxPerlOnly
+ In wxPerl this method takes no parameters and returns
+ a 2-element list (width, height).
+ @endWxPerlOnly
+
@see GetSize(), GetVirtualSize()
*/
void GetClientSize(int* width, int* height) const;
/**
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 a wxSizer when it queries the size
+ of a window or control.
@see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
*/
- wxSize GetEffectiveMinSize() const;
+ virtual wxSize GetEffectiveMinSize() const;
/**
Returns the maximum size of window's client area.
possible size as well as the upper bound on window's size settable using
SetClientSize().
- @see GetMaxSize()
+ @see GetMaxSize(), @ref overview_windowsizing
*/
virtual wxSize GetMaxClientSize() const;
This is an indication to the sizer layout mechanism that this is the maximum
possible size as well as the upper bound on window's size settable using SetSize().
- @see GetMaxClientSize()
+ @see GetMaxClientSize(), @ref overview_windowsizing
*/
virtual wxSize GetMaxSize() const;
It normally just returns the value set by SetMinClientSize(), but it can be
overridden to do the calculation on demand.
- @see GetMinSize()
+ @see GetMinSize(), @ref overview_windowsizing
*/
virtual wxSize GetMinClientSize() const;
This method normally just returns the value set by SetMinSize(), but it
can be overridden to do the calculation on demand.
- @see GetMinClientSize()
+ @see GetMinClientSize(), @ref overview_windowsizing
*/
virtual wxSize GetMinSize() const;
+ /**
+ Returns the horizontal component of window minimal size.
+
+ The returned value is wxDefaultCoord if the minimal width was not set.
+
+ @see GetMinSize()
+ */
+ int GetMinWidth() const;
+
+ /**
+ Returns the vertical component of window minimal size.
+
+ The returned value is wxDefaultCoord if the minimal height was not set.
+
+ @see GetMinSize()
+ */
+ int GetMinHeight() const;
+
+ /**
+ Returns the horizontal component of window maximal size.
+
+ The returned value is wxDefaultCoord if the maximal width was not set.
+
+ @see GetMaxSize()
+ */
+ int GetMaxWidth() const;
+
+ /**
+ Returns the vertical component of window maximal size.
+
+ The returned value is wxDefaultCoord if the maximal width was not set.
+
+ @see GetMaxSize()
+ */
+ int GetMaxHeight() const;
+
/**
Returns the size of the entire window in pixels, including title bar, border,
scrollbars, etc.
@param height
Receives the window height.
- @see GetClientSize(), GetVirtualSize()
+ @beginWxPerlOnly
+ In wxPerl this method is implemented as GetSizeWH() returning
+ a 2-element list (width, height).
+ @endWxPerlOnly
+
+ @see GetClientSize(), GetVirtualSize(), @ref overview_windowsizing
*/
void GetSize(int* width, int* height) const;
This gets the virtual size of the window in pixels.
By default it returns the client size of the window, but after a call to
SetVirtualSize() it will return the size set with that method.
+
+ @see @ref overview_windowsizing
*/
wxSize GetVirtualSize() const;
*/
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 magnification of the backing store of this window, eg 2.0
+ for a window on a retina screen.
+
+ @since 2.9.5
+ */
+ virtual double GetContentScaleFactor() 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 CacheBestSize()
*/
void InvalidateBestSize();
+
/**
Posts a size event to the window.
than SetSize(), since the application need not worry about what dimensions
the border or title bar have when trying to fit the window around panel
items, for example.
+
+ @see @ref overview_windowsizing
+ */
+ void SetClientSize(int width, int height);
+
+ /**
+ @overload
*/
- virtual void SetClientSize(int width, int height);
+ void SetClientSize(const wxSize& size);
/**
@overload
*/
- virtual void SetClientSize(const wxSize& size);
+ void SetClientSize(const wxRect& rect);
/**
This normally does not need to be called by user code.
Sets the maximum client size of the window, to indicate to the sizer
layout mechanism that this is the maximum possible size of its client area.
- @see SetMaxSize()
+ Note that this method is just a shortcut for:
+ @code
+ SetMaxSize(ClientToWindowSize(size));
+ @endcode
+
+ @see SetMaxSize(), @ref overview_windowsizing
*/
virtual void SetMaxClientSize(const wxSize& size);
Sets the maximum size of the window, to indicate to the sizer layout mechanism
that this is the maximum possible size.
- @see SetMaxClientSize()
+ @see SetMaxClientSize(), @ref overview_windowsizing
*/
virtual void SetMaxSize(const wxSize& size);
prevent the program from explicitly making the window smaller than the
specified size.
- @see SetMinSize()
+ Note that this method is just a shortcut for:
+ @code
+ SetMinSize(ClientToWindowSize(size));
+ @endcode
+
+ @see SetMinSize(), @ref overview_windowsizing
*/
virtual void SetMinClientSize(const wxSize& size);
SetSize(), it just ensures that it won't become smaller than this size
during the automatic layout.
- @see SetMinClientSize()
+ @see SetMinClientSize(), @ref overview_windowsizing
*/
virtual void SetMinSize(const wxSize& size);
should be supplied by wxWidgets, or that the current value of the
dimension should be used.
- @see Move()
+ @see Move(), @ref overview_windowsizing
*/
void SetSize(int x, int y, int width, int height,
int sizeFlags = wxSIZE_AUTO);
@remarks This form must be used with non-default width and height values.
- @see Move()
+ @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
(such as wxDialog or wxFrame) is discouraged.
Please use SetMinSize() and SetMaxSize() instead.
- @see wxTopLevelWindow::SetSizeHints
+ @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.
+
+ @see @ref overview_windowsizing
*/
void SetVirtualSize(int width, int height);
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.
@param y
Receives the y position of the window if non-@NULL.
+ @beginWxPerlOnly
+ In wxPerl this method is implemented as GetPositionXY() returning
+ a 2-element list (x, y).
+ @endWxPerlOnly
+
@see GetScreenPosition()
*/
void GetPosition(int* x, int* y) const;
*/
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);
+
//@}
A pointer to a integer value for the y coordinate. Pass the client
coordinate in, and a screen coordinate will be passed out.
- @beginWxPythonOnly
- In place of a single overloaded method name, wxPython implements the following methods:
- - ClientToScreen(point): Accepts and returns a wxPoint
- - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method returns a 2-element list instead of
+ modifying its parameters.
+ @endWxPerlOnly
*/
void ClientToScreen(int* x, int* y) const;
@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 background style of the window.
- The background style can be one of the wxBackgroundStyle.
@see SetBackgroundColour(), GetForegroundColour(),
SetBackgroundStyle(), SetTransparent()
*/
virtual wxBackgroundStyle GetBackgroundStyle() const;
+
/**
Returns the character height for this window.
*/
/**
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.
Return value for external leading (optional).
@param font
Font to use instead of the current window font (optional).
+
+ @beginWxPerlOnly
+ In wxPerl this method takes only the @a string and optionally
+ @a font parameters, and returns a 4-element list
+ (x, y, descent, externalLeading).
+ @endWxPerlOnly
*/
- virtual void GetTextExtent(const wxString& string, int* w, int* h,
- int* descent = NULL,
- int* externalLeading = NULL,
- const wxFont* font = NULL) const;
+ void GetTextExtent(const wxString& string,
+ int* w, int* h,
+ int* descent = NULL,
+ int* externalLeading = NULL,
+ const wxFont* font = NULL) const;
/**
Gets the dimensions of the string as it would be drawn on the
*/
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
/**
Sets the background colour of the window.
+
+ Notice that as with SetForegroundColour(), setting the background
+ colour of a native control may not affect the entire control and could
+ be not supported at all depending on the control and platform.
+
Please see InheritAttributes() for explanation of the difference between
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
usually the themes represent the appearance chosen by the user
to be used for all applications on the system.
+ @return @true if the colour was really changed, @false if it was already set
+ to this colour and nothing was done.
+
@see GetBackgroundColour(), SetForegroundColour(),
GetForegroundColour(), ClearBackground(),
- Refresh(), wxEraseEvent
+ Refresh(), wxEraseEvent, wxSystemSettings
*/
virtual bool SetBackgroundColour(const wxColour& colour);
/**
- Sets the background style of the window. see GetBackgroundStyle() for
- the description of the possible style values.
+ Sets the background style of the window.
+
+ 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 @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
+ @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
+ @c EVT_ERASE_BACKGROUND handler. Setting background style to
+ @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
+ problem.
+
+
+ Under wxGTK and wxOSX, you can use ::wxBG_STYLE_TRANSPARENT to obtain
+ full transparency of the window background. Note that wxGTK supports
+ this only since GTK 2.12 with a compositing manager enabled, call
+ IsTransparentBackgroundSupported() to check whether this is the case.
+
+ Also, on order for @c SetBackgroundStyle(wxBG_STYLE_TRANSPARENT) to
+ work, it must be called before Create(). If you're using your own
+ wxWindow-derived class you should write your code in the following way:
+ @code
+ class MyWidget : public wxWindow
+ {
+ public:
+ MyWidget(wxWindow* parent, ...)
+ : wxWindow() // Use default ctor here!
+ {
+ // Do this first:
+ SetBackgroundStyle(wxBG_STYLE_TRANSPARENT);
+
+ // And really create the window afterwards:
+ Create(parent, ...);
+ }
+ };
+ @endcode
@see SetBackgroundColour(), GetForegroundColour(),
- SetTransparent()
+ SetTransparent(), IsTransparentBackgroundSupported()
*/
virtual bool SetBackgroundStyle(wxBackgroundStyle style);
+ /**
+ Checks whether using transparent background might work.
+
+ If this function returns @false, calling SetBackgroundStyle() with
+ ::wxBG_STYLE_TRANSPARENT is not going to work. If it returns @true,
+ setting transparent style should normally succeed.
+
+ Notice that this function would typically be called on the parent of a
+ window you want to set transparent background style for as the window
+ for which this method is called must be fully created.
+
+ @param reason
+ If not @NULL, a reason message is provided if transparency is not
+ supported.
+
+ @return @true if background transparency is supported.
+
+ @since 2.9.4
+ */
+ virtual bool IsTransparentBackgroundSupported(wxString *reason = NULL) const;
+
/**
Sets the font for this window. This function should not be called for the
parent window if you don't want its font to be inherited by its children,
Font to associate with this window, pass
wxNullFont to reset to the default font.
- @return @true if the want was really changed, @false if it was already set
- to this font and so nothing was done.
+ @return @true if the font was really changed, @false if it was already set
+ to this font and nothing was done.
@see GetFont(), InheritAttributes()
*/
/**
Sets the foreground colour of the window.
+
+ 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. Additionally, not all native controls support changing their
+ foreground colour so this method may change their colour only partially
+ or even not at all.
+
Please see InheritAttributes() for explanation of the difference between
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.
+ @return @true if the colour was really changed, @false if it was already set
+ to this colour and nothing was done.
@see GetForegroundColour(), SetBackgroundColour(),
GetBackgroundColour(), ShouldInheritColours()
*/
void SetOwnBackgroundColour(const wxColour& colour);
+ /**
+ Return @true if this window inherits the background colour from its parent.
+
+ @see SetOwnBackgroundColour(), InheritAttributes()
+ */
+ bool InheritsBackgroundColour() const;
+
+ /**
+ Return @true if a background colour has been set for this window.
+ */
+ bool UseBgCol() const;
+
/**
Sets the font of the window but prevents it from being inherited by the
children of this window.
/**
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
/**
@name Event-handling functions
+
+ wxWindow allows you to build a (sort of) stack of event handlers which
+ can be used to override the window's own event handling.
*/
//@{
wxEvtHandler* GetEventHandler() const;
/**
- This function will generate the appropriate call to
- Navigate() if the key event is one normally used for
- keyboard navigation and return @true in this case.
+ This function will generate the appropriate call to Navigate() if the key
+ event is one normally used for keyboard navigation and return @true in this case.
@return Returns @true if the key pressed was for navigation and was
handled, @false otherwise.
@code
GetEventHandler()->SafelyProcessEvent(event);
@endcode
+
+ @see ProcessWindowEvent()
*/
bool HandleWindowEvent(wxEvent& event) const;
+ /**
+ Convenient wrapper for ProcessEvent().
+
+ 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.
+ */
+ 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.
+ E.g. in the case of:
+ @image html overview_events_winstack.png
+ when calling @c W->PopEventHandler(), the event handler @c A will be
+ removed and @c B will be the first handler of the stack.
+
+ Note that it's an error to call this function when no event handlers
+ were pushed on this window (i.e. when the window itself is its only
+ event handler).
+
@param deleteHandler
- If this is @true, the handler will be deleted after it is removed.
- The default value is @false.
+ If this is @true, the handler will be deleted after it is removed
+ (and the returned value will be @NULL).
- @see SetEventHandler(), GetEventHandler(),
- PushEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
+ @see @ref overview_events_processing
*/
wxEvtHandler* PopEventHandler(bool deleteHandler = false);
/**
Pushes this event handler onto the event stack for the window.
+ An event handler is an object that is capable of processing the events sent
+ to a window. By default, the window is its own event handler, but an application
+ may wish to substitute another, for example to allow central implementation
+ of event-handling for a variety of different window classes.
+
+ wxWindow::PushEventHandler allows an application to set up a @e stack
+ of event handlers, where an event not handled by one event handler is
+ handed to the next one in the chain.
+
+ E.g. if you have two event handlers @c A and @c B and a wxWindow instance
+ @c W and you call:
+ @code
+ W->PushEventHandler(A);
+ W->PushEventHandler(B);
+ @endcode
+ you will end up with the following situation:
+ @image html overview_events_winstack.png
+
+ Note that you can use wxWindow::PopEventHandler to remove the event handler.
+
@param handler
Specifies the handler to be pushed.
+ It must not be part of a wxEvtHandler chain; an assert will fail
+ if it's not unlinked (see wxEvtHandler::IsUnlinked).
- @remarks An event handler is an object that is capable of processing the
- events sent to a window. By default, the window is its
- own event handler, but an application may wish to
- substitute another, for example to allow central
- implementation of event-handling for a variety of
- different window classes.
- wxWindow::PushEventHandler allows an application to set up a
- chain of event handlers, where an event not handled by one event
- handler is handed to the next one in the chain.
- Use wxWindow::PopEventHandler to remove the event handler.
-
- @see SetEventHandler(), GetEventHandler(),
- PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
+ @see @ref overview_events_processing
*/
void PushEventHandler(wxEvtHandler* handler);
/**
- Find the given @a handler in the windows event handler chain and remove
- (but not delete) it from it.
+ Find the given @a handler in the windows event handler stack and
+ removes (but does not delete) it from the stack.
+
+ See wxEvtHandler::Unlink() for more info.
@param handler
The event handler to remove, must be non-@NULL and
- must be present in this windows event handlers chain
+ must be present in this windows event handlers stack.
@return Returns @true if it was found and @false otherwise (this also
results in an assert failure so this function should
/**
Sets the event handler for this window.
+ Note that if you use this function you may want to use as the "next" handler
+ of @a handler the window itself; in this way when @a handler doesn't process
+ an event, the window itself will have a chance to do it.
+
@param handler
- Specifies the handler to be set.
-
- @remarks An event handler is an object that is capable of processing the
- events sent to a window. By default, the window is its
- own event handler, but an application may wish to
- substitute another, for example to allow central
- implementation of event-handling for a variety of
- different window classes.
- It is usually better to use wxWindow::PushEventHandler since
- this sets up a chain of event handlers, where an event not
- handled by one event handler is handed to the next one in the chain.
-
- @see GetEventHandler(), PushEventHandler(),
- PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
+ Specifies the handler to be set. Cannot be @NULL.
+
+ @see @ref overview_events_processing
*/
void SetEventHandler(wxEvtHandler* handler);
+ /**
+ wxWindows cannot be used to form event handler chains; this function
+ thus will assert when called.
+
+ Note that instead you can use PushEventHandler() or SetEventHandler() to
+ implement a stack of event handlers to override wxWindow's own
+ event handling mechanism.
+ */
+ virtual void SetNextHandler(wxEvtHandler* handler);
+
+ /**
+ wxWindows cannot be used to form event handler chains; this function
+ thus will assert when called.
+
+ Note that instead you can use PushEventHandler() or SetEventHandler() to
+ implement a stack of event handlers to override wxWindow's own
+ event handling mechanism.
+ */
+ virtual void SetPreviousHandler(wxEvtHandler* handler);
+
//@}
+
/**
@name Window styles functions
*/
/**
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.
virtual bool HideWithEffect(wxShowEffect effect,
unsigned int timeout = 0);
/**
- Returns @true if the window is enabled, i.e. if it accepts user input,
+ Returns @true if the window is enabled, i.e.\ if it accepts user input,
@false otherwise.
Notice that this method can return @false even if this window itself hadn't
virtual bool IsShown() const;
/**
- Returns @true if the window is physically visible on the screen, i.e. it
+ Returns @true if the window is physically visible on the screen, i.e.\ it
is shown and all its parents up to the toplevel window are shown as well.
@see IsShown()
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.
milliseconds. If the default value of 0 is used, the default
animation time for the current platform is used.
- @note Currently this function is only implemented in wxMSW and does the
- same thing as Show() in the other ports.
+ @note Currently this function is only implemented in wxMSW and wxOSX
+ (for wxTopLevelWindows only in Carbon version and for any kind of
+ windows in Cocoa) and does the same thing as Show() in the other
+ ports.
@since 2.9.0
*/
wxToolTip* GetToolTip() const;
+ /**
+ Get the text of the associated tooltip or empty string if none.
+ */
+ wxString GetToolTipText() const;
+
/**
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
@see GetToolTip(), wxToolTip
*/
- void SetToolTip(const wxString& tip);
+ void SetToolTip(const wxString& tipString);
/**
@overload
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
*/
virtual wxString GetLabel() const;
+ /**
+ Returns the layout direction for this window,
+ Note that @c wxLayout_Default is returned if layout direction is not supported.
+ */
+ virtual wxLayoutDirection GetLayoutDirection() const;
+
+ /**
+ Mirror coordinates for RTL layout if this window uses it and if the
+ mirroring is not done automatically like Win32.
+ */
+ virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+ wxCoord width,
+ wxCoord widthTotal) const;
+
/**
Returns the window's name.
*/
virtual void SetLabel(const wxString& label);
+ /**
+ Sets the layout direction for this window.
+ */
+ virtual void SetLayoutDirection(wxLayoutDirection dir);
+
/**
Sets the window's name.
*/
void SetWindowVariant(wxWindowVariant variant);
-
/**
Gets the accelerator table for this window. See wxAcceleratorTable.
*/
@false if the window's close handler should be able to veto the destruction
of this window, @true if it cannot.
+ @return @true if the event was handled and not vetoed, @false otherwise.
+
@remarks Close calls the close handler for the window, providing an
opportunity for the window to choose whether to destroy
the window. Usually it is only used with the top level
/**
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;
/**
Sets the window to have the given layout sizer.
+
The window will then own the object, and will take care of its deletion.
If an existing layout constraints object is already owned by the
- window, it will be deleted if the deleteOld parameter is @true.
+ window, it will be deleted if the @a deleteOld parameter is @true.
Note that this function will also call SetAutoLayout() implicitly with @true
- parameter if the @a sizer is non-@NULL and @false otherwise.
+ parameter if the @a sizer is non-@NULL and @false otherwise so that the
+ sizer will be effectively used to layout the window children whenever
+ it is resized.
@param sizer
The sizer to set. Pass @NULL to disassociate and conditionally delete
the window's sizer. See below.
@param deleteOld
If @true (the default), this will delete any pre-existing sizer.
- Pass @false if you wish to handle deleting the old sizer yourself.
+ Pass @false if you wish to handle deleting the old sizer yourself
+ but remember to do it yourself in this case to avoid memory leaks.
@remarks SetSizer enables and disables Layout automatically.
*/
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.
/**
Determines whether the Layout() function will be called automatically
- when the window is resized. Please note that this only happens for the
- windows usually used to contain children, namely wxPanel and wxTopLevelWindow
- (and the classes deriving from them).
+ when the window is resized.
This method is called implicitly by SetSizer() but if you use SetConstraints()
you should call it manually or otherwise the window layout won't be correctly
updated when its size changes.
@param autoLayout
- Set this to @true if you wish the Layout() function to be
- called automatically when the window is resized
- (really happens only if you derive from wxPanel or wxTopLevelWindow).
+ Set this to @true if you wish the Layout() function to be called
+ automatically when the window is resized.
- @see SetConstraints()
+ @see SetSizer(), SetConstraints()
*/
void SetAutoLayout(bool autoLayout);
+ bool GetAutoLayout() const;
+
//@}
/**
Moves the pointer to the given position on the window.
- @note This function is not supported under Mac because Apple Human
- Interface Guidelines forbid moving the mouse cursor programmatically.
+ @note Apple Human Interface Guidelines forbid moving the mouse cursor
+ programmatically so you should avoid using this function in Mac
+ applications (and probably avoid using it under the other
+ platforms without good reason as well).
@param x
The new x position for the cursor.
*/
//@{
+ 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
/**
Returns the platform-specific handle of the physical window.
Cast it to an appropriate handle, such as @b HWND for Windows,
- @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS.
+ @b Widget for Motif or @b GtkWidget for GTK.
+
+ @beginWxPerlOnly
+ This method will return an integer in wxPerl.
+ @endWxPerlOnly
*/
virtual WXWidget GetHandle() const;
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 void InitDialog();
/**
- Returns @true if the window contents is double-buffered by the system, i.e. if
+ Returns @true if the window contents is double-buffered by the system, i.e.\ if
any drawing done on the window is really done on a temporary backing surface
and transferred to the screen all at once later.
*/
virtual bool IsDoubleBuffered() const;
+ /**
+ Turn on or off double buffering of the window if the system supports it.
+ */
+ void SetDoubleBuffered(bool on);
+
/**
Returns @true if the window is retained, @false otherwise.
/**
Returns @true if this window is intrinsically enabled, @false otherwise,
- i.e. if @ref Enable() Enable(@false) had been called. This method is
+ i.e.\ if @ref Enable() Enable(@false) had been called. This method is
mostly used for wxWidgets itself, user code should normally use
IsEnabled() instead.
*/
*/
virtual bool IsTopLevel() const;
- /**
- Disables all other windows in the application so that
- the user can only interact with this window.
-
- @param modal
- If @true, this call disables all other windows in the application so that
- the user can only interact with this window. If @false, the effect is
- reversed.
- */
- virtual void MakeModal(bool modal = true);
-
+
/**
This virtual function is normally only used internally, but
sometimes an application may need it to implement functionality
*/
virtual void OnInternalIdle();
+ /**
+ Send idle event to window and all subwindows. Returns true if more idle
+ time is requested.
+ */
+ virtual bool SendIdleEvents(wxIdleEvent& event);
+
/**
Registers a system wide hotkey. Every time the user presses the hotkey
registered here, this window will receive a hotkey event.
are concerned). This may be necessary if you have called
wxUpdateUIEvent::SetMode() or wxUpdateUIEvent::SetUpdateInterval() to limit
the overhead that wxWidgets incurs by sending update UI events in idle time.
- @a flags should be a bitlist of one or more of the wxUpdateUI enumeration.
+ @a flags should be a bitlist of one or more of the ::wxUpdateUI enumeration.
If you are calling this function from an OnInternalIdle or OnIdle
function, make sure you pass the wxUPDATE_UI_FROMIDLE flag, since
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:
/**
- 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
- same size as it would have after a call to Fit().
+ 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);
+
+ /**
+ Implementation of GetBestSize() that can be overridden.
+
+ Notice that it is usually more convenient to override
+ DoGetBestClientSize() rather than this method itself as you need to
+ explicitly account for the window borders size if you do the latter.
The default implementation of this function is designed for use in container
windows, such as wxPanel, and works something like this:
*/
virtual wxSize DoGetBestSize() const;
+ /**
+ Override this method to return the best size for a custom control.
+
+ A typical implementation of this method should compute the minimal size
+ needed to fully display the control contents taking into account the
+ current font size.
+
+ The default implementation simply returns ::wxDefaultSize and
+ GetBestSize() returns an arbitrary hardcoded size for the window, so
+ you must override it when implementing a custom window class.
+
+ Notice that the best size returned by this function is cached
+ internally, so if anything that results in the best size changing (e.g.
+ change to the control contents) happens, you need to call
+ InvalidateBestSize() to notify wxWidgets about it.
+
+ @see @ref overview_windowsizing
+
+ @since 2.9.0
+ */
+ virtual wxSize DoGetBestClientSize() const;
+
+ /**
+ Override this method to implement height-for-width best size
+ calculation.
+
+ Return the height needed to fully display the control contents if its
+ width is fixed to the given value. Custom classes implementing
+ wrapping should override this method and return the height
+ corresponding to the number of lines needed to lay out the control
+ contents at this width.
+
+ Currently this method is not used by wxWidgets yet, however it is
+ planned that it will be used by the new sizer classes implementing
+ height-for-width layout strategy in the future.
+
+ Notice that implementing this method or even implementing both it and
+ DoGetBestClientWidth() doesn't replace overriding DoGetBestClientSize(),
+ i.e. you still need to implement the latter as well in order to provide
+ the best size when neither width nor height are constrained.
+
+ By default returns ::wxDefaultCoord meaning that the vertical component
+ of DoGetBestClientSize() return value should be used.
+
+ @since 2.9.4
+ */
+ virtual int DoGetBestClientHeight(int width) const;
+
+ /**
+ Override this method to implement width-for-height best size
+ calculation.
+
+ This method is exactly the same as DoGetBestClientHeight() except that
+ it determines the width assuming the height is fixed instead of vice
+ versa.
+
+ @since 2.9.4
+ */
+ virtual int DoGetBestClientWidth(int height) const;
/**
- Sets the initial window size if none is given (i.e. at least one of the
+ Sets the initial window size if none is given (i.e.\ at least one of the
components of the size passed to ctor/Create() is wxDefaultCoord).
- @deprecated @todo provide deprecation description
+ @deprecated Use SetInitialSize() instead.
*/
virtual void SetInitialBestSize(const wxSize& size);
explanations of when you might want to do it.
*/
void SendDestroyEvent();
+
+ /**
+ This function is public in wxEvtHandler but protected in wxWindow
+ because for wxWindows you should always call ProcessEvent() on the
+ pointer returned by GetEventHandler() and not on the wxWindow object
+ itself.
+
+ For convenience, a ProcessWindowEvent() method is provided as a synonym
+ 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
+ create subtle bugs when windows with event handlers pushed on them are
+ involved.
+
+ This holds also for all other wxEvtHandler functions.
+ */
+ virtual bool ProcessEvent(wxEvent& event);
+
+ //@{
+ /**
+ See ProcessEvent() for more info about why you shouldn't use this function
+ and the reason for making this function protected in wxWindow.
+ */
+ bool SafelyProcessEvent(wxEvent& event);
+ virtual void QueueEvent(wxEvent *event);
+ virtual void AddPendingEvent(const wxEvent& event);
+ void ProcessPendingEvents();
+ bool ProcessThreadEvent(const wxEvent& event);
+ //@}
};
projects / wxWidgets.git / blobdiff