LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
IANRulesStorage Class Referenceabstract

Interface for plugins managing Advanced Notifications rules. More...

#include "ianrulesstorage.h"

Public Member Functions

virtual ~IANRulesStorage ()
 
virtual QList< LC::EntityGetAllRules (const QString &category) const =0
 Returns all rules matching the category. More...
 
virtual void RequestRuleConfiguration (const LC::Entity &rule)=0
 Requests opening the configuration of the given rule. More...
 

Protected Member Functions

virtual void rulesChanged ()=0
 Emitted when the rules change. More...
 

Detailed Description

Interface for plugins managing Advanced Notifications rules.

This interface should be implemented by plugins that provide means to store and manage the Advanced Notifications rules. Other plugins may use this interface to query for different rules and their options.

Definition at line 27 of file ianrulesstorage.h.

Constructor & Destructor Documentation

◆ ~IANRulesStorage()

virtual IANRulesStorage::~IANRulesStorage ( )
inlinevirtual

Definition at line 30 of file ianrulesstorage.h.

Member Function Documentation

◆ GetAllRules()

virtual QList<LC::Entity> IANRulesStorage::GetAllRules ( const QString &  category) const
pure virtual

Returns all rules matching the category.

The category can be either one of the predefined categories (like LC::AN::CatIM) or empty, in which case all the rules are returned.

Parameters
[in]categoryThe category of the rules to return, or empty for all rules.
Returns
The list of all rules matching the given category.

◆ RequestRuleConfiguration()

virtual void IANRulesStorage::RequestRuleConfiguration ( const LC::Entity rule)
pure virtual

Requests opening the configuration of the given rule.

Parameters
[in]ruleOne of the rules returned from GetAllRules().

◆ rulesChanged()

virtual void IANRulesStorage::rulesChanged ( )
protectedpure virtual

Emitted when the rules change.

This signal is emitted either when a new rule has been added, or an already existing rule has been deleted or modified.

Note
This function is expected to be a signal.

The documentation for this class was generated from the following file: