LeechCraft  0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
LC::AN Namespace Reference

Namespaces

 EF
 Namespace for various AN entity fields.
 
 Field
 

Enumerations

enum  NotifyFlag {
  NotifyNone = 0,
  NotifySingleShot = 1 << 0,
  NotifyTransient = 1 << 1,
  NotifyPersistent = 1 << 2,
  NotifyAudio = 1 << 3
}
 Describes the notification parameters. More...
 

Functions

 Q_DECLARE_FLAGS (NotifyFlags, NotifyFlag)
 

Variables

Q_DECL_IMPORT const QString CatEventCancel { "org.LC.AdvNotifications.Cancel" }
 Event cancel pseudo-category. More...
 
Q_DECL_IMPORT const QString CatIM { "org.LC.AdvNotifications.IM" }
 Category of Instant Messaging-related events. More...
 
Q_DECL_IMPORT const QString TypeIMAttention { CatIM + ".AttentionDrawn" }
 Another user has requested our user's attention. More...
 
Q_DECL_IMPORT const QString TypeIMIncFile { CatIM + ".IncomingFile" }
 Another user has sent our user a file. More...
 
Q_DECL_IMPORT const QString TypeIMIncMsg { CatIM + ".IncomingMessage" }
 User has received a message in a standard one-to-one chat. More...
 
Q_DECL_IMPORT const QString TypeIMMUCHighlight { CatIM + ".MUCHighlightMessage" }
 User has been highlighted in a multiuser chat. More...
 
Q_DECL_IMPORT const QString TypeIMMUCInvite { CatIM + ".MUCInvitation" }
 User has been invited to a multiuser chat. More...
 
Q_DECL_IMPORT const QString TypeIMMUCMsg { CatIM + ".MUCMessage" }
 A message has been sent to a multiuser chat. More...
 
Q_DECL_IMPORT const QString TypeIMStatusChange { CatIM + ".StatusChange" }
 Another user in our user's contact list has changed its status. More...
 
Q_DECL_IMPORT const QString TypeIMSubscrGrant { CatIM + ".Subscr.Granted" }
 Another user has granted subscription to our user. More...
 
Q_DECL_IMPORT const QString TypeIMSubscrRevoke { CatIM + ".Subscr.Revoked" }
 Another user has revoked subscription from our user. More...
 
Q_DECL_IMPORT const QString TypeIMSubscrRequest { CatIM + ".Subscr.Requested" }
 Another user has requested subscription from our user. More...
 
Q_DECL_IMPORT const QString TypeIMSubscrSub { CatIM + ".Subscr.Subscribed" }
 Another user has subscribed to our user. More...
 
Q_DECL_IMPORT const QString TypeIMSubscrUnsub { CatIM + ".Subscr.Unsubscribed" }
 Another user has unsubscribed from our user. More...
 
Q_DECL_IMPORT const QString TypeIMEventTuneChange { CatIM + ".Event.Tune" }
 User's tune has changed. More...
 
Q_DECL_IMPORT const QString TypeIMEventMoodChange { CatIM + ".Event.Mood" }
 User's mood has changed. More...
 
Q_DECL_IMPORT const QString TypeIMEventActivityChange { CatIM + ".Event.Activity" }
 User's activity has changed. More...
 
Q_DECL_IMPORT const QString TypeIMEventLocationChange { CatIM + ".Event.Location" }
 User's location has changed. More...
 
Q_DECL_IMPORT const QString CatOrganizer { "org.LC.AdvNotifications.Organizer" }
 Category of Organizer-related events. More...
 
Q_DECL_IMPORT const QString TypeOrganizerEventDue { CatOrganizer + ".EventDue" }
 An event due date is coming. More...
 
Q_DECL_IMPORT const QString CatDownloads { "org.LC.AdvNotifications.Downloads" }
 Category of Downloads-related events. More...
 
Q_DECL_IMPORT const QString TypeDownloadFinished { CatDownloads + ".DownloadFinished" }
 A download has been finished successfully without errors. More...
 
Q_DECL_IMPORT const QString TypeDownloadError { CatDownloads + ".DownloadError" }
 A download has been failed. More...
 
Q_DECL_IMPORT const QString CatPackageManager { "org.LC.AdvNotifications.PackageManager" }
 Category of package manager-related events. More...
 
Q_DECL_IMPORT const QString TypePackageUpdated { CatPackageManager + ".PackageUpdated" }
 A package has been updated. More...
 
Q_DECL_IMPORT const QString CatMediaPlayer { "org.LC.AdvNotifications.MediaPlayer" }
 Category of media player-related events. More...
 
Q_DECL_IMPORT const QString TypeMediaPlaybackStatus { CatMediaPlayer + ".PlaybackStatus" }
 A media file playback status has been changed. More...
 
