Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed trailing whitespace in Doxygen files

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52634 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-03-20 13:45:17 +00:00
parent 7df4c51f60
commit 3c4f71cc3d
184 changed files with 4902 additions and 4902 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
interface/event.h
View File

@@ -121,12 +121,12 @@ public:
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() const;
@@ -277,7 +277,7 @@ public:
/**
Returns @true if the event was a down event from the specified button (or 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.
@@ -286,7 +286,7 @@ public:
/**
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.
@@ -296,7 +296,7 @@ public:
/**
Returns @true if the event was an up event from the specified button (or 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.
@@ -523,7 +523,7 @@ public:
the interval is set to 0; so update events will be sent as
often as possible. You can reduce the frequency that events
are sent by changing the mode and/or setting an update interval.
@see ResetUpdateTime(), SetUpdateInterval(),
SetMode()
*/
@@ -604,7 +604,7 @@ public:
current time. It is assumed that update events are
normally sent in idle time, so this is called at the end of
idle processing.
@see CanUpdate(), SetUpdateInterval(),
SetMode()
*/
@@ -748,7 +748,7 @@ class wxMouseEvent : public wxEvent
public:
/**
Constructor. Valid event types are:
@b wxEVT_ENTER_WINDOW
@b wxEVT_LEAVE_WINDOW
@b wxEVT_LEFT_DOWN
@@ -823,29 +823,29 @@ public:
/**
Returns @true if the identified mouse button is changing state. Valid
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);
@@ -877,7 +877,7 @@ public:
/**
Same as MetaDown() under Mac, same as
ControlDown() elsewhere.
@see wxKeyEvent::CmdDown
*/
bool CmdDown() const;
@@ -889,7 +889,7 @@ public:
/**
Returns @true if this was a dragging event (motion while a button is depressed).
@see Moving()
*/
bool Dragging();
@@ -915,7 +915,7 @@ public:
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).
@wxsince{2.9.0}
*/
int GetClickCount() const;
@@ -1512,7 +1512,7 @@ class wxChildFocusEvent : public wxCommandEvent
public:
/**
Constructor.
@param win
The direct child which is (or which contains the window which is) receiving
the focus.
@@ -1650,25 +1650,25 @@ public:
/**
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.
The application may handle events generated using the keyboard or mouse
differently, e.g. by using wxGetMousePosition()
for the mouse events.
@see SetOrigin()
*/
wxHelpEvent::Origin GetOrigin() const;
@@ -1681,7 +1681,7 @@ public:
/**
Set the help event origin, only used internally by wxWidgets normally.
@see GetOrigin()
*/
void SetOrigin(wxHelpEvent::Origin origin);
@@ -1780,7 +1780,7 @@ public:
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.
@see SetMode()
*/
static bool CanSend(wxWindow* window);
@@ -1796,7 +1796,7 @@ public:
/**
Returns @true if the OnIdle function processing this event requested more
processing time.
@see RequestMore()
*/
bool MoreRequested() const;
@@ -1811,7 +1811,7 @@ public:
during OnIdle, then the application will remain in a passive event loop (not
calling OnIdle) until a
new event is posted to the application by the windowing system.
@see MoreRequested()
*/
void RequestMore(bool needMore = true);
@@ -2221,10 +2221,10 @@ public:
/**
This function posts an event to be processed later.
@param event
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
@@ -2240,7 +2240,7 @@ public:
type. This
is an alternative to the use of static event tables. See the 'event' or the old
'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
@@ -2283,7 +2283,7 @@ public:
added
using the Connect() method. There is no way
to disconnect functions connected using the (static) event tables.
@param id
The identifier (or first of the identifier range) associated with the event
handler function.
@@ -2317,32 +2317,32 @@ public:
/**
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.
@see SetClientData()
*/
void* GetClientData();
/**
Get a pointer to the user-supplied client data object.
@see SetClientObject(), wxClientData
*/
wxClientData* GetClientObject() const;
/**
Returns @true if the event handler is enabled, @false otherwise.
@see SetEvtHandlerEnabled()
*/
bool GetEvtHandlerEnabled();
/**
Gets the pointer to the next handler in the chain.
@see SetNextHandler(), GetPreviousHandler(),
SetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2351,7 +2351,7 @@ public:
/**
Gets the pointer to the previous handler in the chain.
@see SetPreviousHandler(), GetNextHandler(),
SetNextHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2361,18 +2361,18 @@ public:
/**
Processes an event, searching event tables and calling zero or more suitable
event handler function(s).
@param event
Event to process.
@returns @true if a suitable event handler function was found and
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).
@see SearchEventTable()
*/
virtual bool ProcessEvent(wxEvent& event);
@@ -2382,13 +2382,13 @@ public:
and handles any exceptions that occur in the process. If an exception is
thrown in event handler, wxApp::OnExceptionInMainLoop
is called.
@param event
Event to process.
@returns @true if the event was processed, @false if no handler was found
or an exception was thrown.
@see wxWindow::HandleWindowEvent
*/
bool SafelyProcessEvent(wxEvent& event);
@@ -2397,18 +2397,18 @@ public:
Searches the event table, executing an event handler function if an appropriate
one
is found.
@param table
Event table to be searched.
@param event
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.
@remarks This function looks through the object's event table and tries
to find an entry that will match the event.
@see ProcessEvent()
*/
virtual bool SearchEventTable(wxEventTable& table,
@@ -2416,47 +2416,47 @@ public:
/**
Sets user-supplied client data.
@param data
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.
@see GetClientData()
*/
void SetClientData(void* data);
/**
Set the client data object. Any previous object will be deleted.
@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.
@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.
@see GetEvtHandlerEnabled()
*/
void SetEvtHandlerEnabled(bool enabled);
/**
Sets the pointer to the next handler.
@param handler
Event handler to be set as the next handler.
@see GetNextHandler(), SetPreviousHandler(),
GetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2465,7 +2465,7 @@ public:
/**
Sets the pointer to the previous handler.
@param handler
Event handler to be set as the previous handler.
*/
@@ -2767,7 +2767,7 @@ public:
/**
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.
*/