LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
LeechCraft::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

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

Function Documentation

◆ Q_DECLARE_FLAGS()

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

Variable Documentation

◆ CatDownloads

const QString LeechCraft::AN::CatDownloads = "org.LC.AdvNotifications.Downloads"

Category of Downloads-related events.

Definition at line 117 of file constants.h.

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

◆ CatEventCancel

const QString LeechCraft::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 43 of file constants.h.

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

◆ CatGeneric

const QString LeechCraft::AN::CatGeneric = "org.LC.AdvNotifications.Generic"

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

Definition at line 158 of file constants.h.

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

◆ CatIM

const QString LeechCraft::AN::CatIM = "org.LC.AdvNotifications.IM"

Category of Instant Messaging-related events.

Definition at line 47 of file constants.h.

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

◆ CatMediaPlayer

const QString LeechCraft::AN::CatMediaPlayer = "org.LC.AdvNotifications.MediaPlayer"

Category of media player-related events.

Definition at line 134 of file constants.h.

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

◆ CatOrganizer

const QString LeechCraft::AN::CatOrganizer = "org.LC.AdvNotifications.Organizer"

Category of Organizer-related events.

Definition at line 110 of file constants.h.

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

◆ CatPackageManager

const QString LeechCraft::AN::CatPackageManager = "org.LC.AdvNotifications.PackageManager"

Category of package manager-related events.

Definition at line 127 of file constants.h.

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

◆ CatTerminal

const QString LeechCraft::AN::CatTerminal = "org.LC.AdvNotifications.Terminal"

Category for terminal emulation events.

Definition at line 142 of file constants.h.

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

◆ TypeDownloadError

const QString LeechCraft::AN::TypeDownloadError = CatDownloads + ".DownloadError"

A download has been failed.

Definition at line 123 of file constants.h.

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

◆ TypeDownloadFinished

const QString LeechCraft::AN::TypeDownloadFinished = CatDownloads + ".DownloadFinished"

A download has been finished successfully without errors.

Definition at line 120 of file constants.h.

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

◆ TypeGeneric

const QString LeechCraft::AN::TypeGeneric = CatGeneric + ".Generic"

Generic type for generic notifications.

Definition at line 162 of file constants.h.

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

◆ TypeIMAttention

const QString LeechCraft::AN::TypeIMAttention = CatIM + ".AttentionDrawn"

Another user has requested our user's attention.

Definition at line 50 of file constants.h.

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

◆ TypeIMEventActivityChange

const QString LeechCraft::AN::TypeIMEventActivityChange = CatIM + ".Event.Activity"

User's activity has changed.

Definition at line 103 of file constants.h.

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

◆ TypeIMEventLocationChange

const QString LeechCraft::AN::TypeIMEventLocationChange = CatIM + ".Event.Location"

User's location has changed.

Definition at line 106 of file constants.h.

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

◆ TypeIMEventMoodChange

const QString LeechCraft::AN::TypeIMEventMoodChange = CatIM + ".Event.Mood"

◆ TypeIMEventTuneChange

const QString LeechCraft::AN::TypeIMEventTuneChange = CatIM + ".Event.Tune"

◆ TypeIMIncFile

const QString LeechCraft::AN::TypeIMIncFile = CatIM + ".IncomingFile"

Another user has sent our user a file.

Definition at line 53 of file constants.h.

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

◆ TypeIMIncMsg

const QString LeechCraft::AN::TypeIMIncMsg = CatIM + ".IncomingMessage"

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

Definition at line 56 of file constants.h.

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

◆ TypeIMMUCHighlight

const QString LeechCraft::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 64 of file constants.h.

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

◆ TypeIMMUCInvite

const QString LeechCraft::AN::TypeIMMUCInvite = CatIM + ".MUCInvitation"

User has been invited to a multiuser chat.

Definition at line 67 of file constants.h.

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

◆ TypeIMMUCMsg

const QString LeechCraft::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 75 of file constants.h.

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

◆ TypeIMStatusChange

const QString LeechCraft::AN::TypeIMStatusChange = CatIM + ".StatusChange"

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

Definition at line 79 of file constants.h.

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

◆ TypeIMSubscrGrant

const QString LeechCraft::AN::TypeIMSubscrGrant = CatIM + ".Subscr.Granted"

Another user has granted subscription to our user.

Definition at line 82 of file constants.h.

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

◆ TypeIMSubscrRequest

const QString LeechCraft::AN::TypeIMSubscrRequest = CatIM + ".Subscr.Requested"

Another user has requested subscription from our user.

Definition at line 88 of file constants.h.

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

◆ TypeIMSubscrRevoke

const QString LeechCraft::AN::TypeIMSubscrRevoke = CatIM + ".Subscr.Revoked"

Another user has revoked subscription from our user.

Definition at line 85 of file constants.h.

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

◆ TypeIMSubscrSub

const QString LeechCraft::AN::TypeIMSubscrSub = CatIM + ".Subscr.Subscribed"

Another user has subscribed to our user.

Definition at line 91 of file constants.h.

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

◆ TypeIMSubscrUnsub

const QString LeechCraft::AN::TypeIMSubscrUnsub = CatIM + ".Subscr.Unsubscribed"

Another user has unsubscribed from our user.

Definition at line 94 of file constants.h.

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

◆ TypeMediaPlaybackStatus

const QString LeechCraft::AN::TypeMediaPlaybackStatus = CatMediaPlayer + ".PlaybackStatus"

A media file playback status has been changed.

Definition at line 138 of file constants.h.

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

◆ TypeOrganizerEventDue

const QString LeechCraft::AN::TypeOrganizerEventDue = CatOrganizer + ".EventDue"

An event due date is coming.

Definition at line 113 of file constants.h.

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

◆ TypePackageUpdated

const QString LeechCraft::AN::TypePackageUpdated = CatPackageManager + ".PackageUpdated"

A package has been updated.

Definition at line 130 of file constants.h.

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

◆ TypeTerminalActivity

const QString LeechCraft::AN::TypeTerminalActivity = CatTerminal + ".Activity"

Activity in terminal window.

Definition at line 150 of file constants.h.

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

◆ TypeTerminalBell

const QString LeechCraft::AN::TypeTerminalBell = CatTerminal + ".Bell"

A bell has ringed in a terminal window.

Definition at line 146 of file constants.h.

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

◆ TypeTerminalInactivity

const QString LeechCraft::AN::TypeTerminalInactivity = CatTerminal + ".Inactivity"

Inactivity in terminal window.

Definition at line 154 of file constants.h.

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