LeechCraft  0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
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 <functional>
33 #include <boost/optional.hpp>
34 #include <QFuture>
35 #include <QImage>
36 #include <interfaces/structures.h>
40 #include "xpcconfig.h"
41 
42 class IEntityManager;
43 class QStandardItem;
44 
45 namespace LC
46 {
47 namespace Util
48 {
88  UTIL_XPC_API Entity MakeAN (const QString& header, const QString& text, Priority priority,
89  const QString& senderID, const QString& cat, const QString& type,
90  const QString& id, const QStringList& visualPath,
91  int delta = 1, int count = 0,
92  const QString& fullText = QString (), const QString& extendedText = QString ());
93 
116  UTIL_XPC_API Entity MakeANRule (const QString& title,
117  const QString& senderID,
118  const QString& category,
119  const QStringList& types,
120  AN::NotifyFlags flags = AN::NotifyNone,
121  bool openConfiguration = false,
122  const QList<QPair<QString, ANFieldValue>>& fields = {});
123 
139  UTIL_XPC_API QList<QObject*> GetDataFilters (const QVariant& data, IEntityManager *manager);
140 
158  UTIL_XPC_API Entity MakeEntity (const QVariant& entity,
159  const QString& location,
160  LC::TaskParameters tp,
161  const QString& mime = QString ());
162 
182  UTIL_XPC_API Entity MakeNotification (const QString& header,
183  const QString& text,
184  Priority priority);
185 
197  UTIL_XPC_API Entity MakeANCancel (const Entity& event);
198 
217  UTIL_XPC_API Entity MakeANCancel (const QString& senderId, const QString& eventId);
218 
237  UTIL_XPC_API QVariant GetPersistentData (const QByteArray& key,
238  const ICoreProxy_ptr& proxy);
239 
257  qint64 done, qint64 total, const QString& text);
258 
271  UTIL_XPC_API void SetJobHolderProgress (QStandardItem *item, qint64 done, qint64 total);
272 
274 
275  using LazyNotificationPixmap_t = std::function<boost::optional<QFuture<QImage>> ()>;
276 }
277 }
278 
Proxy to core entity manager.
constexpr detail::AggregateType< detail::AggregateFunction::Count, Ptr > count
Definition: oral.h:969
void SetJobHolderProgress(const QList< QStandardItem *> &row, qint64 done, qint64 total, const QString &text)
Sets the progress values on the given row.
Definition: util.cpp:166
QList< QObject * > GetDataFilters(const QVariant &data, IEntityManager *manager)
Returns the data filter plugins that can handle data.
Definition: util.cpp:94
Entity MakeANCancel(const Entity &event)
Makes an event for canceling another Advanced Notifications event.
Definition: util.cpp:130
Entity MakeEntity(const QVariant &entity, const QString &location, TaskParameters tp, const QString &mime)
Definition: util.cpp:105
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:46
void InitJobHolderRow(const QList< QStandardItem *> &row)
Definition: util.cpp:185
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)
Creates an Entity defining an Advanced Notifications rule.
Definition: util.cpp:67
std::shared_ptr< ICoreProxy > ICoreProxy_ptr
Definition: icoreproxy.h:202
Priority
Definition: structures.h:240
Q_DECLARE_METATYPE(QVariantList *)
No notifications.
Definition: constants.h:202
constexpr detail::MemberPtrs< Ptrs... > fields
Definition: oral.h:958
std::function< boost::optional< QFuture< QImage > >()> LazyNotificationPixmap_t
Definition: util.h:275
Entity MakeNotification(const QString &header, const QString &text, Priority priority)
An utility function to make a Entity with notification.
Definition: util.cpp:118
QVariant GetPersistentData(const QByteArray &key, const ICoreProxy_ptr &proxy)
Returns persistent data stored under given key.
Definition: util.cpp:148
Definition: constants.h:35
#define UTIL_XPC_API
Definition: xpcconfig.h:37