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 Q_DECL_IMPORT QString	CatEventCancel { QStringLiteral ("org.LC.AdvNotifications.Cancel") }
	Event cancel pseudo-category. More...

const Q_DECL_IMPORT QString	CatIM { QStringLiteral (CAT_IM) }
	Category of Instant Messaging-related events. More...

const Q_DECL_IMPORT QString	TypeIMAttention { QStringLiteral (CAT_IM ".AttentionDrawn") }
	Another user has requested our user's attention. More...

const Q_DECL_IMPORT QString	TypeIMIncFile { QStringLiteral (CAT_IM ".IncomingFile") }
	Another user has sent our user a file. More...

const Q_DECL_IMPORT QString	TypeIMIncMsg { QStringLiteral (CAT_IM ".IncomingMessage") }
	User has received a message in a standard one-to-one chat. More...

const Q_DECL_IMPORT QString	TypeIMMUCHighlight { QStringLiteral (CAT_IM ".MUCHighlightMessage") }
	User has been highlighted in a multiuser chat. More...

const Q_DECL_IMPORT QString	TypeIMMUCInvite { QStringLiteral (CAT_IM ".MUCInvitation") }
	User has been invited to a multiuser chat. More...

const Q_DECL_IMPORT QString	TypeIMMUCMsg { QStringLiteral (CAT_IM ".MUCMessage") }
	A message has been sent to a multiuser chat. More...

const Q_DECL_IMPORT QString	TypeIMStatusChange { QStringLiteral (CAT_IM ".StatusChange") }
	Another user in our user's contact list has changed its status. More...

const Q_DECL_IMPORT QString	TypeIMSubscrGrant { QStringLiteral (CAT_IM ".Subscr.Granted") }
	Another user has granted subscription to our user. More...

const Q_DECL_IMPORT QString	TypeIMSubscrRevoke { QStringLiteral (CAT_IM ".Subscr.Revoked") }
	Another user has revoked subscription from our user. More...

const Q_DECL_IMPORT QString	TypeIMSubscrRequest { QStringLiteral (CAT_IM ".Subscr.Requested") }
	Another user has requested subscription from our user. More...

const Q_DECL_IMPORT QString	TypeIMSubscrSub { QStringLiteral (CAT_IM ".Subscr.Subscribed") }
	Another user has subscribed to our user. More...

const Q_DECL_IMPORT QString	TypeIMSubscrUnsub { QStringLiteral (CAT_IM ".Subscr.Unsubscribed") }
	Another user has unsubscribed from our user. More...

const Q_DECL_IMPORT QString	TypeIMEventTuneChange { QStringLiteral (CAT_IM ".Event.Tune") }
	User's tune has changed. More...

const Q_DECL_IMPORT QString	TypeIMEventMoodChange { QStringLiteral (CAT_IM ".Event.Mood") }
	User's mood has changed. More...

const Q_DECL_IMPORT QString	TypeIMEventActivityChange { QStringLiteral (CAT_IM ".Event.Activity") }
	User's activity has changed. More...

const Q_DECL_IMPORT QString	TypeIMEventLocationChange { QStringLiteral (CAT_IM ".Event.Location") }
	User's location has changed. More...

const Q_DECL_IMPORT QString	CatOrganizer { QStringLiteral (CAT_ORGANIZER) }
	Category of Organizer-related events. More...

const Q_DECL_IMPORT QString	TypeOrganizerEventDue { QStringLiteral (CAT_ORGANIZER ".EventDue") }
	An event due date is coming. More...

const Q_DECL_IMPORT QString	CatDownloads { QStringLiteral (CAT_DOWNLOADS) }
	Category of Downloads-related events. More...

const Q_DECL_IMPORT QString	TypeDownloadFinished { QStringLiteral (CAT_DOWNLOADS ".DownloadFinished") }
	A download has been finished successfully without errors. More...

