LeechCraft Monocle  0.6.70-13729-g7046a9d2a7
Modular document viewer for LeechCraft
ibackendplugin.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 <QString>
33 #include <QMetaType>
34 #include "idocument.h"
35 
36 namespace LC
37 {
38 namespace Monocle
39 {
41  typedef std::shared_ptr<IRedirectProxy> IRedirectProxy_ptr;
42 
60  {
61  public:
64  virtual ~IBackendPlugin () {}
65 
71  enum class LoadCheckResult
72  {
75  Cannot,
76 
79  Can,
80 
84  Redirect
85  };
86 
112  virtual LoadCheckResult CanLoadDocument (const QString& filename) = 0;
113 
136  virtual IDocument_ptr LoadDocument (const QString& filename) = 0;
137 
157  virtual IRedirectProxy_ptr GetRedirection (const QString& filename)
158  {
159  Q_UNUSED (filename)
160  return {};
161  }
162 
177  virtual QStringList GetSupportedMimes () const = 0;
178 
189  virtual bool IsThreaded () const
190  {
191  return false;
192  }
193  };
194 }
195 }
196 
197 Q_DECLARE_INTERFACE (LC::Monocle::IBackendPlugin,
198  "org.LeechCraft.Monocle.IBackendPlugin/1.0")
LoadCheckResult
Describes the result of checking whether a file can be loaded.
virtual IRedirectProxy_ptr GetRedirection(const QString &filename)
Returns the redirection proxy for the given document.
virtual ~IBackendPlugin()
Virtual destructor.
virtual IDocument_ptr LoadDocument(const QString &filename)=0
Loads the given document.
std::shared_ptr< IRedirectProxy > IRedirectProxy_ptr
The file cannot be loaded by this backend.
virtual LoadCheckResult CanLoadDocument(const QString &filename)=0
Checks whether the given document can be loaded.
Interface for redirecting document opening requests.
std::shared_ptr< IDocument > IDocument_ptr
Shared pointer to a document.
Definition: idocument.h:253
virtual bool IsThreaded() const
Returns whether the backend supports threads.
virtual QStringList GetSupportedMimes() const =0
Returns the MIME types supported by the backend.
The file can be loaded by this backend.
The file cannot be loaded by this backend, but can be converted to another format.
Definition: iannotation.h:41
Basic interface for plugins providing support for various document formats for Monocle.