Q_DECL_IMPORT const QString CatTerminal { "org.LC.AdvNotifications.Terminal" }
 Category for terminal emulation events. More...
 
Q_DECL_IMPORT const QString TypeTerminalBell { CatTerminal + ".Bell" }
 A bell has ringed in a terminal window. More...
 
Q_DECL_IMPORT const QString TypeTerminalActivity { CatTerminal + ".Activity" }
 Activity in terminal window. More...
 
Q_DECL_IMPORT const QString TypeTerminalInactivity { CatTerminal + ".Inactivity" }
 Inactivity in terminal window. More...
 
Q_DECL_IMPORT const QString CatNews { "org.LC.AdvNotifications.News" }
 Category for news-related events. More...
 
Q_DECL_IMPORT const QString TypeNewsSourceUpdated { CatNews + ".Updated" }
 News source got updated. More...
 
Q_DECL_IMPORT const QString TypeNewsSourceBroken { CatNews + ".Broken" }
 News source is detected to be broken. More...
 
Q_DECL_IMPORT const QString CatGeneric { "org.LC.AdvNotifications.Generic" }
 Generic notifications that don't fit into any other category. More...
 
Q_DECL_IMPORT const QString TypeGeneric { CatGeneric + ".Generic" }
 Generic type for generic notifications. More...
 

Enumeration Type Documentation

◆ NotifyFlag

Describes the notification parameters.

Enumerator
NotifyNone 

No notifications.

NotifySingleShot 

Rule should be triggered only once.

This corresponds to the single shot events. That is, after first triggering of the rule it should be disabled and user shouldn't get further notifications.

NotifyTransient 

User should be notified visually.

The user should be notified via transient notifications like a non-intrusive tooltip that will hide soon.

This is ortogonal to NotifyPersistent.

See also
NotifyPersistent
NotifyPersistent 

User should be notified visually via persistent notifications.

A persistent notification is something like a tray icon that will be displayed until the user reacts to the event.

This is ortogonal to NotifyTransient.

See also
NotifyTransient
NotifyAudio 

Notify by playing back an audio file.

Definition at line 198 of file constants.h.

Function Documentation

◆ Q_DECLARE_FLAGS()

LC::AN::Q_DECLARE_FLAGS ( NotifyFlags  ,
NotifyFlag   
)

Variable Documentation

◆ CatDownloads

const QString LC::AN::CatDownloads { "org.LC.AdvNotifications.Downloads" }

Category of Downloads-related events.

Definition at line 59 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), and LC::Util::AN::GetKnownEventTypes().

◆ CatEventCancel

const QString LC::AN::CatEventCancel { "org.LC.AdvNotifications.Cancel" }

Event cancel pseudo-category.

This category is used to cancel an event by a given event ID.

Definition at line 36 of file anconstantsdefs.cpp.

Referenced by LC::Util::MakeANCancel().

◆ CatGeneric

const QString LC::AN::CatGeneric { "org.LC.AdvNotifications.Generic" }

Generic notifications that don't fit into any other category.

Definition at line 78 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), and LC::Util::AN::GetKnownEventTypes().

◆ CatIM

const QString LC::AN::CatIM { "org.LC.AdvNotifications.IM" }

Category of Instant Messaging-related events.

Definition at line 38 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), and LC::Util::AN::GetKnownEventTypes().

◆ CatMediaPlayer

const QString LC::AN::CatMediaPlayer { "org.LC.AdvNotifications.MediaPlayer" }

Category of media player-related events.

Definition at line 66 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), LC::Util::AN::GetKnownEventTypes(), and LC::Util::GetStdANFields().

◆ CatNews

const QString LC::AN::CatNews { "org.LC.AdvNotifications.News" }

Category for news-related events.

Definition at line 74 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), LC::Util::AN::GetKnownEventTypes(), and LC::Util::GetStdANFields().

◆ CatOrganizer

const QString LC::AN::CatOrganizer { "org.LC.AdvNotifications.Organizer" }

Category of Organizer-related events.

Definition at line 56 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), and LC::Util::AN::GetKnownEventTypes().

◆ CatPackageManager

const QString LC::AN::CatPackageManager { "org.LC.AdvNotifications.PackageManager" }

Category of package manager-related events.

Definition at line 63 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), and LC::Util::AN::GetKnownEventTypes().

◆ CatTerminal

const QString LC::AN::CatTerminal { "org.LC.AdvNotifications.Terminal" }

Category for terminal emulation events.

Definition at line 69 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap(), LC::Util::AN::GetKnownEventTypes(), and LC::Util::GetStdANFields().

◆ TypeDownloadError

const QString LC::AN::TypeDownloadError { CatDownloads + ".DownloadError" }

A download has been failed.

Definition at line 61 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeDownloadFinished

const QString LC::AN::TypeDownloadFinished { CatDownloads + ".DownloadFinished" }

