Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/event/event_handler.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit
- File:
-
- 1 edited
-
orxonox/trunk/src/lib/event/event_handler.cc (modified) (11 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/event/event_handler.cc
r4817 r4836 29 29 30 30 /** 31 \briefstandard constructor31 * standard constructor 32 32 */ 33 33 EventHandler::EventHandler () … … 52 52 53 53 /** 54 \briefthe singleton reference to this class54 * the singleton reference to this class 55 55 */ 56 56 EventHandler* EventHandler::singletonRef = NULL; … … 58 58 59 59 /** 60 \briefstandard deconstructor60 * standard deconstructor 61 61 62 62 */ … … 80 80 81 81 /** 82 \briefinitializes the event handler82 * initializes the event handler 83 83 84 84 this has to be called before the use of the event handler … … 92 92 93 93 /** 94 \briefset the state of the event handler95 \param state: to which the event handler shall change94 * set the state of the event handler 95 * @param state: to which the event handler shall change 96 96 */ 97 97 void EventHandler::setState(elState state) … … 102 102 103 103 /** 104 \briefsubscribe to an event105 \param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures106 \param state: for which the listener wants to receive events107 \param eventType: the event type that wants to be listened for.104 * subscribe to an event 105 * @param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures 106 * @param state: for which the listener wants to receive events 107 * @param eventType: the event type that wants to be listened for. 108 108 109 109 This is one of the most important function of the EventHandler. If you would like to subscribe for more … … 111 111 state = ES_ALL, which will subscribe your listener for all states together. 112 112 * 113 * \todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL113 * @todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL 114 114 */ 115 115 void EventHandler::subscribe(EventListener* el, elState state, int eventType) … … 135 135 136 136 /** 137 \briefunsubscribe from the EventHandler138 \param state: the stat in which it has been subscribed139 \param eventType: the event, that shall be unsubscribed137 * unsubscribe from the EventHandler 138 * @param state: the stat in which it has been subscribed 139 * @param eventType: the event, that shall be unsubscribed 140 140 141 141 if you want to unsubscribe an event listener from all subscribed events, just use the … … 150 150 151 151 /** 152 \briefunsubscribe all events from a specific listener153 \param el: the listener that wants to unsubscribe itself154 \param state: the state in which the events shall be unsubscribed152 * unsubscribe all events from a specific listener 153 * @param el: the listener that wants to unsubscribe itself 154 * @param state: the state in which the events shall be unsubscribed 155 155 156 156 */ … … 182 182 183 183 /** 184 \briefflush all registered events185 \param state: a specific state184 * flush all registered events 185 * @param state: a specific state 186 186 */ 187 187 void EventHandler::flush(elState state) … … 208 208 209 209 /** 210 \briefcore function of event handler: receives all events from SDL210 * core function of event handler: receives all events from SDL 211 211 212 212 The event from the SDL framework are collected here and distributed to all listeners.
Note: See TracChangeset
for help on using the changeset viewer.
