LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 LeechCraft
36 {
37 namespace AN
38 {
43  const QString CatEventCancel = "org.LC.AdvNotifications.Cancel";
44 
47  const QString CatIM = "org.LC.AdvNotifications.IM";
50  const QString TypeIMAttention = CatIM + ".AttentionDrawn";
53  const QString TypeIMIncFile = CatIM + ".IncomingFile";
56  const QString TypeIMIncMsg = CatIM + ".IncomingMessage";
64  const QString TypeIMMUCHighlight = CatIM + ".MUCHighlightMessage";
67  const QString TypeIMMUCInvite = CatIM + ".MUCInvitation";
75  const QString TypeIMMUCMsg = CatIM + ".MUCMessage";
79  const QString TypeIMStatusChange = CatIM + ".StatusChange";
82  const QString TypeIMSubscrGrant = CatIM + ".Subscr.Granted";
85  const QString TypeIMSubscrRevoke = CatIM + ".Subscr.Revoked";
88  const QString TypeIMSubscrRequest = CatIM + ".Subscr.Requested";
91  const QString TypeIMSubscrSub = CatIM + ".Subscr.Subscribed";
94  const QString TypeIMSubscrUnsub = CatIM + ".Subscr.Unsubscribed";
95 
98  const QString CatOrganizer = "org.LC.AdvNotifications.Organizer";
101  const QString TypeOrganizerEventDue = CatOrganizer + ".EventDue";
102 
105  const QString CatDownloads = "org.LC.AdvNotifications.Downloads";
108  const QString TypeDownloadFinished = CatDownloads + ".DownloadFinished";
111  const QString TypeDownloadError = CatDownloads + ".DownloadError";
112 
115  const QString CatPackageManager = "org.LC.AdvNotifications.PackageManager";
118  const QString TypePackageUpdated = CatPackageManager + ".PackageUpdated";
119 
122  const QString CatMediaPlayer = "org.LC.AdvNotifications.MediaPlayer";
123 
126  const QString TypeMediaPlaybackStatus = CatMediaPlayer + ".PlaybackStatus";
127 
130  const QString CatTerminal = "org.LC.AdvNotifications.Terminal";
131 
134  const QString TypeTerminalBell = CatTerminal + ".Bell";
135 
138  const QString TypeTerminalActivity = CatTerminal + ".Activity";
139 
142  const QString TypeTerminalInactivity = CatTerminal + ".Inactivity";
143 
146  const QString CatGeneric = "org.LC.AdvNotifications.Generic";
147 
150  const QString TypeGeneric = CatGeneric + ".Generic";
151 
155  {
159 
167 
177  NotifyTransient = 1 << 1,
178 
190 
193  NotifyAudio = 1 << 3
194  };
195  Q_DECLARE_FLAGS (NotifyFlags, NotifyFlag);
196 
197  namespace Field
198  {
201  const QString MediaPlayerURL = CatMediaPlayer + ".Fields.URL";
202 
210  const QString MediaPlaybackStatus = CatMediaPlayer + ".Fields.PlaybackStatus";
211 
214  const QString MediaTitle = CatMediaPlayer + ".Fields.Title";
215 
218  const QString MediaArtist = CatMediaPlayer + ".Fields.Artist";
219 
222  const QString MediaAlbum = CatMediaPlayer + ".Fields.Album";
223 
226  const QString MediaLength = CatMediaPlayer + ".Fields.Length";
227 
230  const QString TerminalActive = CatTerminal + ".Fields.Active";
231  }
232 }
233 }
234 
235 Q_DECLARE_OPERATORS_FOR_FLAGS (LeechCraft::AN::NotifyFlags);
const QString TypeIMMUCHighlight
User has been highlighted in a multiuser chat.
Definition: constants.h:64
Q_DECLARE_OPERATORS_FOR_FLAGS(LeechCraft::AN::NotifyFlags)
const QString MediaArtist
The artist of the currently playing media (QString).
Definition: constants.h:218
const QString TypeGeneric
Generic type for generic notifications.
Definition: constants.h:150
const QString MediaAlbum
The album of the currently playing media (QString).
Definition: constants.h:222
const QString TypeIMIncMsg
User has received a message in a standard one-to-one chat.
Definition: constants.h:56
const QString CatDownloads
Category of Downloads-related events.
Definition: constants.h:105
const QString TypeOrganizerEventDue
An event due date is coming.
Definition: constants.h:101
const QString TypeIMSubscrRevoke
Another user has revoked subscription from our user.
Definition: constants.h:85
const QString TypeIMSubscrRequest
Another user has requested subscription from our user.
Definition: constants.h:88
NotifyFlag
Describes the notification parameters.
Definition: constants.h:154
Rule should be triggered only once.
Definition: constants.h:166
User should be notified visually.
Definition: constants.h:177
const QString TypeDownloadError
A download has been failed.
Definition: constants.h:111
const QString TypeIMSubscrGrant
Another user has granted subscription to our user.
Definition: constants.h:82
const QString TypeMediaPlaybackStatus
A media file playback status has been changed.
Definition: constants.h:126
const QString TypeTerminalBell
A bell has ringed in a terminal window.
Definition: constants.h:134
const QString TypeDownloadFinished
A download has been finished successfully without errors.
Definition: constants.h:108
const QString TypeTerminalActivity
Activity in terminal window.
Definition: constants.h:138
const QString TerminalActive
Whether the terminal window is active (bool).
Definition: constants.h:230
const QString CatEventCancel
Event cancel pseudo-category.
Definition: constants.h:43
const QString CatTerminal
Category for terminal emulation events.
Definition: constants.h:130
const QString TypeIMAttention
Another user has requested our user's attention.
Definition: constants.h:50
const QString TypeIMSubscrSub
Another user has subscribed to our user.
Definition: constants.h:91
const QString MediaTitle
The title of the currently playing media (QString).
Definition: constants.h:214
const QString CatPackageManager
Category of package manager-related events.
Definition: constants.h:115
const QString CatIM
Category of Instant Messaging-related events.
Definition: constants.h:47
const QString TypePackageUpdated
A package has been updated.
Definition: constants.h:118
const QString TypeIMMUCInvite
User has been invited to a multiuser chat.
Definition: constants.h:67
No notifications.
Definition: constants.h:158
const QString CatOrganizer
Category of Organizer-related events.
Definition: constants.h:98
const QString MediaPlaybackStatus
Playback status of the URL (QString).
Definition: constants.h:210
const QString TypeTerminalInactivity
Inactivity in terminal window.
Definition: constants.h:142
const QString CatMediaPlayer
Category of media player-related events.
Definition: constants.h:122
const QString TypeIMStatusChange
Another user in our user's contact list has changed its status.
Definition: constants.h:79
Q_DECLARE_FLAGS(NotifyFlags, NotifyFlag)
const QString MediaPlayerURL
The URL to the file being played.
Definition: constants.h:201
const QString MediaLength
The length of the currently playing media (int).
Definition: constants.h:226
User should be notified visually via persistent notifications.
Definition: constants.h:189
const QString CatGeneric
Generic notifications that don't fit into any other category.
Definition: constants.h:146
const QString TypeIMIncFile
Another user has sent our user a file.
Definition: constants.h:53
const QString TypeIMMUCMsg
A message has been sent to a multiuser chat.
Definition: constants.h:75
Notify by playing back an audio file.
Definition: constants.h:193
const QString TypeIMSubscrUnsub
Another user has unsubscribed from our user.
Definition: constants.h:94