A download has been finished successfully without errors.

Definition at line 60 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeGeneric

const QString LC::AN::TypeGeneric { CatGeneric + ".Generic" }

Generic type for generic notifications.

Definition at line 79 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMAttention

const QString LC::AN::TypeIMAttention { CatIM + ".AttentionDrawn" }

Another user has requested our user's attention.

Definition at line 39 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMEventActivityChange

const QString LC::AN::TypeIMEventActivityChange { CatIM + ".Event.Activity" }

User's activity has changed.

Definition at line 53 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeIMEventLocationChange

const QString LC::AN::TypeIMEventLocationChange { CatIM + ".Event.Location" }

User's location has changed.

Definition at line 54 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeIMEventMoodChange

const QString LC::AN::TypeIMEventMoodChange { CatIM + ".Event.Mood" }

User's mood has changed.

Definition at line 52 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeIMEventTuneChange

const QString LC::AN::TypeIMEventTuneChange { CatIM + ".Event.Tune" }

User's tune has changed.

Definition at line 51 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeIMIncFile

const QString LC::AN::TypeIMIncFile { CatIM + ".IncomingFile" }

Another user has sent our user a file.

Definition at line 40 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMIncMsg

const QString LC::AN::TypeIMIncMsg { CatIM + ".IncomingMessage" }

User has received a message in a standard one-to-one chat.

Definition at line 41 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMMUCHighlight

const QString LC::AN::TypeIMMUCHighlight { CatIM + ".MUCHighlightMessage" }

User has been highlighted in a multiuser chat.

The primary difference from TypeIMMUCMsg is that our user must be explicitly mentioned in another user's message for this event.

See also
TypeIMMUCMsg

Definition at line 42 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMMUCInvite

const QString LC::AN::TypeIMMUCInvite { CatIM + ".MUCInvitation" }

User has been invited to a multiuser chat.

Definition at line 43 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMMUCMsg

const QString LC::AN::TypeIMMUCMsg { CatIM + ".MUCMessage" }

A message has been sent to a multiuser chat.

This event should be emitted for each MUC message, even for those our user isn't mentioned in.

See also
TypeIMMUCHighlight

Definition at line 44 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMStatusChange

const QString LC::AN::TypeIMStatusChange { CatIM + ".StatusChange" }

Another user in our user's contact list has changed its status.

Definition at line 45 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMSubscrGrant

const QString LC::AN::TypeIMSubscrGrant { CatIM + ".Subscr.Granted" }

Another user has granted subscription to our user.

Definition at line 46 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMSubscrRequest

const QString LC::AN::TypeIMSubscrRequest { CatIM + ".Subscr.Requested" }

Another user has requested subscription from our user.

Definition at line 48 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMSubscrRevoke

const QString LC::AN::TypeIMSubscrRevoke { CatIM + ".Subscr.Revoked" }

Another user has revoked subscription from our user.

Definition at line 47 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMSubscrSub

const QString LC::AN::TypeIMSubscrSub { CatIM + ".Subscr.Subscribed" }

Another user has subscribed to our user.

Definition at line 49 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeIMSubscrUnsub

const QString LC::AN::TypeIMSubscrUnsub { CatIM + ".Subscr.Unsubscribed" }

Another user has unsubscribed from our user.

Definition at line 50 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeMediaPlaybackStatus

const QString LC::AN::TypeMediaPlaybackStatus { CatMediaPlayer + ".PlaybackStatus" }

A media file playback status has been changed.

Definition at line 67 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeNewsSourceBroken

const QString LC::AN::TypeNewsSourceBroken { CatNews + ".Broken" }

News source is detected to be broken.

Definition at line 76 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeNewsSourceUpdated

const QString LC::AN::TypeNewsSourceUpdated { CatNews + ".Updated" }

News source got updated.

Definition at line 75 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeOrganizerEventDue

const QString LC::AN::TypeOrganizerEventDue { CatOrganizer + ".EventDue" }

An event due date is coming.

Definition at line 57 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypePackageUpdated

const QString LC::AN::TypePackageUpdated { CatPackageManager + ".PackageUpdated" }

A package has been updated.

Definition at line 64 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), and LC::Util::AN::GetTypeName().

◆ TypeTerminalActivity

const QString LC::AN::TypeTerminalActivity { CatTerminal + ".Activity" }

Activity in terminal window.

Definition at line 71 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeTerminalBell

const QString LC::AN::TypeTerminalBell { CatTerminal + ".Bell" }

A bell has ringed in a terminal window.

Definition at line 70 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().

◆ TypeTerminalInactivity

const QString LC::AN::TypeTerminalInactivity { CatTerminal + ".Inactivity" }

Inactivity in terminal window.

Definition at line 72 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes(), LC::Util::GetStdANFields(), and LC::Util::AN::GetTypeName().