Modes::ChangeList Class Reference

#include <modechange.h>

Public Types
typedef std::vector< Change >	List

Public Member Functions
void	push (const Modes::Change &change)
void	push (List::const_iterator first, List::const_iterator last)
void	push (ModeHandler *mh, bool adding, const std::string &param=std::string())
void	push_add (ModeHandler *mh, const std::string &param=std::string())
void	push_remove (ModeHandler *mh, const std::string &param=std::string())
void	clear ()
bool	empty () const
List::size_type	size () const
const List &	getlist () const
List &	getlist ()

Detailed Description

A list of mode changes that can be applied on a Channel or User

Member Function Documentation

clear()

void Modes::ChangeList::clear ( )

inline

Remove all mode changes from this stack

empty()

bool Modes::ChangeList::empty ( ) const

inline

Checks whether the ChangeList is empty, equivalent to (size() != 0).

Returns

True if the ChangeList is empty, false otherwise.

getlist() [1/2]

List& Modes::ChangeList::getlist ( )

inline

Get the list of mode changes in this ChangeList

Returns

List of modes added to this ChangeList

getlist() [2/2]

const List& Modes::ChangeList::getlist ( ) const

inline

Get the list of mode changes in this ChangeList

Returns

List of modes added to this ChangeList

push() [1/3]

void Modes::ChangeList::push ( const Modes::Change &  change )

inline

Add a new mode to be changed to this ChangeList

Parameters

change

Mode change to add

push() [2/3]

void Modes::ChangeList::push ( List::const_iterator  first, List::const_iterator  last  )

inline

Insert multiple mode changes to the ChangeList

Parameters

first	Iterator to the first change to insert
last	Iterator to the first change to not insert

push() [3/3]

void Modes::ChangeList::push ( ModeHandler *  mh, bool  adding, const std::string &  param = std::string()  )

inline

Add a new mode to be changed to this ChangeList

Parameters

mh	Mode handler
adding	True if this mode is being set, false if removed
param	Mode parameter

push_add()

void Modes::ChangeList::push_add ( ModeHandler *  mh, const std::string &  param = std::string()  )

inline

Add a new mode to this ChangeList which will be set on the target

Parameters

mh	Mode handler
param	Mode parameter

push_remove()

void Modes::ChangeList::push_remove ( ModeHandler *  mh, const std::string &  param = std::string()  )

inline

Add a new mode to this ChangeList which will be unset from the target

Parameters

mh	Mode handler
param	Mode parameter

size()

List::size_type Modes::ChangeList::size ( ) const

inline

Get number of mode changes in this ChangeList

Returns

Number of mode changes in this ChangeList

---

The documentation for this class was generated from the following file:

• include/modechange.h