1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
kopeteonlinestatusmanager.h
Copyright (c) 2004-2005 by Olivier Goffart <ogoffart @ kde.org>
Kopete (c) 2004-2005 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef kopeteonlinestatusmanager_h__
#define kopeteonlinestatusmanager_h__
#include <tqobject.h>
#include "kopeteonlinestatus.h"
#include "kaction.h"
class TQString;
class TQPixmap;
class TQColor;
class TDEActionMenu;
namespace Kopete
{
class OnlineStatus;
class Account;
/**
* OnlineStatusManager is a singleton which manage OnlineStatus
*
* @author Olivier Goffart
*/
class KOPETE_EXPORT OnlineStatusManager : public TQObject
{
Q_OBJECT
public:
static OnlineStatusManager* self();
~OnlineStatusManager();
/**
* Kopete will uses categories to have a more general system than siply globaly 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.
*/
//please be carrefull when modifying values of status. read comment in onlineStatus()
enum Categories
{
Idle=1<<8, ExtendedAway=1<<9 , Invisible=1<<10,
// \ / __________/
/*1<<4*/ Busy=1<<5, FreeForChat=1<<6, /* 1<<7*/
// \ / /
Away=1<<2, /* 1<<3 */
// \ /
Online=1<<1,
Offline=1
};
/**
* @see registerOnlineStatus
*/
enum Options
{
/// The user may set away messages for this online status
HasAwayMessage = 0x01,
/// 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 automaticaly set status after connecting if possible
DisabledIfOffline = 0x02,
/// 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
HideFromMenu = 0x04
};
/**
* You need to register each status an account can be.
* Registered statuses will appear in the account menu.
*
* The Protocol constructor is a good place to call this function.
* But if you want, you may use a special OnlineStatus constructor that call this function automaticaly
*
* 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.
*
* @param status The status to register
* @param caption The caption that will appear in menus (e.g. "Set &Away")
* @param categories A bitflag of @ref Categories
* @param options is a bitflag of @ref Options
*/
void registerOnlineStatus(const OnlineStatus& status, const TQString &caption, unsigned int categories=0x00 , unsigned int options=0x0);
/**
* insert "setStatus" actions from the given account to the specified actionMenu.
* (actions have that menu as parent TQObject)
* they are connected to the Account::setOnlineStatus signal
*
* Items are stored by status height.
*
* @param account the account
* @param parent the ActionMenu where action are inserted
*/
void createAccountStatusActions( Account *account , TDEActionMenu *parent);
/**
* return the status of the @p protocol which is in the category @p category
*
* If no status has been registered in this category, return the one in the category which is the most similair
*/
OnlineStatus onlineStatus(Protocol *protocol, Categories category) const;
private:
friend class OnlineStatus;
TQPixmap cacheLookupByObject( const OnlineStatus &statusFor, const TQString& icon, int size, TQColor color, bool idle = false);
TQPixmap cacheLookupByMimeSource( const TQString &mimeSource );
TQString fingerprint( const OnlineStatus &statusFor, const TQString& icon, int size, TQColor color, bool idle = false);
TQPixmap* renderIcon( const OnlineStatus &statusFor, const TQString& baseicon, int size, TQColor color, bool idle = false) const;
signals:
void iconsChanged();
private slots:
void slotIconsChanged();
private:
static OnlineStatusManager *s_self;
OnlineStatusManager();
class Private;
Private *d;
};
/**
* @internal
*/
class OnlineStatusAction : public TDEAction
{
Q_OBJECT
public:
OnlineStatusAction ( const OnlineStatus& status, const TQString &text, const TQIconSet &pix, TQObject *parent=0, const char *name=0);
signals:
void activated( const Kopete::OnlineStatus& status );
private slots:
void slotActivated();
private:
OnlineStatus m_status;
};
} //END namespace Kopete
#endif
// vim: set noet ts=4 sts=4 sw=4:
|
