Channel Class Reference
#include <channel.h>
Inherits UserList.
Public Types | |
| typedef std::map< wxString, User * > | user_map_t |
| mapping from nick to user object | |
| typedef user_map_t::iterator | user_iter_t |
| iterator for user map | |
| typedef user_map_t::const_iterator | user_const_iter_t |
Public Member Functions | |
| Channel (Server &serv) | |
| virtual | ~Channel () |
| Server & | GetServer () |
| void | SetName (const wxString &name) |
| wxString | GetName () |
| User & | GetMe () |
| void | CheckBanned (const wxString &name) |
| bool | IsBanned (const wxString &name) |
| void | Say (const wxString &message) |
| void | DoAction (const wxString &action) |
| void | Leave () |
| void | Rejoin () |
| void | Said (User &who, const wxString &message) |
| void | DidAction (User &who, const wxString &action) |
| void | Left (User &who, const wxString &reason) |
| void | Joined (User &who) |
| void | OnChannelJoin (User &who) |
| void | SetTopic (const wxString &topic, const wxString &who) |
| wxString | GetTopic () |
| wxString | GetTopicSetBy () |
| bool | ExecuteSayCommand (const wxString &in) |
| wxString | GetPassword () |
| void | SetPassword (const wxString &pw) |
| User & | GetUser (wxString const &nick) const |
| User & | GetUser (user_map_t::size_type index) const |
| bool | UserExists (wxString const &nick) const |
| user_map_t::size_type | GetNumUsers () const |
| void | Nullify () |
Data Fields | |
| UiChannelData | uidata |
Protected Member Functions | |
| void | AddUser (User &user) |
| void | RemoveUser (const wxString &nick) |
Protected Attributes | |
| Server & | m_serv |
| std::set< wxString > | m_banned_users |
| bool | m_do_ban_regex |
| wxRegEx | m_ban_regex |
| bool | m_do_unban_regex |
| wxRegEx | m_unban_regex |
| wxString | m_ban_regex_msg |
| wxString | m_topic |
| wxString | m_topic_nick |
| wxString | m_name |
| void * | m_userdata |
| wxString | m_password |
Detailed Description
Definition at line 20 of file channel.h.
Member Typedef Documentation
typedef user_map_t::const_iterator UserList::user_const_iter_t [inherited] |
Definition at line 16 of file userlist.h.
typedef user_map_t::iterator UserList::user_iter_t [inherited] |
iterator for user map
Definition at line 15 of file userlist.h.
typedef std::map<wxString, User*> UserList::user_map_t [inherited] |
mapping from nick to user object
Definition at line 13 of file userlist.h.
Constructor & Destructor Documentation
| Channel::Channel | ( | Server & | serv | ) |
Definition at line 17 of file channel.cpp.
| Channel::~Channel | ( | ) | [virtual] |
Definition at line 24 of file channel.cpp.
Member Function Documentation
| void Channel::AddUser | ( | User & | user | ) | [protected] |
Reimplemented from UserList.
Definition at line 124 of file channel.cpp.
| void Channel::CheckBanned | ( | const wxString & | name | ) |
Definition at line 130 of file channel.cpp.
Definition at line 59 of file channel.cpp.
| void Channel::DoAction | ( | const wxString & | action | ) |
Definition at line 65 of file channel.cpp.
| bool Channel::ExecuteSayCommand | ( | const wxString & | in | ) |
this instance is not replaced with GetAppname for sake of help/debug online
Definition at line 159 of file channel.cpp.
| User & Channel::GetMe | ( | ) |
Definition at line 40 of file channel.cpp.
| wxString Channel::GetName | ( | ) |
Definition at line 34 of file channel.cpp.
| UserList::user_map_t::size_type UserList::GetNumUsers | ( | ) | const [inherited] |
Definition at line 52 of file userlist.cpp.
| wxString Channel::GetPassword | ( | ) |
Definition at line 232 of file channel.cpp.
| wxString Channel::GetTopic | ( | ) |
Definition at line 118 of file channel.cpp.
| wxString Channel::GetTopicSetBy | ( | ) |
Definition at line 112 of file channel.cpp.
| User & UserList::GetUser | ( | user_map_t::size_type | index | ) | const [inherited] |
Definition at line 36 of file userlist.cpp.
Definition at line 28 of file userlist.cpp.
| bool Channel::IsBanned | ( | const wxString & | name | ) |
Definition at line 143 of file channel.cpp.
| void Channel::Joined | ( | User & | who | ) |
Definition at line 90 of file channel.cpp.
| void Channel::Leave | ( | ) |
Definition at line 79 of file channel.cpp.
Definition at line 72 of file channel.cpp.
| void UserList::Nullify | ( | ) | [inherited] |
Definition at line 57 of file userlist.cpp.
| void Channel::OnChannelJoin | ( | User & | who | ) |
Definition at line 97 of file channel.cpp.
| void Channel::Rejoin | ( | ) |
Definition at line 84 of file channel.cpp.
| void Channel::RemoveUser | ( | const wxString & | nick | ) | [protected] |
Reimplemented from UserList.
Definition at line 153 of file channel.cpp.
Definition at line 46 of file channel.cpp.
| void Channel::Say | ( | const wxString & | message | ) |
Definition at line 52 of file channel.cpp.
| void Channel::SetName | ( | const wxString & | name | ) |
Definition at line 28 of file channel.cpp.
| void Channel::SetPassword | ( | const wxString & | pw | ) |
Definition at line 238 of file channel.cpp.
Definition at line 104 of file channel.cpp.
| bool UserList::UserExists | ( | wxString const & | nick | ) | const [inherited] |
Definition at line 47 of file userlist.cpp.
Field Documentation
wxRegEx Channel::m_ban_regex [protected] |
wxString Channel::m_ban_regex_msg [protected] |
std::set<wxString> Channel::m_banned_users [protected] |
bool Channel::m_do_ban_regex [protected] |
bool Channel::m_do_unban_regex [protected] |
wxString Channel::m_name [protected] |
wxString Channel::m_password [protected] |
Server& Channel::m_serv [protected] |
wxString Channel::m_topic [protected] |
wxString Channel::m_topic_nick [protected] |
wxRegEx Channel::m_unban_regex [protected] |
void* Channel::m_userdata [protected] |
The documentation for this class was generated from the following files:
- /home/buildbot/slaves/docs/docs/build/src/channel/channel.h
- /home/buildbot/slaves/docs/docs/build/src/channel/channel.cpp
