![]() |
LeechCraft Monocle
0.6.70-16373-g319c272718
Modular document viewer for LeechCraft
|
Classes | |
struct | DocumentInfo |
Document metadata. More... | |
struct | ExternalNavigationAction |
A link action that represents navigating to a different document. More... | |
struct | FontInfo |
Describes a single font. More... | |
class | IAnnotation |
Base interface for annotations. More... | |
class | IBackendPlugin |
Basic interface for plugins providing support for various document formats for Monocle. More... | |
class | ICaretAnnotation |
The interface for AnnotationType::Caret annotations. More... | |
class | IDocument |
Basic interface for documents. More... | |
class | IDynamicDocument |
Implemented by documents whose pages can change dynamically. More... | |
class | IFormField |
Base interface to be implemented by form fields. More... | |
class | IFormFieldButton |
Interface to be implemented by button fields. More... | |
class | IFormFieldChoice |
Interface to be implemented by choice fields. More... | |
class | IFormFieldText |
Interface to be implemented by text fields. More... | |
class | IHaveFontInfo |
Interface for querying font information in a document. More... | |
class | IHaveOptionalContent |
Interface for documents that can toggle showing some of their contents. More... | |
class | IHaveTextContent |
Interface for documents supporting querying text contents. More... | |
class | IHaveTOC |
Interface for documents supporting table of contents. More... | |
class | IHighlightAnnotation |
The interface for AnnotationType::Highlight annotations. More... | |
class | IKnowFileExtensions |
Interface for backend plugins providing default extensions for their relevant file types. More... | |
class | ILink |
Base interface for links. More... | |
class | ILinkAnnotation |
The interface for AnnotationType::Link annotations. More... | |
class | IPendingFontInfoRequest |
A proxy object for a pending font info request. More... | |
class | IRedirectProxy |
Interface for redirecting document opening requests. More... | |
class | ISaveableDocument |
Interface for documents that can be saved. More... | |
class | ISearchableDocument |
Interface for documents supporting searching for text. More... | |
class | ISupportAnnotations |
Interface for documents supporting annotations. More... | |
class | ISupportForms |
Interface for documents supporting inline forms. More... | |
class | ISupportPainting |
Interface for documents supporting optimized painting. More... | |
class | ITextAnnotation |
The interface for AnnotationType::Text annotations. More... | |
struct | NavigationAction |
A link action that represents navigating inside the document. More... | |
struct | NoAction |
struct | TOCEntryT |
A single table of contents entry. More... | |
struct | UrlAction |
Typedefs | |
typedef std::shared_ptr< IAnnotation > | IAnnotation_ptr |
typedef std::shared_ptr< ITextAnnotation > | ITextAnnotation_ptr |
typedef std::shared_ptr< IHighlightAnnotation > | IHighlightAnnotation_ptr |
typedef std::shared_ptr< ILinkAnnotation > | ILinkAnnotation_ptr |
typedef std::shared_ptr< ICaretAnnotation > | ICaretAnnotation_ptr |
typedef std::shared_ptr< IRedirectProxy > | IRedirectProxy_ptr |
typedef std::shared_ptr< IDocument > | IDocument_ptr |
Shared pointer to a document. More... | |
typedef std::shared_ptr< IFormField > | IFormField_ptr |
A shared pointer to a IFormField. More... | |
typedef QList< FontInfo > | FontInfos_t |
A list of FontInfo structures. More... | |
template<typename T > | |
using | TOCEntryLevelT = QVector< TOCEntryT< T > > |
A list of table of contents entries. More... | |
using | TOCEntryLevel_t = TOCEntryLevelT< NavigationAction > |
using | TOCEntry = TOCEntryT< NavigationAction > |
using | TOCEntryIDLevel = TOCEntryLevelT< QByteArray > |
using | TOCEntryID = TOCEntryT< QByteArray > |
using | CustomAction = std::function< void()> |
using | LinkAction = std::variant< NoAction, NavigationAction, ExternalNavigationAction, UrlAction, CustomAction > |
typedef std::shared_ptr< ILink > | ILink_ptr |
typedef QList< IFormField_ptr > | IFormFields_t |
Enumerations | |
enum | AnnotationType { AnnotationType::Text, AnnotationType::Highlight, AnnotationType::Link, AnnotationType::Caret, AnnotationType::Other } |
Defines an annotation type. More... | |
enum | FormType { FormType::Text, FormType::Choice, FormType::Button } |
Describes the possible types of a form field. More... | |
enum | LinkType { LinkType::PageLink, LinkType::URL, LinkType::Command, LinkType::OtherLink } |
Describes various link types known to Monocle. More... | |
using LC::Monocle::CustomAction = typedef std::function<void ()> |
typedef QList<FontInfo> LC::Monocle::FontInfos_t |
A list of FontInfo structures.
Definition at line 45 of file ihavefontinfo.h.
typedef std::shared_ptr< IAnnotation > LC::Monocle::IAnnotation_ptr |
Definition at line 183 of file iannotation.h.
typedef std::shared_ptr<ICaretAnnotation> LC::Monocle::ICaretAnnotation_ptr |
Definition at line 187 of file iannotation.h.
typedef std::shared_ptr<IDocument> LC::Monocle::IDocument_ptr |
Shared pointer to a document.
Definition at line 198 of file idocument.h.
typedef std::shared_ptr< IFormField > LC::Monocle::IFormField_ptr |
A shared pointer to a IFormField.
Definition at line 119 of file iformfield.h.
typedef QList<IFormField_ptr> LC::Monocle::IFormFields_t |
Definition at line 21 of file isupportforms.h.
typedef std::shared_ptr<IHighlightAnnotation> LC::Monocle::IHighlightAnnotation_ptr |
Definition at line 185 of file iannotation.h.
typedef std::shared_ptr<ILink> LC::Monocle::ILink_ptr |
typedef std::shared_ptr<ILinkAnnotation> LC::Monocle::ILinkAnnotation_ptr |
Definition at line 186 of file iannotation.h.
typedef std::shared_ptr<IRedirectProxy> LC::Monocle::IRedirectProxy_ptr |
Definition at line 19 of file ibackendplugin.h.
typedef std::shared_ptr<ITextAnnotation> LC::Monocle::ITextAnnotation_ptr |
Definition at line 184 of file iannotation.h.
using LC::Monocle::LinkAction = typedef std::variant<NoAction, NavigationAction, ExternalNavigationAction, UrlAction, CustomAction> |
using LC::Monocle::TOCEntry = typedef TOCEntryT<NavigationAction> |
Definition at line 43 of file ihavetoc.h.
using LC::Monocle::TOCEntryID = typedef TOCEntryT<QByteArray> |
Definition at line 46 of file ihavetoc.h.
using LC::Monocle::TOCEntryIDLevel = typedef TOCEntryLevelT<QByteArray> |
Definition at line 45 of file ihavetoc.h.
using LC::Monocle::TOCEntryLevel_t = typedef TOCEntryLevelT<NavigationAction> |
Definition at line 42 of file ihavetoc.h.
using LC::Monocle::TOCEntryLevelT = typedef QVector<TOCEntryT<T> > |
A list of table of contents entries.
Definition at line 22 of file ihavetoc.h.
|
strong |
Defines an annotation type.
Enumerator | |
---|---|
Text | A simple text annotation. The corresponding interface is ITextAnnotation. |
Highlight | A highlighted block in the text. The corresponding interface is IHighlightAnnotation. |
Link | An annotation with a link. The corresponding interface is ILinkAnnotation. |
Caret | A caret pointing to some text inserted. The corresponding interface is ICaretAnnotation. |
Other | Another type of annotation. |
Definition at line 26 of file iannotation.h.
|
strong |
Describes the possible types of a form field.
Enumerator | |
---|---|
Text | A text entry field. Fields of this type should also implement IFormFieldText.
|
Choice | A single- and multiple choice field. Fields of this type should also implement IFormFieldChoice.
|
Button | A push button, radio button or check box. Fields of this type should also implement IFormFieldButton.
|
Definition at line 23 of file iformfield.h.
|
strong |
Describes various link types known to Monocle.
All links implement the ILink interface.
Enumerator | |
---|---|
PageLink | A link to a page. The link may refer both the document it belongs to as well as some other document. The ILink::GetLinkAction() for
|
URL | A link to an URL. |
Command | Some standard command like printing. |
OtherLink | Other link type. |