LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
util.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 <interfaces/structures.h>
35 #include "xpcconfig.h"
36 
37 class IEntityManager;
38 
39 namespace LeechCraft
40 {
41 namespace Util
42 {
81  UTIL_XPC_API Entity MakeAN (const QString& header, const QString& text, Priority priority,
82  const QString& senderID, const QString& cat, const QString& type,
83  const QString& id, const QStringList& visualPath,
84  int delta = 1, int count = 0,
85  const QString& fullText = QString (), const QString& extendedText = QString ());
86 
87  UTIL_XPC_API Entity MakeANRule (const QString& title,
88  const QString& senderID, const QString& cat, const QStringList& types,
89  AN::NotifyFlags = AN::NotifyNone,
90  bool openConfiguration = false,
91  const QList<QPair<QString, ANFieldValue>>& fields = {});
92 
108  UTIL_XPC_API QList<QObject*> GetDataFilters (const QVariant& data, IEntityManager *manager);
109 
127  UTIL_XPC_API Entity MakeEntity (const QVariant& entity,
128  const QString& location,
129  LeechCraft::TaskParameters tp,
130  const QString& mime = QString ());
131 
151  UTIL_XPC_API Entity MakeNotification (const QString& header,
152  const QString& text,
153  Priority priority);
154 
166  UTIL_XPC_API Entity MakeANCancel (const Entity& event);
167 
186  UTIL_XPC_API Entity MakeANCancel (const QString& senderId, const QString& eventId);
187 
188  UTIL_XPC_API QVariantList GetPersistentData (const QList<QVariant>& keys,
189  QObject *object);
190 }
191 }
Entity MakeEntity(const QVariant &entity, const QString &location, TaskParameters tp, const QString &mime)
Definition: util.cpp:101
Proxy to core entity manager.
Entity MakeANRule(const QString &title, const QString &senderID, const QString &cat, const QStringList &types, AN::NotifyFlags flags, bool openConfiguration, const QList< QPair< QString, ANFieldValue >> &fields)
Definition: util.cpp:63
No notifications.
Definition: constants.h:158
Entity MakeNotification(const QString &header, const QString &text, Priority priority)
An utility function to make a Entity with notification.
Definition: util.cpp:114
Entity MakeANCancel(const Entity &event)
Makes an event for canceling another Advanced Notifications event.
Definition: util.cpp:126
QList< QObject * > GetDataFilters(const QVariant &data, IEntityManager *manager)
Returns the data filter plugins that can handle data.
Definition: util.cpp:90
QVariantList GetPersistentData(const QList< QVariant > &keys, QObject *object)
Definition: util.cpp:144
Entity MakeAN(const QString &header, const QString &text, Priority priority, const QString &senderID, const QString &cat, const QString &type, const QString &id, const QStringList &visualPath, int delta, int count, const QString &fullText, const QString &extendedText)
Creates an Advanced Notifications-enabled notify entity.
Definition: util.cpp:42
#define UTIL_XPC_API
Definition: xpcconfig.h:37