KTp::Presence Class Reference

#include <presence.h>

Inheritance diagram for KTp::Presence:

Public Member Functions
	Presence ()
	Presence (const Tp::Presence &presence)
QString	displayString () const
KIcon	icon (bool useImIcons=false) const
KIcon	icon (QStringList overlays, bool useImIcons=false) const
QString	iconName (bool useImIcons=false) const
bool	operator< (const Presence &other) const

Static Public Member Functions
static int	sortPriority (const Tp::ConnectionPresenceType &type)

Detailed Description

Definition at line 34 of file presence.h.

Constructor & Destructor Documentation

KTp::Presence::Presence

(

)

Definition at line 30 of file presence.cpp.

KTp::Presence::Presence

(

const Tp::Presence &

presence

)

Definition at line 35 of file presence.cpp.

Member Function Documentation

QString KTp::Presence::displayString

(

)

const

Get a i18n string representing the presence.

Returns

An i18n string representing the presence.

Definition at line 91 of file presence.cpp.

KIcon KTp::Presence::icon

(

bool

useImIcons = false

)

const

Get the icon for the presence.

Parameters

useImIcons

Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").

Returns

The icon for the current presence.

Definition at line 40 of file presence.cpp.

KIcon KTp::Presence::icon	(	QStringList	overlays,
		bool	useImIcons = false
	)		const

Get the icon for the presence with the specified overlays.

Parameters

overlays	The overlays to apply at the icon.
useImIcons	Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").

Returns

The icon for the current presence.

Definition at line 48 of file presence.cpp.

QString KTp::Presence::iconName

(

bool

useImIcons = false

)

const

Get the name of the icon for the presence.

This is useful for example if you want to create an icon using the presence as overlay.

Parameters

useImIcons

Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").

Returns

The name of the icon for the current presence.

Definition at line 59 of file presence.cpp.

bool KTp::Presence::operator<

(

const Presence &

other

)

const

Returns which presence is "more available".

Definition at line 80 of file presence.cpp.

int KTp::Presence::sortPriority ( const Tp::ConnectionPresenceType &  type )

static

Returns an int representation of the presence type sorted by priority.

0 - most online, 7 - offline

Definition at line 111 of file presence.cpp.

---

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

• presence.h
• presence.cpp