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

kopete/kopete

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

#include <kopetestatusrootaction.h>

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

Public Types

enum  Filter { UseCategory, UseStatus, UseStatusAndCategory }
 

Signals

void changeMessage (const Kopete::StatusMessage &statusMessage)
 
void changeStatus (uint category, const Kopete::StatusMessage &statusMessage)
 
void updateMessage (Kopete::StatusRootAction *statusRootAction)
 

Public Member Functions

 StatusRootAction (KActionMenu *menu)
 
 StatusRootAction (KActionMenu *menu, Filter filter, Account *account, const OnlineStatus &onlineStatus, QAction *before=0)
 
 ~StatusRootAction ()
 
Account * account () const
 
int category () const
 
StatusRootAction::Filter filter () const
 
OnlineStatus onlineStatus () const
 
void setCurrentMessage (const Kopete::StatusMessage &statusMessage)
 

Static Public Member Functions

static void createAccountStatusActions (Account *account, KActionMenu *parent, QAction *before=0)
 

Protected Member Functions

void changeStatus (const Kopete::Status::Status *status)
 

Detailed Description

Author
Roman Jarosz kedge.nosp@m.dev@.nosp@m.centr.nosp@m.um.c.nosp@m.z

Definition at line 43 of file kopetestatusrootaction.h.

Member Enumeration Documentation

enum Kopete::StatusRootAction::Filter
Enumerator
UseCategory 
UseStatus 
UseStatusAndCategory 

Definition at line 47 of file kopetestatusrootaction.h.

Constructor & Destructor Documentation

Kopete::StatusRootAction::StatusRootAction ( KActionMenu *  menu)

StatusRootAction constructor.

Parameters
menuthe parent menu

The menu actions are automatically recreated if anything changes

Note
you should catch updateMessage, changeStatus and changeMessage signals

Definition at line 56 of file kopetestatusrootaction.cpp.

Kopete::StatusRootAction::StatusRootAction ( KActionMenu *  menu,
Filter  filter,
Account *  account,
const OnlineStatus &  onlineStatus,
QAction *  before = 0 
)

StatusRootAction constructor for specific account.

Parameters
menuthe parent menu
filtermenu filter type
accountkopete account
accountonline status

The menu actions are automatically recreated if anything changes

Note
you should catch updateMessage signal

Definition at line 66 of file kopetestatusrootaction.cpp.

Kopete::StatusRootAction::~StatusRootAction ( )

Definition at line 209 of file kopetestatusrootaction.cpp.

Member Function Documentation

Account * Kopete::StatusRootAction::account ( ) const

Get the account this root action was created for.

Returns
account for this root action or 0.

Definition at line 229 of file kopetestatusrootaction.cpp.

int Kopete::StatusRootAction::category ( ) const

Returns default category.

Definition at line 219 of file kopetestatusrootaction.cpp.

void Kopete::StatusRootAction::changeMessage ( const Kopete::StatusMessage &  statusMessage)
signal

Status message change request.

Parameters
statusMessageof new status

This signal is emitted when a status action is activated by the user

Note
this is only emitted if this object wasn't created for specific account
void Kopete::StatusRootAction::changeStatus ( uint  category,
const Kopete::StatusMessage &  statusMessage 
)
signal

Status category and message change request.

Parameters
categoryof new status
statusMessageof new status

This signal is emitted when a status action is activated by the user

Note
this is only emitted if this object wasn't create for specific account
void Kopete::StatusRootAction::changeStatus ( const Kopete::Status::Status *  status)
protected

Definition at line 320 of file kopetestatusrootaction.cpp.

void Kopete::StatusRootAction::createAccountStatusActions ( Account *  account,
KActionMenu *  parent,
QAction *  before = 0 
)
static

insert "setStatus" actions from the given account to the specified actionMenu.

(actions have that menu as parent QObject) they are connected to the Account::setOnlineStatus signal

Items are stored by status height.

Parameters
accountthe account
parentthe ActionMenu where action are inserted

Definition at line 80 of file kopetestatusrootaction.cpp.

StatusRootAction::Filter Kopete::StatusRootAction::filter ( ) const

Returns menu filter used for filtering the status actions.

Definition at line 214 of file kopetestatusrootaction.cpp.

OnlineStatus Kopete::StatusRootAction::onlineStatus ( ) const

Returns default online status.

Definition at line 224 of file kopetestatusrootaction.cpp.

void Kopete::StatusRootAction::setCurrentMessage ( const Kopete::StatusMessage &  statusMessage)

Set current status message.

Parameters
statusMessagecurrent status message

Definition at line 234 of file kopetestatusrootaction.cpp.

void Kopete::StatusRootAction::updateMessage ( Kopete::StatusRootAction *  statusRootAction)
signal

Update status message for this action.

Parameters
statusRootActionthe StatusRootAction object which emitted this signal

This signal is emitted before the status menu is shown and a object that is receiving this signal should update status message of statusRootAction with setCurrentMessage


The documentation for this class was generated from the following files:
  • kopetestatusrootaction.h
  • kopetestatusrootaction.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:41 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/kopete

Skip menu "kopete/kopete"
  • 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