]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/man/man3/Event.3
Re-added the dot graphs again
[user/henk/code/inspircd.git] / docs / man / man3 / Event.3
index 7cb7e81096c2b33a5e83989fa5bdf47b79363941..dabb4c1d4845119f369bddd1fe9e73b51f1b97c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "Event" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*-
+.TH "Event" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -58,80 +58,80 @@ The Event class is a unicast message directed at all modules.
 
 When the class is properly instantiated it may be sent to all modules using the \fBSend()\fP method, which will trigger the OnEvent method in all modules passing the object as its parameter. 
 .PP
-Definition at line 191 of file modules.h.
+Definition at line 194 of file modules.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "Event::Event (char * anydata, \fBModule\fP * src, std::string eventid)"
 .PP
-Create a new Event. Definition at line 337 of file modules.cpp.
+Create a new Event. Definition at line 345 of file modules.cpp.
 .PP
 .nf
-337 : data(anydata), source(src), id(eventid) { };
+345 : data(anydata), source(src), id(eventid) { };
 .fi
 .SH "Member Function Documentation"
 .PP 
 .SS "char * Event::GetData ()"
 .PP
-Get the Event data. Definition at line 339 of file modules.cpp.
+Get the Event data. Definition at line 347 of file modules.cpp.
 .PP
 References data.
 .PP
 .nf
-340 {
-341         return this->data;
-342 }
+348 {
+349         return this->data;
+350 }
 .fi
 .SS "std::string Event::GetEventID ()"
 .PP
-Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 355 of file modules.cpp.
+Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 363 of file modules.cpp.
 .PP
 References id.
 .PP
 .nf
-356 {
-357         return this->id;
-358 }
+364 {
+365         return this->id;
+366 }
 .fi
 .SS "\fBModule\fP * Event::GetSource ()"
 .PP
-Get the event Source. Definition at line 344 of file modules.cpp.
+Get the event Source. Definition at line 352 of file modules.cpp.
 .PP
 References source.
 .PP
 .nf
-345 {
-346         return this->source;
-347 }
+353 {
+354         return this->source;
+355 }
 .fi
 .SS "char * Event::Send ()\fC [virtual]\fP"
 .PP
 Send the Event. The return result of an \fBEvent::Send()\fP will always be NULL as no replies are expected. Implements \fBModuleMessage\fP.
 .PP
-Definition at line 349 of file modules.cpp.
+Definition at line 357 of file modules.cpp.
 .PP
 References FOREACH_MOD.
 .PP
 .nf
-350 {
-351         FOREACH_MOD OnEvent(this);
-352         return NULL;
-353 }
+358 {
+359         FOREACH_MOD OnEvent(this);
+360         return NULL;
+361 }
 .fi
 .SH "Member Data Documentation"
 .PP 
 .SS "char* \fBEvent::data\fP\fC [protected]\fP"
 .PP
-This member holds a pointer to arbitary data set by the emitter of the message. Definition at line 196 of file modules.h.
+This member holds a pointer to arbitary data set by the emitter of the message. Definition at line 199 of file modules.h.
 .PP
 Referenced by GetData().
 .SS "std::string \fBEvent::id\fP\fC [protected]\fP"
 .PP
-The event identifier. This is arbitary text which should be used to distinguish one type of event from another. Definition at line 205 of file modules.h.
+The event identifier. This is arbitary text which should be used to distinguish one type of event from another. Definition at line 208 of file modules.h.
 .PP
 Referenced by GetEventID().
 .SS "\fBModule\fP* \fBEvent::source\fP\fC [protected]\fP"
 .PP
-This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. Definition at line 200 of file modules.h.
+This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. Definition at line 203 of file modules.h.
 .PP
 Referenced by GetSource().