const Q_DECL_IMPORT QString	TypeDownloadError { QStringLiteral (CAT_DOWNLOADS ".DownloadError") }
	A download has been failed. More...

const Q_DECL_IMPORT QString	CatPackageManager { QStringLiteral (CAT_PACKAGE_MANAGER) }
	Category of package manager-related events. More...

const Q_DECL_IMPORT QString	TypePackageUpdated { QStringLiteral (CAT_PACKAGE_MANAGER ".PackageUpdated") }
	A package has been updated. More...

const Q_DECL_IMPORT QString	CatMediaPlayer { QStringLiteral (CAT_MEDIA_PLAYER) }
	Category of media player-related events. More...

const Q_DECL_IMPORT QString	TypeMediaPlaybackStatus { QStringLiteral (CAT_MEDIA_PLAYER ".PlaybackStatus") }
	A media file playback status has been changed. More...

const Q_DECL_IMPORT QString	CatTerminal { QStringLiteral (CAT_TERMINAL) }
	Category for terminal emulation events. More...

const Q_DECL_IMPORT QString	TypeTerminalBell { QStringLiteral (CAT_TERMINAL ".Bell") }
	A bell has ringed in a terminal window. More...

const Q_DECL_IMPORT QString	TypeTerminalActivity { QStringLiteral (CAT_TERMINAL ".Activity") }
	Activity in terminal window. More...

const Q_DECL_IMPORT QString	TypeTerminalInactivity { QStringLiteral (CAT_TERMINAL ".Inactivity") }
	Inactivity in terminal window. More...

const Q_DECL_IMPORT QString	CatNews { QStringLiteral (CAT_NEWS) }
	Category for news-related events. More...

const Q_DECL_IMPORT QString	TypeNewsSourceUpdated { QStringLiteral (CAT_NEWS ".Updated") }
	News source got updated. More...

const Q_DECL_IMPORT QString	TypeNewsSourceBroken { QStringLiteral (CAT_NEWS ".Broken") }
	News source is detected to be broken. More...

const Q_DECL_IMPORT QString	CatGeneric { QStringLiteral (CAT_GENERIC) }
	Generic notifications that don't fit into any other category. More...

const Q_DECL_IMPORT QString	TypeGeneric { QStringLiteral (CAT_GENERIC ".Generic") }
	Generic type for generic notifications. More...

Enumeration Type Documentation

◆ NotifyFlag

enum LC::AN::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. @sa 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 181 of file constants.h.

Function Documentation

◆ Q_DECLARE_FLAGS()

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

Variable Documentation

◆ CatDownloads

const QString LC::AN::CatDownloads { QStringLiteral (CAT_DOWNLOADS) }

Category of Downloads-related events.

Definition at line 60 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetCategoryNameMap().

◆ CatEventCancel

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

Event cancel pseudo-category.

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

Definition at line 34 of file anconstantsdefs.cpp.

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

◆ CatGeneric

const QString LC::AN::CatGeneric { QStringLiteral (CAT_GENERIC) }

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

Definition at line 84 of file anconstantsdefs.cpp.

◆ CatIM

const QString LC::AN::CatIM { QStringLiteral (CAT_IM) }

Category of Instant Messaging-related events.

Definition at line 37 of file anconstantsdefs.cpp.

◆ CatMediaPlayer

const QString LC::AN::CatMediaPlayer { QStringLiteral (CAT_MEDIA_PLAYER) }

Category of media player-related events.

Definition at line 69 of file anconstantsdefs.cpp.

◆ CatNews

const QString LC::AN::CatNews { QStringLiteral (CAT_NEWS) }

Category for news-related events.

Definition at line 79 of file anconstantsdefs.cpp.

◆ CatOrganizer

const QString LC::AN::CatOrganizer { QStringLiteral (CAT_ORGANIZER) }

Category of Organizer-related events.

Definition at line 56 of file anconstantsdefs.cpp.

◆ CatPackageManager

