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

Remove event macros expansions from the documentation

Browse Source 
The expansions do not really add anything to the documentation
page, and can be confusing at first.

Closes https://github.com/wxWidgets/wxWidgets/pull/1701
This commit is contained in:
Ian McInerney
2020-01-10 00:27:07 +00:00
committed by Vadim Zeitlin
parent 7dd0ad9a0d
commit 64ac20536a
1 changed files with 7 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
interface/wx/event.h
View File

@@ -4827,8 +4827,7 @@ wxEventType wxNewEventType();
@see wxDECLARE_EVENT(), @ref overview_events_custom @see wxDECLARE_EVENT(), @ref overview_events_custom
*/ */
#define wxDEFINE_EVENT(name, cls) \ #define wxDEFINE_EVENT(name, cls)
const wxEventTypeTag< cls > name(wxNewEventType())
/** /**
Declares a custom event type. Declares a custom event type.
@@ -4848,8 +4847,7 @@ wxEventType wxNewEventType();
wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent); wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
@endcode @endcode
*/ */
#define wxDECLARE_EVENT(name, cls) \ #define wxDECLARE_EVENT(name, cls)
wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
/** /**
Variant of wxDECLARE_EVENT() used for event types defined inside a shared Variant of wxDECLARE_EVENT() used for event types defined inside a shared
@@ -4860,8 +4858,7 @@ wxEventType wxNewEventType();
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_BUTTON, wxCommandEvent); wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_BUTTON, wxCommandEvent);
@endcode @endcode
*/ */
#define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \ #define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls )
extern const expdecl wxEventTypeTag< cls > name;
/** /**
Helper macro for definition of custom event table macros. Helper macro for definition of custom event table macros.
@@ -4875,7 +4872,7 @@ wxEventType wxNewEventType();
@see @ref overview_events_custom_ownclass @see @ref overview_events_custom_ownclass
*/ */
#define wxEVENT_HANDLER_CAST(functype, func) (&func) #define wxEVENT_HANDLER_CAST(functype, func)
/** /**
This macro is used to define event table macros for handling custom This macro is used to define event table macros for handling custom
@@ -4909,8 +4906,7 @@ wxEventType wxNewEventType();
@param fn @param fn
The event handler method. The event handler method.
*/ */
#define wx__DECLARE_EVT1(evt, id, fn) \ #define wx__DECLARE_EVT1(evt, id, fn)
wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
/** /**
Generalized version of the wx__DECLARE_EVT1() macro taking a range of Generalized version of the wx__DECLARE_EVT1() macro taking a range of
@@ -4918,16 +4914,14 @@ wxEventType wxNewEventType();
Argument @a id1 is the first identifier of the range, @a id2 is the Argument @a id1 is the first identifier of the range, @a id2 is the
second identifier of the range. second identifier of the range.
*/ */
#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ #define wx__DECLARE_EVT2(evt, id1, id2, fn)
DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
/** /**
Simplified version of the wx__DECLARE_EVT1() macro, to be used when the Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
event type must be handled regardless of the ID associated with the event type must be handled regardless of the ID associated with the
specific event instances. specific event instances.
*/ */
#define wx__DECLARE_EVT0(evt, fn) \ #define wx__DECLARE_EVT0(evt, fn)
wx__DECLARE_EVT1(evt, wxID_ANY, fn)
/** /**
Use this macro inside a class declaration to declare a @e static event table Use this macro inside a class declaration to declare a @e static event table