Don't document non-public wxEvtHandler::SearchEventTable()
This method is not part of public wxWidgets API, so don't document it.
This commit is contained in:
parent
66e3a3f724
commit
4eababc004
@ -626,8 +626,6 @@ public:
|
||||
@return
|
||||
@true if a suitable event handler function was found and executed,
|
||||
and the function did not call wxEvent::Skip.
|
||||
|
||||
@see SearchEventTable()
|
||||
*/
|
||||
virtual bool ProcessEvent(wxEvent& event);
|
||||
|
||||
@ -697,36 +695,6 @@ public:
|
||||
*/
|
||||
void DeletePendingEvents();
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@return @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.
|
||||
An entry will match if:
|
||||
@li The event type matches, and
|
||||
@li the identifier or identifier range matches, or the event table
|
||||
entry's identifier is zero.
|
||||
|
||||
If a suitable function is called but calls wxEvent::Skip, this
|
||||
function will fail, and searching will continue.
|
||||
|
||||
@todo this function in the header is listed as an "implementation only" function;
|
||||
are we sure we want to document it?
|
||||
|
||||
@see ProcessEvent()
|
||||
*/
|
||||
virtual bool SearchEventTable(wxEventTable& table,
|
||||
wxEvent& event);
|
||||
|
||||
//@}
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user