KDE 4.0 API Reference kopete/libkopete
Kopete::Group Class Reference
#include <kopetegroup.h>
Detailed Description
Class which represents the Group.A Group is a ConstacListElement which means plugin can save data.
some static group are availavle from this class: topLevel and temporary
Definition at line 44 of file kopetegroup.h.
Public Types | |
| enum | GroupType { Normal = 0, Temporary, TopLevel } |
| typedef QList< Group * > | List |
Public Slots | |
| void | sendMessage () |
Signals | |
| void | displayNameChanged (Kopete::Group *group, const QString &oldName) |
Public Member Functions | |
| Group () | |
| Group (const QString &displayName, GroupType type=Normal) | |
| ~Group () | |
| QString | displayName () const |
| void | setDisplayName (const QString &newName) |
| GroupType | type () const |
| void | setType (GroupType newType) |
| uint | groupId () const |
| QList< MetaContact * > | members () const |
| void | setExpanded (bool expanded) |
| bool | isExpanded () const |
| void | setGroupId (uint groupId) |
| uint | uniqueGroupId () const |
| void | setUniqueGroupId (uint uniqueGroupId) |
Static Public Member Functions | |
| static Group * | topLevel () |
| static Group * | temporary () |
Properties | |
| QString | displayName |
| uint | groupId |
| bool | expanded |
Member Typedef Documentation
| typedef QList<Group*> Kopete::Group::List |
Definition at line 53 of file kopetegroup.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
| Kopete::Group::Group | ( | ) |
Create an empty group.
Note that the constructor will not add the group automatically to the contact list. Use ContactList::addGroup() to add it
Definition at line 61 of file kopetegroup.cpp.
Create a group of the specified type.
Overloaded constructor to create a group with a display name of the specified type.
Definition at line 51 of file kopetegroup.cpp.
| Kopete::Group::~Group | ( | ) |
Definition at line 70 of file kopetegroup.cpp.
Member Function Documentation
| QString Kopete::Group::displayName | ( | ) | const |
Return the group's display name.
- Returns:
- the display name of the group
| void Kopete::Group::setDisplayName | ( | const QString & | newName | ) |
| Group::GroupType Kopete::Group::type | ( | ) | const |
| void Kopete::Group::setType | ( | GroupType | newType | ) |
| uint Kopete::Group::groupId | ( | ) | const |
- Returns:
- the unique id for this group
| QList< MetaContact * > Kopete::Group::members | ( | ) | const |
child metacontact This function is not very efficient - it searches through all the metacontacts in the contact list
- Returns:
- the members of this group
Definition at line 79 of file kopetegroup.cpp.
| void Kopete::Group::setExpanded | ( | bool | expanded | ) |
| bool Kopete::Group::isExpanded | ( | ) | const |
- Returns:
- true if the group is expanded.
- Returns:
- false otherwise
Definition at line 123 of file kopetegroup.cpp.
| Group * Kopete::Group::topLevel | ( | ) | [static] |
| Group * Kopete::Group::temporary | ( | ) | [static] |
| void Kopete::Group::setGroupId | ( | uint | groupId | ) |
Definition at line 136 of file kopetegroup.cpp.
| uint Kopete::Group::uniqueGroupId | ( | ) | const |
Definition at line 141 of file kopetegroup.cpp.
| void Kopete::Group::setUniqueGroupId | ( | uint | uniqueGroupId | ) |
Definition at line 146 of file kopetegroup.cpp.
| void Kopete::Group::sendMessage | ( | ) | [slot] |
| void Kopete::Group::displayNameChanged | ( | Kopete::Group * | group, | |
| const QString & | oldName | |||
| ) | [signal] |
Emitted when the group has been renamed.
Property Documentation
QString Kopete::Group::displayName [read, write] |
Definition at line 46 of file kopetegroup.h.
uint Kopete::Group::groupId [read] |
Definition at line 47 of file kopetegroup.h.
bool Kopete::Group::expanded [read, write] |
Definition at line 48 of file kopetegroup.h.
The documentation for this class was generated from the following files:
