LeechCraft  0.6.70-13605-g8cd066ad6a
Modular cross-platform feature rich live environment.
constants.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <QString>
33 #include <QFlags>
34 
35 namespace LC
36 {
37 namespace AN
38 {
43  Q_DECL_IMPORT extern const QString CatEventCancel;
44 
47  Q_DECL_IMPORT extern const QString CatIM;
48 
51  Q_DECL_IMPORT extern const QString TypeIMAttention;
52 
55  Q_DECL_IMPORT extern const QString TypeIMIncFile;
56 
59  Q_DECL_IMPORT extern const QString TypeIMIncMsg;
60 
68  Q_DECL_IMPORT extern const QString TypeIMMUCHighlight;
69 
72  Q_DECL_IMPORT extern const QString TypeIMMUCInvite;
73 
81  Q_DECL_IMPORT extern const QString TypeIMMUCMsg;
82 
86  Q_DECL_IMPORT extern const QString TypeIMStatusChange;
87 
90  Q_DECL_IMPORT extern const QString TypeIMSubscrGrant;
91 
94  Q_DECL_IMPORT extern const QString TypeIMSubscrRevoke;
95 
98  Q_DECL_IMPORT extern const QString TypeIMSubscrRequest;
99 
102  Q_DECL_IMPORT extern const QString TypeIMSubscrSub;
103 
106  Q_DECL_IMPORT extern const QString TypeIMSubscrUnsub;
107 
110  Q_DECL_IMPORT extern const QString TypeIMEventTuneChange;
111 
114  Q_DECL_IMPORT extern const QString TypeIMEventMoodChange;
115 
118  Q_DECL_IMPORT extern const QString TypeIMEventActivityChange;
119 
122  Q_DECL_IMPORT extern const QString TypeIMEventLocationChange;
123 
126  Q_DECL_IMPORT extern const QString CatOrganizer;
127 
130  Q_DECL_IMPORT extern const QString TypeOrganizerEventDue;
131 
134  Q_DECL_IMPORT extern const QString CatDownloads;
135 
138  Q_DECL_IMPORT extern const QString TypeDownloadFinished;
139 
142  Q_DECL_IMPORT extern const QString TypeDownloadError;
143 
146  Q_DECL_IMPORT extern const QString CatPackageManager;
147 
150  Q_DECL_IMPORT extern const QString TypePackageUpdated;
151 
154  Q_DECL_IMPORT extern const QString CatMediaPlayer;
155 
158  Q_DECL_IMPORT extern const QString TypeMediaPlaybackStatus;
159 
162  Q_DECL_IMPORT extern const QString CatTerminal;
163 
166  Q_DECL_IMPORT extern const QString TypeTerminalBell;
167 
170  Q_DECL_IMPORT extern const QString TypeTerminalActivity;
171 
174  Q_DECL_IMPORT extern const QString TypeTerminalInactivity;
175 
178  Q_DECL_IMPORT extern const QString CatNews;
179 
182  Q_DECL_IMPORT extern const QString TypeNewsSourceUpdated;
183 
186  Q_DECL_IMPORT extern const QString TypeNewsSourceBroken;
187 
190  Q_DECL_IMPORT extern const QString CatGeneric;
191 
194  Q_DECL_IMPORT extern const QString TypeGeneric;
195 
198  enum NotifyFlag
199  {
202  NotifyNone = 0,
203 
210  NotifySingleShot = 1 << 0,
211 
221  NotifyTransient = 1 << 1,
222 
233  NotifyPersistent = 1 << 2,
234 
237  NotifyAudio = 1 << 3
238  };
239  Q_DECLARE_FLAGS (NotifyFlags, NotifyFlag);
240 
241  namespace Field
242  {
245  Q_DECL_IMPORT extern const QString MediaPlayerURL;
246 
254  Q_DECL_IMPORT extern const QString MediaPlaybackStatus;
255 
258  Q_DECL_IMPORT extern const QString MediaTitle;
259 
262  Q_DECL_IMPORT extern const QString MediaArtist;
263 
266  Q_DECL_IMPORT extern const QString MediaAlbum;
267 
270  Q_DECL_IMPORT extern const QString MediaLength;
271 
274  Q_DECL_IMPORT extern const QString TerminalActive;
275 
278  Q_DECL_IMPORT extern const QString IMActivityGeneral;
279 
282  Q_DECL_IMPORT extern const QString IMActivitySpecific;
283 
286  Q_DECL_IMPORT extern const QString IMActivityText;
287 
290  Q_DECL_IMPORT extern const QString IMMoodGeneral;
291 
294  Q_DECL_IMPORT extern const QString IMMoodText;
295 
298  Q_DECL_IMPORT extern const QString IMLocationLongitude;
299 
302  Q_DECL_IMPORT extern const QString IMLocationLatitude;
303 
306  Q_DECL_IMPORT extern const QString IMLocationCountry;
307 
311  Q_DECL_IMPORT extern const QString IMLocationLocality;
312 
315  Q_DECL_IMPORT extern const QString NewsSourceName;
316  }
317 }
318 }
319 
320 Q_DECLARE_OPERATORS_FOR_FLAGS (LC::AN::NotifyFlags)
LC::AN::Field::IMLocationLocality
const Q_DECL_IMPORT QString IMLocationLocality
Exact locality, like a town or a city, a contact is currently in (QString).
Definition: anconstantsdefs.cpp:124
LC::AN::Field::MediaArtist
const Q_DECL_IMPORT QString MediaArtist
The artist of the currently playing media (QString).
Definition: anconstantsdefs.cpp:112
LC::AN::TypeIMEventMoodChange
const Q_DECL_IMPORT QString TypeIMEventMoodChange
User's mood has changed.
Definition: anconstantsdefs.cpp:78
LC::AN::TypeTerminalActivity
const Q_DECL_IMPORT QString TypeTerminalActivity
Activity in terminal window.
Definition: anconstantsdefs.cpp:97
LC::AN::TypeIMEventLocationChange
const Q_DECL_IMPORT QString TypeIMEventLocationChange
User's location has changed.
Definition: anconstantsdefs.cpp:80
LC::AN::Field::IMActivitySpecific
const Q_DECL_IMPORT QString IMActivitySpecific
Specific activity name of a contact (QString).
Definition: anconstantsdefs.cpp:117
LC::AN::TypeIMSubscrGrant
const Q_DECL_IMPORT QString TypeIMSubscrGrant
Another user has granted subscription to our user.
Definition: anconstantsdefs.cpp:72
LC::AN::TypeIMSubscrUnsub
const Q_DECL_IMPORT QString TypeIMSubscrUnsub
Another user has unsubscribed from our user.
Definition: anconstantsdefs.cpp:76
LC::AN::Field::TerminalActive
const Q_DECL_IMPORT QString TerminalActive
Whether the terminal window is active (bool).
Definition: anconstantsdefs.cpp:115
LC::AN::Field::IMActivityGeneral
const Q_DECL_IMPORT QString IMActivityGeneral
General activity name of a contact (QString).
Definition: anconstantsdefs.cpp:116
LC::AN::Field::MediaAlbum
const Q_DECL_IMPORT QString MediaAlbum
The album of the currently playing media (QString).
Definition: anconstantsdefs.cpp:113
LC::AN::CatDownloads
const Q_DECL_IMPORT QString CatDownloads
Category of Downloads-related events.
Definition: anconstantsdefs.cpp:85
LC::AN::TypeOrganizerEventDue
const Q_DECL_IMPORT QString TypeOrganizerEventDue
An event due date is coming.
Definition: anconstantsdefs.cpp:83
LC::AN::NotifyNone
No notifications.
Definition: constants.h:253
LC::AN::TypeGeneric
const Q_DECL_IMPORT QString TypeGeneric
Generic type for generic notifications.
Definition: anconstantsdefs.cpp:105
LC::AN::CatOrganizer
const Q_DECL_IMPORT QString CatOrganizer
Category of Organizer-related events.
Definition: anconstantsdefs.cpp:82
LC::AN::TypeTerminalBell
const Q_DECL_IMPORT QString TypeTerminalBell
A bell has ringed in a terminal window.
Definition: anconstantsdefs.cpp:96
LC::AN::CatIM
const Q_DECL_IMPORT QString CatIM
Category of Instant Messaging-related events.
Definition: anconstantsdefs.cpp:64
LC::AN::TypeIMSubscrSub
const Q_DECL_IMPORT QString TypeIMSubscrSub
Another user has subscribed to our user.
Definition: anconstantsdefs.cpp:75
LC::AN::Field::NewsSourceName
const Q_DECL_IMPORT QString NewsSourceName
News source name (QString).
Definition: anconstantsdefs.cpp:125
LC::AN::NotifySingleShot
Rule should be triggered only once.
Definition: constants.h:261
LC::AN::TypeIMMUCInvite
const Q_DECL_IMPORT QString TypeIMMUCInvite
User has been invited to a multiuser chat.
Definition: anconstantsdefs.cpp:69
LC::AN::NotifyTransient
User should be notified visually.
Definition: constants.h:272
LC::AN::Field::IMLocationLongitude
const Q_DECL_IMPORT QString IMLocationLongitude
Longitude of a contact's position (double).
Definition: anconstantsdefs.cpp:121
LC::AN::TypeTerminalInactivity
const Q_DECL_IMPORT QString TypeTerminalInactivity
Inactivity in terminal window.
Definition: anconstantsdefs.cpp:98
LC::AN::TypeNewsSourceBroken
const Q_DECL_IMPORT QString TypeNewsSourceBroken
News source is detected to be broken.
Definition: anconstantsdefs.cpp:102
LC::AN::CatNews
const Q_DECL_IMPORT QString CatNews
Category for news-related events.
Definition: anconstantsdefs.cpp:100
LC::AN::TypeDownloadFinished
const Q_DECL_IMPORT QString TypeDownloadFinished
A download has been finished successfully without errors.
Definition: anconstantsdefs.cpp:86
LC::AN::TypeNewsSourceUpdated
const Q_DECL_IMPORT QString TypeNewsSourceUpdated
News source got updated.
Definition: anconstantsdefs.cpp:101
LC::AN::NotifyPersistent
User should be notified visually via persistent notifications.
Definition: constants.h:284
LC::AN::TypeIMEventTuneChange
const Q_DECL_IMPORT QString TypeIMEventTuneChange
User's tune has changed.
Definition: anconstantsdefs.cpp:77
LC::AN::TypeIMIncFile
const Q_DECL_IMPORT QString TypeIMIncFile
Another user has sent our user a file.
Definition: anconstantsdefs.cpp:66
LC::AN::Field::MediaTitle
const Q_DECL_IMPORT QString MediaTitle
The title of the currently playing media (QString).
Definition: anconstantsdefs.cpp:111
LC::AN::Field::IMActivityText
const Q_DECL_IMPORT QString IMActivityText
Accompanying activity text entered by a contact (QString).
Definition: anconstantsdefs.cpp:118
LC::AN::Q_DECLARE_FLAGS
Q_DECLARE_FLAGS(NotifyFlags, NotifyFlag)
LC::AN::NotifyFlag
NotifyFlag
Describes the notification parameters.
Definition: constants.h:249
LC::AN::Field::MediaPlaybackStatus
const Q_DECL_IMPORT QString MediaPlaybackStatus
Playback status of the URL (QString).
Definition: anconstantsdefs.cpp:110
LC::AN::TypeIMStatusChange
const Q_DECL_IMPORT QString TypeIMStatusChange
Another user in our user's contact list has changed its status.
Definition: anconstantsdefs.cpp:71
LC::AN::TypeIMMUCMsg
const Q_DECL_IMPORT QString TypeIMMUCMsg
A message has been sent to a multiuser chat.
Definition: anconstantsdefs.cpp:70
LC::AN::CatMediaPlayer
const Q_DECL_IMPORT QString CatMediaPlayer
Category of media player-related events.
Definition: anconstantsdefs.cpp:92
LC
Definition: constants.h:34
LC::AN::Field::MediaPlayerURL
const Q_DECL_IMPORT QString MediaPlayerURL
The URL to the file being played.
Definition: anconstantsdefs.cpp:109
LC::AN::Field::IMLocationCountry
const Q_DECL_IMPORT QString IMLocationCountry
Country a contact is currently in (QString).
Definition: anconstantsdefs.cpp:123
LC::AN::CatGeneric
const Q_DECL_IMPORT QString CatGeneric
Generic notifications that don't fit into any other category.
Definition: anconstantsdefs.cpp:104
LC::AN::TypeIMAttention
const Q_DECL_IMPORT QString TypeIMAttention
Another user has requested our user's attention.
Definition: anconstantsdefs.cpp:65
LC::AN::CatEventCancel
const Q_DECL_IMPORT QString CatEventCancel
Event cancel pseudo-category.
Definition: anconstantsdefs.cpp:62
LC::AN::TypeMediaPlaybackStatus
const Q_DECL_IMPORT QString TypeMediaPlaybackStatus
A media file playback status has been changed.
Definition: anconstantsdefs.cpp:93
LC::AN::TypeDownloadError
const Q_DECL_IMPORT QString TypeDownloadError
A download has been failed.
Definition: anconstantsdefs.cpp:87
LC::AN::TypePackageUpdated
const Q_DECL_IMPORT QString TypePackageUpdated
A package has been updated.
Definition: anconstantsdefs.cpp:90
LC::AN::Field::MediaLength
const Q_DECL_IMPORT QString MediaLength
The length of the currently playing media (int).
Definition: anconstantsdefs.cpp:114
LC::AN::CatPackageManager
const Q_DECL_IMPORT QString CatPackageManager
Category of package manager-related events.
Definition: anconstantsdefs.cpp:89
LC::AN::TypeIMSubscrRequest
const Q_DECL_IMPORT QString TypeIMSubscrRequest
Another user has requested subscription from our user.
Definition: anconstantsdefs.cpp:74
LC::AN::Field::IMLocationLatitude
const Q_DECL_IMPORT QString IMLocationLatitude
Latitude of a contact's position (double).
Definition: anconstantsdefs.cpp:122
LC::AN::TypeIMIncMsg
const Q_DECL_IMPORT QString TypeIMIncMsg
User has received a message in a standard one-to-one chat.
Definition: anconstantsdefs.cpp:67
LC::AN::TypeIMEventActivityChange
const Q_DECL_IMPORT QString TypeIMEventActivityChange
User's activity has changed.
Definition: anconstantsdefs.cpp:79
LC::AN::Field::IMMoodText
const Q_DECL_IMPORT QString IMMoodText
Accompanying mood text entered by a contact (QString).
Definition: anconstantsdefs.cpp:120
LC::AN::Field::IMMoodGeneral
const Q_DECL_IMPORT QString IMMoodGeneral
General mood name of a contact (QString).
Definition: anconstantsdefs.cpp:119
LC::AN::TypeIMMUCHighlight
const Q_DECL_IMPORT QString TypeIMMUCHighlight
User has been highlighted in a multiuser chat.
Definition: anconstantsdefs.cpp:68
LC::AN::TypeIMSubscrRevoke
const Q_DECL_IMPORT QString TypeIMSubscrRevoke
Another user has revoked subscription from our user.
Definition: anconstantsdefs.cpp:73
LC::AN::NotifyAudio
Notify by playing back an audio file.
Definition: constants.h:288
LC::AN::CatTerminal
const Q_DECL_IMPORT QString CatTerminal
Category for terminal emulation events.
Definition: anconstantsdefs.cpp:95