const QString LC::AN::CatPackageManager { QStringLiteral (CAT_PACKAGE_MANAGER) }

Category of package manager-related events.

Definition at line 65 of file anconstantsdefs.cpp.

◆ CatTerminal

const QString LC::AN::CatTerminal { QStringLiteral (CAT_TERMINAL) }

Category for terminal emulation events.

Definition at line 73 of file anconstantsdefs.cpp.

◆ TypeDownloadError

const QString LC::AN::TypeDownloadError { QStringLiteral (CAT_DOWNLOADS ".DownloadError") }

A download has been failed.

Definition at line 62 of file anconstantsdefs.cpp.

◆ TypeDownloadFinished

const QString LC::AN::TypeDownloadFinished { QStringLiteral (CAT_DOWNLOADS ".DownloadFinished") }

A download has been finished successfully without errors.

Definition at line 61 of file anconstantsdefs.cpp.

◆ TypeGeneric

const QString LC::AN::TypeGeneric { QStringLiteral (CAT_GENERIC ".Generic") }

Generic type for generic notifications.

Definition at line 85 of file anconstantsdefs.cpp.

◆ TypeIMAttention

const QString LC::AN::TypeIMAttention { QStringLiteral (CAT_IM ".AttentionDrawn") }

Another user has requested our user's attention.

Definition at line 38 of file anconstantsdefs.cpp.

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

◆ TypeIMEventActivityChange

const QString LC::AN::TypeIMEventActivityChange { QStringLiteral (CAT_IM ".Event.Activity") }

User's activity has changed.

Definition at line 52 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMEventLocationChange

const QString LC::AN::TypeIMEventLocationChange { QStringLiteral (CAT_IM ".Event.Location") }

User's location has changed.

Definition at line 53 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMEventMoodChange

const QString LC::AN::TypeIMEventMoodChange { QStringLiteral (CAT_IM ".Event.Mood") }

User's mood has changed.

Definition at line 51 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMEventTuneChange

const QString LC::AN::TypeIMEventTuneChange { QStringLiteral (CAT_IM ".Event.Tune") }

User's tune has changed.

Definition at line 50 of file anconstantsdefs.cpp.

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

◆ TypeIMIncFile

const QString LC::AN::TypeIMIncFile { QStringLiteral (CAT_IM ".IncomingFile") }

Another user has sent our user a file.

Definition at line 39 of file anconstantsdefs.cpp.

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

◆ TypeIMIncMsg

const QString LC::AN::TypeIMIncMsg { QStringLiteral (CAT_IM ".IncomingMessage") }

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

Definition at line 40 of file anconstantsdefs.cpp.

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

◆ TypeIMMUCHighlight

