/////////////////////////////////////////////////////////////////////////////
-/**
- 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().
*/
};
-/**
- 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
@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
@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).
+ @event{EVT_CHAR(func)}
+ Process a @c wxEVT_CHAR 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_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)}
+ 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
{
/**
@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;
/**
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().
+
+ Note that when you write your own widget you need to overload the
+ DoGetBestSize() function instead of this (non-virtual!) function.
+
+ @see CacheBestSize(), @ref overview_windowsizing
*/
wxSize GetBestSize() const;
This is the value used by sizers to determine the appropriate
ammount 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.
+
@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;
@param height
Receives the window height.
- @see GetClientSize(), GetVirtualSize()
+ @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;
/**
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
*/
virtual void SetClientSize(int width, int height);
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);
(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,
/**
Sets the virtual size of the window in pixels.
+
+ @see @ref overview_windowsizing
*/
void SetVirtualSize(int width, int height);
/**
@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);
+
/**
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
*/
*/
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;
+
/**
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.
*/
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
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