|
|
|
|
* This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * *************************************************************************
| explicit Channel (const QString& name) |
Create a channel with a specific name.
Parameters:
| name | The name of the new channel. |
| const ChanUser* findUser (QString nickname) |
Search the channel for a user with the specified nickname.
Parameters:
| nickname | The nickname of the user to find. |
Returns: A const pointer to the ChanUser object that represents the specified user, or 0 if nickname is not on the channel.
| bool isOp () |
Determines if the client is currently oped on the channel.
Returns: true if the client is oped on the channel, false otherwise.
| const QString& getName () |
Get the name of the channel object.
Returns: The name of the channel.
| const int getModes () |
Get the current modes on the channel.
Returns: A bitwise OR of the different mode constants. See static const definitions for a list of mode constants.
| const QString& getKey () |
Get the current channel key, if any.
Returns: The channel key if the channel has a key set, an empty string otherwise.
| const int getLimit () |
Get the current channel limit, if any.
Returns: The channel limit if the channel has one, 0 otherwise.
| const ChanUser* getMe () |
Get the ChanUser object associated with the client on the channel.
PRECONDITIONS: setMe() was called with a valid ChanUser object.
Returns: The ChanUser object that was set as associated with the client.
| const Ban* findBan (QString banMask) |
Find a specific ban in the channel banlist.
Parameters:
| banMask | the mask of the ban to search for. |
| UserListIterator* createUserListIterator () |
Get a UserListIterator on the channel's list of users. This allows to iterate over the channel's userlist. The order the users are listed is arbitrary.
NOTE: this method allocates memory for a new UserListIterator object. The calling method is responsible for freeing that memory.
Returns: A pointer to an iterator initialized to the first user on the channel (in arbitrary order).
| BanListIterator* createBanListIterator () |
Get a BanListIterator on the channel's banlist This allows to iterate over all the bans on the channel. The order the bans are listed is arbitrary.
NOTE: this method allocates memory for a new BanListIterator object. The calling method is responsible for freeing that memory.
Returns: A pointer to an iterator initialized to the first ban on the channel (in arbitrary order).
| void list () |
Temporary.
| void setModes (const int mode,char addDelete = '+') |
Add or remove a mode from the channel, depending on the addDelete flag.
Parameters:
| mode | The mode to change (as defined in Channel::Mode constants). |
| addDelete | Either '+' or '-'. The mode will be added if addDelete is '+', or removed if addDelete is '-'. |
| void setKey (const QString& key) |
Change the channel's key.
Parameters:
| key | The new channel key. |
| void addMode (const int value) |
Add the specified mode to the channel.
Parameters:
| value | The mode to add, as defined in Channel::Mode constants |
| void remMode (const int value) |
Remove the specified mode to the channel.
Parameters:
| value | The mode to remove, as defined in Channel::Mode constants |
| void setLimit (const int value) |
Change the channel's limit.
Parameters:
| value | The new channel limit. |
| void setMe (ChanUser* value) |
Change the channel's reference to which user is the program using the IRCModule.
PRECONDITIONS: value != 0
Parameters:
| value | A pointer to the ChanUser object representing the client. |
| void addBan (Ban* theBan) |
Adds a new ban to the channel's banlist.
Parameters:
| theBan | A pointer to the ban object to add to the list. This pointer should not be deleted or referenced after being added to the banlist. |
| void remBan (QString banMask) |
Remove a ban from the channel's banlist.
PRECONDITIONS: banMask != ""
Parameters:
| banMask | the mask of the ban to remove. The mask is case insensitive. |
| ChanUser* findUserForUpdate (QString nickname) |
Same as findUser , but returns a non-const pointer to the found user.
NOTE: The pointer returned by this method should not be deleted!
Parameters:
| nickname | The nick of the user to find. |
Returns: A pointer to the ChanUser object representing nickname, or 0 if the user was not found.
| void addUser (ChanUser* user) |
Add a user to the channel's userlist.
Parameters:
| user | A pointer to the ChanUser to add. That pointer must not be externaly deleted! |
| void remUser (const QString& nickname) |
Remove a user from the channel's userlist.
Parameters:
| nickname | The nick of the user to delete. Nothing happens if the user is not found. |
| Generated by: nightsky@centauri on Sat Jan 15 23:06:10 2000, using kdoc 2.0a30. |