summaryrefslogtreecommitdiff
path: root/docs/man/man3/Event.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/man3/Event.3')
-rw-r--r--docs/man/man3/Event.348
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3
index 42c9851da..7ce4188e5 100644
--- a/docs/man/man3/Event.3
+++ b/docs/man/man3/Event.3
@@ -1,4 +1,4 @@
-.TH "Event" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "Event" 3 "19 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -58,17 +58,17 @@ 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 197 of file modules.h.
+Definition at line 215 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Event::Event (char * anydata, \fBModule\fP * src, \fBstd::string\fP eventid)"
.PP
Create a new Event.
.PP
-Definition at line 194 of file modules.cpp.
+Definition at line 193 of file modules.cpp.
.PP
.nf
-194 : data(anydata), source(src), id(eventid) { };
+193 : data(anydata), source(src), id(eventid) { };
.fi
.PP
.SH "Member Function Documentation"
@@ -77,14 +77,14 @@ Definition at line 194 of file modules.cpp.
.PP
Get the Event data.
.PP
-Definition at line 196 of file modules.cpp.
+Definition at line 195 of file modules.cpp.
.PP
References data.
.PP
.nf
-197 {
-198 return this->data;
-199 }
+196 {
+197 return this->data;
+198 }
.fi
.PP
.SS "\fBstd::string\fP Event::GetEventID ()"
@@ -93,28 +93,28 @@ Get the event ID.
.PP
Use this to determine the event type for safe casting of the data
.PP
-Definition at line 212 of file modules.cpp.
+Definition at line 211 of file modules.cpp.
.PP
References id.
.PP
.nf
-213 {
-214 return this->id;
-215 }
+212 {
+213 return this->id;
+214 }
.fi
.PP
.SS "\fBModule\fP * Event::GetSource ()"
.PP
Get the event Source.
.PP
-Definition at line 201 of file modules.cpp.
+Definition at line 200 of file modules.cpp.
.PP
References source.
.PP
.nf
-202 {
-203 return this->source;
-204 }
+201 {
+202 return this->source;
+203 }
.fi
.PP
.SS "char * Event::Send ()\fC [virtual]\fP"
@@ -125,15 +125,15 @@ The return result of an \fBEvent::Send()\fP will always be NULL as no replies ar
.PP
Implements \fBModuleMessage\fP.
.PP
-Definition at line 206 of file modules.cpp.
+Definition at line 205 of file modules.cpp.
.PP
References FOREACH_MOD.
.PP
.nf
-207 {
-208 FOREACH_MOD OnEvent(this);
-209 return NULL;
-210 }
+206 {
+207 FOREACH_MOD OnEvent(this);
+208 return NULL;
+209 }
.fi
.PP
.SH "Member Data Documentation"
@@ -142,7 +142,7 @@ References FOREACH_MOD.
.PP
This member holds a pointer to arbitary data set by the emitter of the message.
.PP
-Definition at line 202 of file modules.h.
+Definition at line 220 of file modules.h.
.PP
Referenced by GetData().
.SS "\fBstd::string\fP \fBEvent::id\fP\fC [protected]\fP"
@@ -151,14 +151,14 @@ The event identifier.
.PP
This is arbitary text which should be used to distinguish one type of event from another.
.PP
-Definition at line 211 of file modules.h.
+Definition at line 229 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.
.PP
-Definition at line 206 of file modules.h.
+Definition at line 224 of file modules.h.
.PP
Referenced by GetSource().