/**
Returns @true if the Alt key was down at the time of the key event.
-
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
/**
Returns @true if the control key was down at the time of the key event.
-
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
while non-ASCII events return values such as @b WXK_LEFT for the
left cursor key. See Keycodes for a full list of
the virtual key codes.
-
Note that in Unicode build, the returned value is meaningful only if the
user entered a character that can be represented in current locale's default
charset. You can obtain the corresponding Unicode character using
happened. See @ref overview_keymodifiers "key modifier constants" for the full
list
of modifiers.
-
Notice that this function is easier to use correctly than, for example,
ControlDown() because when using the latter you
also have to remember to test that none of the other modifiers is pressed:
+
and forgetting to do it can result in serious program bugs (e.g. program not
working with European keyboard layout where ALTGR key which is seen by
the program as combination of CTRL and ALT is used). On the
other hand, you can simply write
+
with this function.
*/
int GetModifiers();
Obtains the position (in client coordinates) at which the key was pressed.
*/
wxPoint GetPosition();
- void GetPosition(long * x, long * y);
+ void GetPosition(long* x, long* y);
//@}
/**
Returns the raw key code for this event. This is a platform-dependent scan code
which should only be used in advanced applications.
-
@b NB: Currently the raw key codes are not supported by all ports, use
@c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
/**
Returns the low level key flags for this event. The flags are
platform-dependent and should only be used in advanced applications.
-
@b NB: Currently the raw key flags are not supported by all ports, use
@c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
/**
Returns the Unicode character corresponding to this key event.
-
This function is only available in Unicode build, i.e. when
@c wxUSE_UNICODE is 1.
*/
/**
Returns the X position (in client coordinates) of the event.
*/
-#define long GetX() /* implementation is private */
+ long GetX();
/**
Returns the Y (in client coordinates) position of the event.
*/
-#define long GetY() /* implementation is private */
+ long GetY();
/**
Returns @true if either CTRL or ALT keys was down
/**
Returns @true if the Meta key was down at the time of the key event.
-
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
/**
Returns @true if the shift key was down at the time of the key event.
-
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
/**
bool m_altDown
-
@b Deprecated: Please use GetModifiers()
instead!
-
@true if the Alt key is pressed down.
*/
/**
bool m_controlDown
-
@b Deprecated: Please use GetModifiers()
instead!
-
@true if control is pressed down.
*/
/**
long m_keyCode
-
@b Deprecated: Please use GetKeyCode()
instead!
-
Virtual keycode. See Keycodes for a list of identifiers.
*/
/**
bool m_metaDown
-
@b Deprecated: Please use GetModifiers()
instead!
-
@true if the Meta key is pressed down.
*/
/**
bool m_shiftDown
-
@b Deprecated: Please use GetModifiers()
instead!
-
@true if shift is pressed down.
*/
/**
int m_x
-
@b Deprecated: Please use GetX() instead!
-
X position of the event.
*/
/**
int m_y
-
@b Deprecated: Please use GetY() instead!
-
Y position of the event.
*/
};
button).
@param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
+ Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
bool ButtonDown(int button = wxJOY_BUTTON_ANY);
Returns @true if the specified button (or any button) was in a down state.
@param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
+ Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
bool ButtonIsDown(int button = wxJOY_BUTTON_ANY);
button).
@param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
+ Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
bool ButtonUp(int button = wxJOY_BUTTON_ANY);
@category{events}
@seealso
- wxScrollEvent, @ref overview_eventhandlingoverview "Event handling overview"
+ wxScrollEvent, @ref overview_eventhandlingoverview
*/
class wxScrollWinEvent : public wxEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxSysColourChangedEvent : public wxEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxWindowDestroyEvent
+ @ref overview_eventhandlingoverview, wxWindowDestroyEvent
*/
class wxWindowCreateEvent : public wxCommandEvent
{
/**
Constructor.
*/
- wxWindowCreateEvent(wxWindow* win = @NULL);
+ wxWindowCreateEvent(wxWindow* win = NULL);
};
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxPaintEvent : public wxEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxTopLevelWindow::Maximize, wxTopLevelWindow::IsMaximized
+ @ref overview_eventhandlingoverview, wxTopLevelWindow::Maximize,
+ wxTopLevelWindow::IsMaximized
*/
class wxMaximizeEvent : public wxEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxUpdateUIEvent : public wxCommandEvent
{
/**
Returns @true if it is appropriate to update (send UI update events to)
this window.
-
This function looks at the mode used (see wxUpdateUIEvent::SetMode),
the wxWS_EX_PROCESS_UI_UPDATES flag in @e window,
the time update events were last sent in idle time, and
often as possible. You can reduce the frequency that events
are sent by changing the mode and/or setting an update interval.
- @sa ResetUpdateTime(), SetUpdateInterval(),
- SetMode()
+ @see ResetUpdateTime(), SetUpdateInterval(),
+ SetMode()
*/
static bool CanUpdate(wxWindow* window);
will send update events: to all windows, or only to those which specify that
they
will process the events.
-
See SetMode().
*/
static wxUpdateUIMode GetMode();
/**
Returns the current interval between updates in milliseconds.
-1 disables updates, 0 updates as frequently as possible.
-
See SetUpdateInterval().
*/
static long GetUpdateInterval();
normally sent in idle time, so this is called at the end of
idle processing.
- @sa CanUpdate(), SetUpdateInterval(),
- SetMode()
+ @see CanUpdate(), SetUpdateInterval(),
+ SetMode()
*/
static void ResetUpdateTime();
Specify how wxWidgets will send update events: to
all windows, or only to those which specify that they
will process the events.
-
- @e mode may be one of the following values.
+ @a mode may be one of the following values.
The default is wxUPDATE_UI_PROCESS_ALL.
*/
static void SetMode(wxUpdateUIMode mode);
Sets the interval between updates in milliseconds.
Set to -1 to disable updates, or to 0 to update as frequently as possible.
The default is 0.
-
Use this to reduce the overhead of UI update events if your application
has a lot of windows. If you set the value to -1 or greater than 0,
you may also need to call wxWindow::UpdateWindowUI
/**
*/
- wxClipboardTextEvent(wxEventType commandType = wxEVT_@NULL,
+ wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL,
int id = 0);
};
/**
Returns @true if the identified mouse button is changing state. Valid
- values of @e button are:
+ values of @a button are:
@c wxMOUSE_BTN_LEFT
-
check if left button was pressed
@c wxMOUSE_BTN_MIDDLE
-
check if middle button was pressed
@c wxMOUSE_BTN_RIGHT
-
check if right button was pressed
@c wxMOUSE_BTN_AUX1
-
check if the first extra button was pressed
@c wxMOUSE_BTN_AUX2
-
check if the second extra button was pressed
@c wxMOUSE_BTN_ANY
-
check if any button was pressed
*/
bool Button(int button);
Same as MetaDown() under Mac, same as
ControlDown() elsewhere.
- @sa wxKeyEvent::CmdDown
+ @see wxKeyEvent::CmdDown
*/
bool CmdDown();
/**
Returns @true if this was a dragging event (motion while a button is depressed).
- @sa Moving()
+ @see Moving()
*/
bool Dragging();
/**
Returns @true if the mouse was entering the window.
-
See also Leaving().
*/
bool Entering();
/**
Returns the number of mouse clicks for this event: 1 for a simple click, 2
for a double-click, 3 for a triple-click and so on.
-
Currently this function is implemented only in wxMac and returns -1 for the
other platforms (you can still distinguish simple clicks from double-clicks as
they generate different kinds of events however).
-
This function is new since wxWidgets version 2.9.0
*/
int GetClickCount();
//@{
/**
Sets *x and *y to the position at which the event occurred.
-
Returns the physical mouse position in pixels.
-
Note that if the mouse event has been artificially generated from a special
keyboard combination (e.g. under Windows when the "menu'' key is pressed), the
returned position is @c wxDefaultPosition.
/**
Returns X coordinate of the physical mouse event position.
*/
-#define long GetX() /* implementation is private */
+ long GetX();
/**
Returns Y coordinate of the physical mouse event position.
*/
-#define long GetY() /* implementation is private */
+ long GetY();
/**
Returns @true if the event was a mouse button event (not necessarily a button
/**
Returns @true if the mouse was leaving the window.
-
See also Entering().
*/
bool Leaving();
/**
Returns @true if the left mouse button is currently down, independent
of the current event type.
-
Please notice that it is not the same as
LeftDown() which returns @true if the event was
generated by the left mouse button being pressed. Rather, it simply describes
the state of the left mouse button at the time when the event was generated
(so while it will be @true for a left click event, it can also be @true for
a right click if it happened while the left mouse button was pressed).
-
This event is usually used in the mouse event handlers which process "move
mouse" messages to determine whether the user is (still) dragging the mouse.
*/
/**
bool m_altDown
-
@true if the Alt key is pressed down.
*/
/**
bool m_controlDown
-
@true if control key is pressed down.
*/
/**
bool m_leftDown
-
@true if the left mouse button is currently pressed down.
*/
/**
int m_linesPerAction
-
The configured number of lines (or whatever) to be scrolled per wheel
action.
*/
/**
bool m_metaDown
-
@true if the Meta key is pressed down.
*/
/**
bool m_middleDown
-
@true if the middle mouse button is currently pressed down.
*/
/**
bool m_rightDown
-
@true if the right mouse button is currently pressed down.
*/
/**
bool m_shiftDown
-
@true if shift is pressed down.
*/
/**
int m_wheelDelta
-
The wheel delta, normally 120.
*/
/**
int m_wheelRotation
-
The distance the mouse wheel is rotated.
*/
/**
long m_x
-
X-coordinate of the event.
*/
/**
long m_y
-
Y-coordinate of the event.
*/
};
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxDropFilesEvent : public wxEvent
{
Constructor.
*/
wxDropFilesEvent(WXTYPE id = 0, int noFiles = 0,
- wxString* files = @NULL);
+ wxString* files = NULL);
/**
Returns an array of filenames.
/**
Returns the position at which the files were dropped.
-
Returns an array of filenames.
*/
wxPoint GetPosition();
/**
wxString* m_files
-
An array of filenames.
*/
/**
int m_noFiles
-
The number of files dropped.
*/
/**
wxPoint m_pos
-
The point at which the drop took place.
*/
};
Returns client object pointer for a listbox or choice selection event
(not valid for a deselection).
*/
- wxClientData * GetClientObject();
+ wxClientData* GetClientObject();
/**
Returns extra information dependant on the event objects type.
deselection one. For the menu events, this method indicates if the menu item
just has become checked or unchecked (and thus only makes sense for checkable
menu items).
-
Notice that this method can not be used with
wxCheckListBox currently.
*/
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxApp::IsActive
+ @ref overview_eventhandlingoverview, wxApp::IsActive
*/
class wxActivateEvent : public wxEvent
{
/**
Constructor.
*/
- wxActivateEvent(WXTYPE eventType = 0, bool active = @true,
+ wxActivateEvent(WXTYPE eventType = 0, bool active = true,
int id = 0);
/**
@seealso
@ref overview_wxcommandevent "Command events", @ref
- overview_eventhandlingoverview "Event handling overview"
+ overview_eventhandlingoverview
*/
class wxContextMenuEvent : public wxCommandEvent
{
Constructor.
*/
wxContextMenuEvent(WXTYPE id = 0, int id = 0,
- const wxPoint& pos=wxDefaultPosition);
+ const wxPoint& pos = wxDefaultPosition);
/**
Returns the position in screen coordinates at which the menu should be shown.
convert to client coordinates. You can also omit a position from
wxWindow::PopupMenu in order to use
the current mouse pointer position.
-
If the event originated from a keyboard event, the value returned from this
function will be wxDefaultPosition.
*/
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxEraseEvent : public wxEvent
{
/**
Constructor.
*/
- wxEraseEvent(int id = 0, wxDC* dc = @NULL);
+ wxEraseEvent(int id = 0, wxDC* dc = NULL);
/**
Returns the device context associated with the erase event to draw on.
*/
-#define wxDC* GetDC() /* implementation is private */
+ wxDC* GetDC();
};
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxFocusEvent : public wxEvent
{
Returns the window associated with this event, that is the window which had the
focus before for the @c wxEVT_SET_FOCUS event and the window which is
going to receive focus for the @c wxEVT_KILL_FOCUS one.
-
Warning: the window pointer may be @NULL!
*/
};
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxChildFocusEvent : public wxCommandEvent
{
Constructor.
@param win
- The direct child which is (or which contains the window which is) receiving the
- focus.
+ The direct child which is (or which contains the window which is) receiving
+ the focus.
*/
- wxChildFocusEvent(wxWindow * win = @NULL);
+ wxChildFocusEvent(wxWindow* win = NULL);
/**
Returns the direct child which receives the focus, or a (grand-)parent of the
control receiving the focus.
-
To get the actually focused control use wxWindow::FindFocus.
*/
};
@category{events}
@seealso
- wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview "Event handling
- overview", wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+ wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
class wxMouseCaptureLostEvent : public wxEvent
{
/**
Constructor (used internally by wxWidgets only).
*/
- wxNotifyEvent(wxEventType eventType = wxEVT_@NULL, int id = 0);
+ wxNotifyEvent(wxEventType eventType = wxEVT_NULL, int id = 0);
/**
This is the opposite of Veto(): it explicitly
/**
Prevents the change announced by this event from happening.
-
It is in general a good idea to notify the user about the reasons for vetoing
the change because otherwise the applications behaviour (which just refuses to
do what the user wants) might be quite surprising.
@category{FIXME}
@seealso
- wxContextHelp, wxDialog, @ref overview_eventhandlingoverview "Event handling
- overview"
+ wxContextHelp, wxDialog, @ref overview_eventhandlingoverview
*/
class wxHelpEvent : public wxCommandEvent
{
/**
Returns the origin of the help event which is one of the following values:
-
@b Origin_Unknown
-
Unrecognized event source.
@b Origin_Keyboard
-
Event generated by @c F1 key press.
@b Origin_HelpButton
-
Event generated by
wxContextHelp or using the "?" title bur button under
MS Windows.
differently, e.g. by using wxGetMousePosition
for the mouse events.
- @sa SetOrigin()
+ @see SetOrigin()
*/
wxHelpEvent::Origin GetOrigin();
/**
Set the help event origin, only used internally by wxWidgets normally.
- @sa GetOrigin()
+ @see GetOrigin()
*/
void SetOrigin(wxHelpEvent::Origin origin);
@seealso
wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref
- overview_eventhandlingoverview "Event handling overview"
+ overview_eventhandlingoverview
*/
class wxScrollEvent : public wxCommandEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxUpdateUIEvent,
- wxWindow::OnInternalIdle
+ @ref overview_eventhandlingoverview, wxUpdateUIEvent, wxWindow::OnInternalIdle
*/
class wxIdleEvent : public wxEvent
{
/**
Returns @true if it is appropriate to send idle events to
this window.
-
This function looks at the mode used (see wxIdleEvent::SetMode),
- and the wxWS_EX_PROCESS_IDLE style in @e window to determine whether idle
+ and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
events should be sent to
this window now. By default this will always return @true because
the update mode is initially wxIDLE_PROCESS_ALL. You can change the mode
to only send idle events to windows with the wxWS_EX_PROCESS_IDLE extra window
style set.
- @sa SetMode()
+ @see SetMode()
*/
static bool CanSend(wxWindow* window);
Static function returning a value specifying how wxWidgets
will send idle events: to all windows, or only to those which specify that they
will process the events.
-
See SetMode().
*/
static wxIdleMode GetMode();
Returns @true if the OnIdle function processing this event requested more
processing time.
- @sa RequestMore()
+ @see RequestMore()
*/
bool MoreRequested();
calling OnIdle) until a
new event is posted to the application by the windowing system.
- @sa MoreRequested()
+ @see MoreRequested()
*/
- void RequestMore(bool needMore = @true);
+ void RequestMore(bool needMore = true);
/**
Static function for specifying how wxWidgets will send idle events: to
all windows, or only to those which specify that they
will process the events.
-
- @e mode can be one of the following values.
+ @a mode can be one of the following values.
The default is wxIDLE_PROCESS_ALL.
*/
static void SetMode(wxIdleMode mode);
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxInitDialogEvent : public wxEvent
{
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxWindowCreateEvent
+ @ref overview_eventhandlingoverview, wxWindowCreateEvent
*/
class wxWindowDestroyEvent : public wxCommandEvent
{
/**
Constructor.
*/
- wxWindowDestroyEvent(wxWindow* win = @NULL);
+ wxWindowDestroyEvent(wxWindow* win = NULL);
};
void SetCurrentFocus(wxWindow* currentFocus);
/**
- Sets the direction to forward if @e direction is @true, or backward if @c
+ Sets the direction to forward if @a direction is @true, or backward if @c
@false.
*/
void SetDirection(bool direction);
@category{events}
@seealso
- wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview "Event handling
- overview", wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+ wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
class wxMouseCaptureChangedEvent : public wxEvent
{
Constructor.
*/
wxMouseCaptureChangedEvent(wxWindowID windowId = 0,
- wxWindow* gainedCapture = @NULL);
+ wxWindow* gainedCapture = NULL);
/**
Returns the window that gained the capture, or @NULL if it was a non-wxWidgets
/**
Call this from your event handler to veto a system shutdown or to signal
to the calling application that a window close did not happen.
-
You can only veto a shutdown if CanVeto() returns
@true.
*/
- void Veto(bool veto = @true);
+ void Veto(bool veto = true);
};
@seealso
@ref overview_wxcommandevent "Command events", @ref
- overview_eventhandlingoverview "Event handling overview"
+ overview_eventhandlingoverview
*/
class wxMenuEvent : public wxEvent
{
/**
Constructor.
*/
- wxMenuEvent(WXTYPE id = 0, int id = 0, wxMenu* menu = @NULL);
+ wxMenuEvent(WXTYPE id = 0, int id = 0, wxMenu* menu = NULL);
/**
Returns the menu which is being opened or closed. This method should only be
used with the @c OPEN and @c CLOSE events and even for them the
returned pointer may be @NULL in some ports.
*/
- wxMenu * GetMenu();
+ wxMenu* GetMenu();
/**
Returns the menu identifier associated with the event. This method should be
/**
Returns @true if the menu which is being opened or closed is a popup menu,
@false if it is a normal one.
-
This method should only be used with the @c OPEN and @c CLOSE events.
*/
bool IsPopup();
@category{FIXME}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxEvtHandler
+ @ref overview_eventhandlingoverview, wxEvtHandler
*/
class wxEventBlocker : public wxEvtHandler
{
public:
/**
Constructs the blocker for the given window and for the given event type.
- If @e type is @c wxEVT_ANY, then all events for that window are
+ If @a type is @c wxEVT_ANY, then all events for that window are
blocked. You can call Block() after creation to
add other event types to the list of events to block.
-
- Note that the @e win window @b must remain alive until the
+ Note that the @a win window @b must remain alive until the
wxEventBlocker object destruction.
*/
wxEventBlocker(wxWindow* win, wxEventType type = wxEVT_ANY);
@category{FIXME}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @ref overview_eventhandlingoverview
*/
class wxEvtHandler : public wxObject
{
This function posts an event to be processed later.
@param event
- Event to add to process queue.
+ Event to add to process queue.
@remarks The difference between sending an event (using the ProcessEvent
- method) and posting it is that in the first case the
- event is processed before the function returns, while
- in the second case, the function returns immediately
- and the event will be processed sometime later
- (usually during the next event loop iteration).
+ method) and posting it is that in the first case the
+ event is processed before the function returns, while
+ in the second case, the function returns immediately
+ and the event will be processed sometime later (usually
+ during the next event loop iteration).
*/
virtual void AddPendingEvent(const wxEvent& event);
'dynamic' sample for usage.
@param id
- The identifier (or first of the identifier range) to be
- associated with the event handler function. For the version not taking this
- argument, it defaults to wxID_ANY.
-
+ The identifier (or first of the identifier range) to be
+ associated with the event handler function. For the version not taking this
+ argument, it defaults to wxID_ANY.
@param lastId
- The second part of the identifier range to be associated with the event handler
- function.
-
+ The second part of the identifier range to be associated with the event
+ handler function.
@param eventType
- The event type to be associated with this event handler.
-
+ The event type to be associated with this event handler.
@param function
- The event handler function. Note that this function should
- be explicitly converted to the correct type which can be done using a macro
- called wxFooEventHandler for the handler for any wxFooEvent.
-
+ The event handler function. Note that this function should
+ be explicitly converted to the correct type which can be done using a macro
+ called wxFooEventHandler for the handler for any wxFooEvent.
@param userData
- Data to be associated with the event table entry.
-
+ Data to be associated with the event table entry.
@param eventSink
- Object whose member function should be called. If this is @NULL,
- this will be used.
+ Object whose member function should be called. If this is @NULL,
+ this will be used.
*/
void Connect(int id, int lastId, wxEventType eventType,
wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
void Connect(int id, wxEventType eventType,
wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
void Connect(wxEventType eventType,
wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
//@}
//@{
to disconnect functions connected using the (static) event tables.
@param id
- The identifier (or first of the identifier range) associated with the event
+ The identifier (or first of the identifier range) associated with the event
handler function.
-
@param lastId
- The second part of the identifier range associated with the event handler
+ The second part of the identifier range associated with the event handler
function.
-
@param eventType
- The event type associated with this event handler.
-
+ The event type associated with this event handler.
@param function
- The event handler function.
-
+ The event handler function.
@param userData
- Data associated with the event table entry.
-
+ Data associated with the event table entry.
@param eventSink
- Object whose member function should be called.
+ Object whose member function should be called.
*/
- bool Disconnect(wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ bool Disconnect(wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
bool Disconnect(int id = wxID_ANY,
- wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
bool Disconnect(int id, int lastId = wxID_ANY,
- wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
+ wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
//@}
/**
Gets user-supplied client data.
@remarks Normally, any extra data the programmer wishes to associate with
- the object should be made available by deriving a new
- class with new data members.
+ the object should be made available by deriving a new
+ class with new data members.
- @sa SetClientData()
+ @see SetClientData()
*/
void* GetClientData();
/**
Get a pointer to the user-supplied client data object.
- @sa SetClientObject(), wxClientData
+ @see SetClientObject(), wxClientData
*/
wxClientData* GetClientObject();
/**
Returns @true if the event handler is enabled, @false otherwise.
- @sa SetEvtHandlerEnabled()
+ @see SetEvtHandlerEnabled()
*/
bool GetEvtHandlerEnabled();
/**
Gets the pointer to the next handler in the chain.
- @sa SetNextHandler(), GetPreviousHandler(),
- SetPreviousHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
+ @see SetNextHandler(), GetPreviousHandler(),
+ SetPreviousHandler(), wxWindow::PushEventHandler,
+ wxWindow::PopEventHandler
*/
wxEvtHandler* GetNextHandler();
/**
Gets the pointer to the previous handler in the chain.
- @sa SetPreviousHandler(), GetNextHandler(),
- SetNextHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
+ @see SetPreviousHandler(), GetNextHandler(),
+ SetNextHandler(), wxWindow::PushEventHandler,
+ wxWindow::PopEventHandler
*/
wxEvtHandler* GetPreviousHandler();
event handler function(s).
@param event
- Event to process.
+ Event to process.
@returns @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
+ executed, and the function did not call wxEvent::Skip.
@remarks Normally, your application would not call this function: it is
- called in the wxWidgets implementation to dispatch
- incoming user interface events to the framework (and
- application).
+ called in the wxWidgets implementation to dispatch
+ incoming user interface events to the framework (and
+ application).
- @sa SearchEventTable()
+ @see SearchEventTable()
*/
virtual bool ProcessEvent(wxEvent& event);
is called.
@param event
- Event to process.
+ Event to process.
@returns @true if the event was processed, @false if no handler was found
- or an exception was thrown.
+ or an exception was thrown.
- @sa wxWindow::HandleWindowEvent
+ @see wxWindow::HandleWindowEvent
*/
bool SafelyProcessEvent(wxEvent& event);
is found.
@param table
- Event table to be searched.
-
+ Event table to be searched.
@param event
- Event to be matched against an event table entry.
+ Event to be matched against an event table entry.
@returns @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
+ executed, and the function did not call wxEvent::Skip.
@remarks This function looks through the object's event table and tries
- to find an entry that will match the event.
+ to find an entry that will match the event.
- @sa ProcessEvent()
+ @see ProcessEvent()
*/
virtual bool SearchEventTable(wxEventTable& table,
wxEvent& event);
Sets user-supplied client data.
@param data
- Data to be associated with the event handler.
+ Data to be associated with the event handler.
@remarks Normally, any extra data the programmer wishes to associate with
- the object should be made available by deriving a
- new class with new data members. You must not call
- this method and SetClientObject on the same class -
- only one of them.
+ the object should be made available by deriving a new
+ class with new data members. You must not call this
+ method and SetClientObject on the same class - only one
+ of them.
- @sa GetClientData()
+ @see GetClientData()
*/
void SetClientData(void* data);
/**
Set the client data object. Any previous object will be deleted.
- @sa GetClientObject(), wxClientData
+ @see GetClientObject(), wxClientData
*/
void SetClientObject(wxClientData* data);
Enables or disables the event handler.
@param enabled
- @true if the event handler is to be enabled, @false if it is to be disabled.
+ @true if the event handler is to be enabled, @false if it is to be disabled.
@remarks You can use this function to avoid having to remove the event
- handler from the chain, for example when implementing
- a dialog editor and changing from edit to test mode.
+ handler from the chain, for example when implementing a
+ dialog editor and changing from edit to test mode.
- @sa GetEvtHandlerEnabled()
+ @see GetEvtHandlerEnabled()
*/
void SetEvtHandlerEnabled(bool enabled);
Sets the pointer to the next handler.
@param handler
- Event handler to be set as the next handler.
+ Event handler to be set as the next handler.
- @sa GetNextHandler(), SetPreviousHandler(),
- GetPreviousHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
+ @see GetNextHandler(), SetPreviousHandler(),
+ GetPreviousHandler(), wxWindow::PushEventHandler,
+ wxWindow::PopEventHandler
*/
void SetNextHandler(wxEvtHandler* handler);
Sets the pointer to the previous handler.
@param handler
- Event handler to be set as the previous handler.
+ Event handler to be set as the previous handler.
*/
void SetPreviousHandler(wxEvtHandler* handler);
};
@category{events}
@seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxTopLevelWindow::Iconize, wxTopLevelWindow::IsIconized
+ @ref overview_eventhandlingoverview, wxTopLevelWindow::Iconize,
+ wxTopLevelWindow::IsIconized
*/
class wxIconizeEvent : public wxEvent
{
/**
Constructor.
*/
- wxIconizeEvent(int id = 0, bool iconized = @true);
+ wxIconizeEvent(int id = 0, bool iconized = true);
/**
Returns @true if the frame has been iconized, @false if it has been
@category{events}
@seealso
- wxPoint, @ref overview_eventhandlingoverview "Event handling overview"
+ wxPoint, @ref overview_eventhandlingoverview
*/
class wxMoveEvent : public wxEvent
{
callback or member function. @b wxEvent used to be a multipurpose
event object, and is an abstract base class for other event classes (see below).
- For more information about events, see the @ref overview_eventhandlingoverview
- "Event handling overview".
+ For more information about events, see the @ref overview_eventhandlingoverview.
@b wxPerl note: In wxPerl custom event classes should be derived from
@c Wx::PlEvent and @c Wx::PlCommandEvent.
/**
Constructor. Should not need to be used directly by an application.
*/
- wxEvent(int id = 0, wxEventType eventType = wxEVT_@NULL);
+ wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
/**
Returns a copy of the event.
-
Any event that is posted to the wxWidgets event system for later action (via
wxEvtHandler::AddPendingEvent or
wxPostEvent) must implement this method. All wxWidgets
events fully implement this method, but any derived events implemented by the
user should also implement this method just in case they (or some event
derived from them) are ever posted.
-
All wxWidgets events implement a copy constructor, so the easiest way of
implementing the Clone function is to implement a copy constructor for
a new event (call it MyEvent) and then define the Clone function like this:
the event will not be processed any more. If Skip(@true) is called, the event
processing system continues searching for a further handler function for this
event, even though it has been processed already in the current handler.
-
In general, it is recommended to skip all non-command events to allow the
default handling to take place. The command events are, however, normally not
skipped as usually a single command such as a button click or menu item
selection must only be processed by one handler.
*/
- void Skip(bool skip = @true);
+ void Skip(bool skip = true);
/**
Stop the event from propagating to its parent window.
-
Returns the old propagation level value which may be later passed to
ResumePropagation() to allow propagating the
event again.
/**
int m_propagationLevel
-
Indicates how many levels the event can propagate. This member is protected and
should typically only be set in the constructors of the derived classes. It
may be temporarily changed by StopPropagation()
and ResumePropagation() and tested with
ShouldPropagate().
-
The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by
default) meaning that the event shouldn't be propagated at all or to
@c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
propagated as much as necessary.
-
Any positive number means that the event should be propagated but no more than
the given number of times. E.g. the propagation level may be set to 1 to
propagate the event to its parent only, but not to its grandparent.
@category{events}
@seealso
- wxSize, @ref overview_eventhandlingoverview "Event handling overview"
+ wxSize, @ref overview_eventhandlingoverview
*/
class wxSizeEvent : public wxEvent
{
/**
Returns the X coordinate of the mouse in client coordinates.
*/
-#define wxCoord GetX() /* implementation is private */
+ wxCoord GetX();
/**
Returns the Y coordinate of the mouse in client coordinates.
*/
-#define wxCoord GetY() /* implementation is private */
+ wxCoord GetY();
/**
Returns @true if the cursor specified by this event is a valid cursor.
@remarks You cannot specify wxNullCursor with this event, as it is not
- considered a valid cursor.
+ considered a valid cursor.
*/
bool HasCursor();
projects / wxWidgets.git / blobdiff