kopete/kopete

Kopete::StatusRootAction

Kopete::StatusRootAction Class Reference

#include <kopetestatusrootaction.h>

Inheritance diagram for Kopete::StatusRootAction:

[legend]

List of all members.

Detailed Description

Author:: Roman Jarosz <kedgedev@centrum.cz>

Definition at line 43 of file kopetestatusrootaction.h.


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
Account *	account () const
int	category () const
StatusRootAction::Filter	filter () const
OnlineStatus	onlineStatus () const
void	setCurrentMessage (const Kopete::StatusMessage &statusMessage)
	StatusRootAction (KActionMenu menu, Filter filter, Account account, const OnlineStatus &onlineStatus, QAction *before=0)
	StatusRootAction (KActionMenu *menu)
	~StatusRootAction ()
Static Public Member Functions
static void	createAccountStatusActions (Account account, KActionMenu parent, QAction *before=0)
Protected Member Functions
void	changeStatus (const Kopete::Status::Status *status)

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:

menu

the 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:

	menu	the parent menu
	filter	menu filter type
	account	kopete account
	account	online 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 198 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 218 of file kopetestatusrootaction.cpp.

int Kopete::StatusRootAction::category ( ) const

Returns default category.

Definition at line 208 of file kopetestatusrootaction.cpp.

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

Status message change request.

Parameters:

statusMessage

of 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 ( const Kopete::Status::Status * status ) [protected]

Definition at line 317 of file kopetestatusrootaction.cpp.

void Kopete::StatusRootAction::changeStatus	(	uint	category,
		const Kopete::StatusMessage &	statusMessage
	)			`[signal]`

Status category and message change request.

Parameters:

	category	of new status
	statusMessage	of 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::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:

	account	the account
	parent	the 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 203 of file kopetestatusrootaction.cpp.

OnlineStatus Kopete::StatusRootAction::onlineStatus ( ) const

Returns default online status.

Definition at line 213 of file kopetestatusrootaction.cpp.

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

Set current status message.

Parameters:

statusMessage

current status message

Definition at line 223 of file kopetestatusrootaction.cpp.

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

Update status message for this action.

Parameters:

statusRootAction

the 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:

kopete/kopete

Kopete::StatusRootAction Class Reference

Detailed Description

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/kopete

kdenetwork