• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • Group
Classes | Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Properties | List of all members
Kopete::Group Class Reference

#include <kopetegroup.h>

Inheritance diagram for Kopete::Group:
Inheritance graph
[legend]

Classes

class  Private
 

Public Types

enum  GroupType { Normal =0, Temporary, TopLevel, Offline }
 
typedef QList< Group * > List
 
- Public Types inherited from Kopete::ContactListElement
typedef QMap< QString, QString > ContactData
 
typedef QList< ContactData > ContactDataList
 
typedef QMap< IconState, QString > IconMap
 
enum  IconState {
  None, Open, Closed, Online,
  Away, Offline, Unknown
}
 
typedef QMap< QString, QMap
< QString, QString > > 
PluginDataMap
 

Public Slots

void sendMessage ()
 

Signals

void displayNameChanged (Kopete::Group *group, const QString &oldName)
 
- Signals inherited from Kopete::ContactListElement
void iconAppearanceChanged ()
 
void iconChanged (Kopete::ContactListElement::IconState, const QString &)
 
void pluginDataChanged ()
 
void useCustomIconChanged (bool useCustomIcon)
 
- Signals inherited from Kopete::PropertyContainer
void propertyChanged (Kopete::PropertyContainer *container, const QString &key, const QVariant &oldValue, const QVariant &newValue)
 

Public Member Functions

 Group ()
 
 Group (const QString &displayName)
 
 ~Group ()
 
QString displayName () const
 
uint groupId () const
 
bool isExpanded () const
 
QList< MetaContact * > members () const
 
void setDisplayName (const QString &newName)
 
void setExpanded (bool expanded)
 
void setGroupId (uint groupId)
 
void setUniqueGroupId (uint uniqueGroupId)
 
GroupType type () const
 
uint uniqueGroupId () const
 
- Public Member Functions inherited from Kopete::ContactListElement
void appendPluginContactData (const QString &pluginId, const ContactData &data)
 
void clearPluginContactData ()
 
QString icon (IconState state=None) const
 
const IconMap icons () const
 
bool loading () const
 
QMap< QString, ContactDataList > pluginContactData () const
 
ContactDataList pluginContactData (Plugin *plugin) const
 
QMap< QString, QString > pluginData (Plugin *plugin) const
 
QString pluginData (Plugin *plugin, const QString &key) const
 
const PluginDataMap pluginData () const
 
void setIcon (const QString &icon, IconState=None)
 
void setLoading (bool value)
 
void setPluginContactData (Plugin *plugin, const ContactDataList &dataList)
 
void setPluginData (Plugin *plugin, const QMap< QString, QString > &value)
 
void setPluginData (const QString &pluginId, const QMap< QString, QString > &pluginData)
 
void setPluginData (Plugin *plugin, const QString &key, const QString &value)
 
void setUseCustomIcon (bool useCustomIcon)
 
bool useCustomIcon () const
 
- Public Member Functions inherited from Kopete::PropertyContainer
 PropertyContainer (QObject *parent=0)
 
virtual ~PropertyContainer ()
 
void deserializeProperties (const QMap< QString, QString > &serializedData)
 
bool hasProperty (const QString &key) const
 
QStringList properties () const
 
const Kopete::Property & property (const QString &key) const
 
const Kopete::Property & property (const Kopete::PropertyTmpl &tmpl) const
 
void removeProperty (const Kopete::PropertyTmpl &tmpl)
 
void serializeProperties (QMap< QString, QString > &serializedData) const
 
void setProperty (const Kopete::PropertyTmpl &tmpl, const QVariant &value)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Static Public Member Functions

static Group * offline ()
 
static Group * temporary ()
 
static Group * topLevel ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Properties

QString displayName
 
bool expanded
 
uint groupId
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Protected Member Functions inherited from Kopete::ContactListElement
 ContactListElement (QObject *parent=0L)
 
 ~ContactListElement ()
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 

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

Author
Olivier Goffart ogoff.nosp@m.art@.nosp@m.kde.o.nosp@m.rg

Definition at line 44 of file kopetegroup.h.

Member Typedef Documentation

typedef QList<Group*> Kopete::Group::List

Definition at line 53 of file kopetegroup.h.

Member Enumeration Documentation

enum Kopete::Group::GroupType

Kinds of groups.

Enumerator
Normal 
Temporary 
TopLevel 
Offline 

Definition at line 56 of file kopetegroup.h.

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 79 of file kopetegroup.cpp.

Kopete::Group::Group ( const QString &  displayName)
explicit

Create a group of the specified type.

Overloaded constructor to create a group with a display name and Normal type.

Definition at line 61 of file kopetegroup.cpp.

Kopete::Group::~Group ( )

Definition at line 87 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::displayNameChanged ( Kopete::Group *  group,
const QString &  oldName 
)
signal

Emitted when the group has been renamed.

uint Kopete::Group::groupId ( ) const
Returns
the unique id for this group
bool Kopete::Group::isExpanded ( ) const
Returns
true if the group is expanded.
false otherwise

Definition at line 137 of file kopetegroup.cpp.

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 98 of file kopetegroup.cpp.

Group * Kopete::Group::offline ( )
static
Returns
a Group pointer to the offline group

Definition at line 51 of file kopetegroup.cpp.

void Kopete::Group::sendMessage ( )
slot

Send a message to all contacts in the group.

Definition at line 165 of file kopetegroup.cpp.

void Kopete::Group::setDisplayName ( const QString &  newName)

Rename the group.

Definition at line 110 of file kopetegroup.cpp.

void Kopete::Group::setExpanded ( bool  expanded)

Set if the group is expanded.

Definition at line 132 of file kopetegroup.cpp.

void Kopete::Group::setGroupId ( uint  groupId)

Definition at line 150 of file kopetegroup.cpp.

void Kopete::Group::setUniqueGroupId ( uint  uniqueGroupId)

Definition at line 160 of file kopetegroup.cpp.

Group * Kopete::Group::temporary ( )
static
Returns
a Group pointer to the temporary group

Definition at line 43 of file kopetegroup.cpp.

Group * Kopete::Group::topLevel ( )
static
Returns
a Group pointer to the toplevel group

Definition at line 35 of file kopetegroup.cpp.

Group::GroupType Kopete::Group::type ( ) const
Returns
the group type

Definition at line 127 of file kopetegroup.cpp.

uint Kopete::Group::uniqueGroupId ( ) const

Definition at line 155 of file kopetegroup.cpp.

Property Documentation

QString Kopete::Group::displayName
readwrite

Definition at line 46 of file kopetegroup.h.

bool Kopete::Group::expanded
readwrite

Definition at line 48 of file kopetegroup.h.

uint Kopete::Group::groupId
read

Definition at line 47 of file kopetegroup.h.


The documentation for this class was generated from the following files:
  • kopetegroup.h
  • kopetegroup.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal