Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » inspircd » include

mode.h File Reference

#include "channels.h"

Include dependency graph for mode.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ModeHandler
	Each mode is implemented by ONE ModeHandler class. More...
class	SimpleUserModeHandler
	A prebuilt mode handler which handles a simple user mode, e.g. More...
class	SimpleChannelModeHandler
	A prebuilt mode handler which handles a simple channel mode, e.g. More...
class	ModeWatcher
	The ModeWatcher class can be used to alter the behaviour of a mode implemented by the core or by another module. More...
class	ModeParser
	The mode parser handles routing of modes and handling of mode strings. More...
Typedefs
typedef std::pair< bool, std::string >	ModePair
	Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
typedef std::vector< ModeWatcher * >::iterator	ModeWatchIter
Enumerations
enum	ModeType { MODETYPE_USER = 0, MODETYPE_CHANNEL = 1 }
	Holds the values for different type of modes that can exist, USER or CHANNEL type. More...
enum	ModeAction { MODEACTION_DENY = 0, MODEACTION_ALLOW = 1 }
	Holds mode actions - modes can be allowed or denied. More...
enum	ModeMasks { MASK_USER = 128, MASK_CHANNEL = 0 }
	Used to mask off the mode types in the mode handler array. More...
enum	PrefixModeValue { VOICE_VALUE = 10000, HALFOP_VALUE = 20000, OP_VALUE = 30000 }
	These fixed values can be used to proportionally compare module-defined prefixes to known values. More...

---

Typedef Documentation

typedef std::pair<bool,std::string> ModePair

Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user. The pair contains an activity flag, true if the mode is set with the given parameter, and the parameter of the mode (or the parameter provided) in the std::string. Definition at line 77 of file mode.h.

typedef std::vector<ModeWatcher*>::iterator ModeWatchIter

Definition at line 404 of file mode.h.

---

Enumeration Type Documentation

enum ModeAction

Holds mode actions - modes can be allowed or denied. Enumerator: MODEACTION_DENY  MODEACTION_ALLOW  Definition at line 37 of file mode.h.

enum ModeMasks

Used to mask off the mode types in the mode handler array. Used in a simple two instruction hashing function "(modeletter - 65) OR mask" Enumerator: MASK_USER  MASK_CHANNEL  Definition at line 48 of file mode.h.

enum ModeType

Holds the values for different type of modes that can exist, USER or CHANNEL type. Enumerator: MODETYPE_USER  User mode. MODETYPE_CHANNEL  Channel mode. Definition at line 26 of file mode.h.

enum PrefixModeValue

These fixed values can be used to proportionally compare module-defined prefixes to known values. For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix '$', and you dont know what $ means, then you can compare it to these three values to determine its worth against them. For example if '$' had a value of 15000, you would know it is of higher status than voice, but lower status than halfop. No two modes should have equal prefix values. Enumerator: VOICE_VALUE  HALFOP_VALUE  OP_VALUE  Definition at line 62 of file mode.h.