From 73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 19:45:57 +0000 Subject: Initial revision git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@132 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 315 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 315 insertions(+) create mode 100644 docs/module-doc/classModule.html (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html new file mode 100644 index 000000000..519fbeb27 --- /dev/null +++ b/docs/module-doc/classModule.html @@ -0,0 +1,315 @@ + + +Module class Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

Module Class Reference

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +More... +

+#include <modules.h> +

+List of all members. + + + + + + + + + + + + + + + + +

Public Methods

 Module ()
 Default constructor creates a module class.

virtual ~Module ()
 Default destructor destroys a module class.

virtual Version GetVersion ()
 Returns the version number of a Module.

virtual void OnUserConnect (userrec *user)
 Called when a user connects.

virtual void OnUserQuit (userrec *user)
 Called when a user quits.

virtual void OnUserJoin (userrec *user, chanrec *channel)
 Called when a user joins a channel.

virtual void OnUserPart (userrec *user, chanrec *channel)
 Called when a user parts a channel.

+

Detailed Description

+Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +

+All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised. +

+ +

+Definition at line 79 of file modules.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
Module::Module (   ) 
+
+ + + + + +
+   + + +

+Default constructor creates a module class. +

+ +

+Definition at line 40 of file modules.cpp. +

+

00040 { }
+
+

+ + + + +
+ + + + + + + + + +
Module::~Module (   )  [virtual]
+
+ + + + + +
+   + + +

+Default destructor destroys a module class. +

+ +

+Definition at line 41 of file modules.cpp. +

+

00041 { }
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
Version Module::GetVersion (   )  [virtual]
+
+ + + + + +
+   + + +

+Returns the version number of a Module. +

+The method should return a Version object with its version information assigned via Version::Version +

+Definition at line 46 of file modules.cpp. +

+

00046 { return Version(1,0,0,0); }
+
+

+ + + + +
+ + + + + + + + + + +
void Module::OnUserConnect ( userrec *   user )  [virtual]
+
+ + + + + +
+   + + +

+Called when a user connects. +

+The details of the connecting user are available to you in the parameter userrec *user +

+Definition at line 42 of file modules.cpp. +

+

00042 { }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Module::OnUserJoin ( userrec *   user,
chanrec *   channel
)  [virtual]
+
+ + + + + +
+   + + +

+Called when a user joins a channel. +

+The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel +

+Definition at line 44 of file modules.cpp. +

+

00044 { }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Module::OnUserPart ( userrec *   user,
chanrec *   channel
)  [virtual]
+
+ + + + + +
+   + + +

+Called when a user parts a channel. +

+The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel +

+Definition at line 45 of file modules.cpp. +

+

00045 { }
+
+

+ + + + +
+ + + + + + + + + + +
void Module::OnUserQuit ( userrec *   user )  [virtual]
+
+ + + + + +
+   + + +

+Called when a user quits. +

+The details of the exiting user are available to you in the parameter userrec *user +

+Definition at line 43 of file modules.cpp. +

+

00043 { }
+
+

The documentation for this class was generated from the following files: +
Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + -- cgit v1.3.1-10-gc9f91