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

kopete/libkopete

  • Kopete
  • OnlineStatusManager
Public Types | Signals | Public Member Functions | Static Public Member Functions | List of all members
Kopete::OnlineStatusManager Class Reference

#include <kopeteonlinestatusmanager.h>

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

Public Types

enum  Category {
  Idle =1<<8, ExtendedAway =1<<9, Invisible =1<<10, Busy =1<<5,
  FreeForChat =1<<6, Away =1<<2, Online =1<<1, Offline =1
}
 
enum  Option { HasStatusMessage = 0x01, DisabledIfOffline = 0x02, HideFromMenu = 0x04 }
 

Signals

void iconsChanged ()
 

Public Member Functions

 ~OnlineStatusManager ()
 
Kopete::OnlineStatusManager::Category initialStatus () const
 
OnlineStatus onlineStatus (Protocol *protocol, Categories category) const
 
QList< OnlineStatus > registeredStatusList (Protocol *protocol) const
 
void registerOnlineStatus (const OnlineStatus &status)
 

Static Public Member Functions

static KIcon pixmapForCategory (Categories category)
 
static OnlineStatusManager * self ()
 

Detailed Description

OnlineStatusManager is a singleton which manage OnlineStatus.

Author
Olivier Goffart

Definition at line 42 of file kopeteonlinestatusmanager.h.

Member Enumeration Documentation

enum Kopete::OnlineStatusManager::Category

Kopete will uses categories to have a more general system than simply globally away.

Idealy, in each protocol, there should be one status per categories (status may be in several or in none categories

Idle is the status used for auto-away

Status number are organised so that make a tree.

Enumerator
Idle 
ExtendedAway 
Invisible 
Busy 
FreeForChat 
Away 
Online 
Offline 

Definition at line 59 of file kopeteonlinestatusmanager.h.

enum Kopete::OnlineStatusManager::Option
See also
registerOnlineStatus
Enumerator
HasStatusMessage 

The user may set status messages for this online status.

DisabledIfOffline 

The action of the status will be disabled if the account is offline.

use it if your protocol doesn't support connecting with the status as initial status. You praticaly shouldn't abuse of that, and automatically set status after connecting if possible

HideFromMenu 

The status will not appears in the action menu.

Used if you want to register the status for e.g. autoaway, without letting the user set itself that status

Definition at line 76 of file kopeteonlinestatusmanager.h.

Constructor & Destructor Documentation

Kopete::OnlineStatusManager::~OnlineStatusManager ( )

Definition at line 64 of file kopeteonlinestatusmanager.cpp.

Member Function Documentation

void Kopete::OnlineStatusManager::iconsChanged ( )
signal
OnlineStatusManager::Category Kopete::OnlineStatusManager::initialStatus ( ) const

This returns status from config as Kopete::OnlineStatusManager::Category.

Returns
the desired initial status

Definition at line 130 of file kopeteonlinestatusmanager.cpp.

OnlineStatus Kopete::OnlineStatusManager::onlineStatus ( Protocol *  protocol,
Categories  category 
) const

return the status of the protocol which is in the category category

If no status has been registered in this category, return the one in the category which is the most similair

Definition at line 89 of file kopeteonlinestatusmanager.cpp.

KIcon Kopete::OnlineStatusManager::pixmapForCategory ( Categories  category)
static

return KIcon for given category

Definition at line 408 of file kopeteonlinestatusmanager.cpp.

QList< OnlineStatus > Kopete::OnlineStatusManager::registeredStatusList ( Protocol *  protocol) const

return the registered statuses for given protocol

Definition at line 403 of file kopeteonlinestatusmanager.cpp.

void Kopete::OnlineStatusManager::registerOnlineStatus ( const OnlineStatus &  status)

You need to register each status an account can be.

Registered statuses will appear in the account menu.

You should use a special OnlineStatus constructor that call this function automatically The Protocol constructor is a good place to construct the OnlineStatuses

You can set the status to be in the predefined categories. Ideally, each category should own one status. A status may be in several categories, or in none. There shouldn't be more than one status per protocol per categories.

Parameters
statusThe status to register

Definition at line 84 of file kopeteonlinestatusmanager.cpp.

OnlineStatusManager * Kopete::OnlineStatusManager::self ( )
static

Definition at line 49 of file kopeteonlinestatusmanager.cpp.


The documentation for this class was generated from the following files:
  • kopeteonlinestatusmanager.h
  • kopeteonlinestatusmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:52 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