const QString LC::AN::TypeIMMUCHighlight { QStringLiteral (CAT_IM ".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 41 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMMUCInvite

const QString LC::AN::TypeIMMUCInvite { QStringLiteral (CAT_IM ".MUCInvitation") }

User has been invited to a multiuser chat.

Definition at line 42 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMMUCMsg

const QString LC::AN::TypeIMMUCMsg { QStringLiteral (CAT_IM ".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 43 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMStatusChange

const QString LC::AN::TypeIMStatusChange { QStringLiteral (CAT_IM ".StatusChange") }

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

Definition at line 44 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMSubscrGrant

const QString LC::AN::TypeIMSubscrGrant { QStringLiteral (CAT_IM ".Subscr.Granted") }

Another user has granted subscription to our user.

Definition at line 45 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMSubscrRequest

const QString LC::AN::TypeIMSubscrRequest { QStringLiteral (CAT_IM ".Subscr.Requested") }

Another user has requested subscription from our user.

Definition at line 47 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMSubscrRevoke

const QString LC::AN::TypeIMSubscrRevoke { QStringLiteral (CAT_IM ".Subscr.Revoked") }

Another user has revoked subscription from our user.

Definition at line 46 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMSubscrSub

const QString LC::AN::TypeIMSubscrSub { QStringLiteral (CAT_IM ".Subscr.Subscribed") }

Another user has subscribed to our user.

Definition at line 48 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeIMSubscrUnsub

const QString LC::AN::TypeIMSubscrUnsub { QStringLiteral (CAT_IM ".Subscr.Unsubscribed") }

Another user has unsubscribed from our user.

Definition at line 49 of file anconstantsdefs.cpp.

Referenced by LC::Util::AN::GetKnownEventTypes().

◆ TypeMediaPlaybackStatus

const QString LC::AN::TypeMediaPlaybackStatus { QStringLiteral (CAT_MEDIA_PLAYER ".PlaybackStatus") }

A media file playback status has been changed.

Definition at line 70 of file anconstantsdefs.cpp.

◆ TypeNewsSourceBroken

const QString LC::AN::TypeNewsSourceBroken { QStringLiteral (CAT_NEWS ".Broken") }

News source is detected to be broken.

Definition at line 81 of file anconstantsdefs.cpp.

◆ TypeNewsSourceUpdated

const QString LC::AN::TypeNewsSourceUpdated { QStringLiteral (CAT_NEWS ".Updated") }

News source got updated.

Definition at line 80 of file anconstantsdefs.cpp.

◆ TypeOrganizerEventDue

const QString LC::AN::TypeOrganizerEventDue { QStringLiteral (CAT_ORGANIZER ".EventDue") }

An event due date is coming.

Definition at line 57 of file anconstantsdefs.cpp.

◆ TypePackageUpdated

const QString LC::AN::TypePackageUpdated { QStringLiteral (CAT_PACKAGE_MANAGER ".PackageUpdated") }

A package has been updated.

Definition at line 66 of file anconstantsdefs.cpp.

◆ TypeTerminalActivity

const QString LC::AN::TypeTerminalActivity { QStringLiteral (CAT_TERMINAL ".Activity") }

Activity in terminal window.

Definition at line 75 of file anconstantsdefs.cpp.

◆ TypeTerminalBell

const QString LC::AN::TypeTerminalBell { QStringLiteral (CAT_TERMINAL ".Bell") }

A bell has ringed in a terminal window.

Definition at line 74 of file anconstantsdefs.cpp.

◆ TypeTerminalInactivity

const QString LC::AN::TypeTerminalInactivity { QStringLiteral (CAT_TERMINAL ".Inactivity") }

Inactivity in terminal window.

Definition at line 76 of file anconstantsdefs.cpp.

Namespaces

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ NotifyFlag

Function Documentation

◆ Q_DECLARE_FLAGS()

Variable Documentation

◆ CatDownloads

◆ CatEventCancel

◆ CatGeneric

◆ CatIM

◆ CatMediaPlayer

◆ CatNews

◆ CatOrganizer

◆ CatPackageManager

◆ CatTerminal

◆ TypeDownloadError

◆ TypeDownloadFinished

◆ TypeGeneric

◆ TypeIMAttention

◆ TypeIMEventActivityChange

◆ TypeIMEventLocationChange

◆ TypeIMEventMoodChange

◆ TypeIMEventTuneChange

◆ TypeIMIncFile

◆ TypeIMIncMsg

◆ TypeIMMUCHighlight

◆ TypeIMMUCInvite

◆ TypeIMMUCMsg

◆ TypeIMStatusChange

◆ TypeIMSubscrGrant

◆ TypeIMSubscrRequest

◆ TypeIMSubscrRevoke

◆ TypeIMSubscrSub

◆ TypeIMSubscrUnsub

◆ TypeMediaPlaybackStatus

◆ TypeNewsSourceBroken

◆ TypeNewsSourceUpdated

◆ TypeOrganizerEventDue

◆ TypePackageUpdated

◆ TypeTerminalActivity

◆ TypeTerminalBell

◆ TypeTerminalInactivity