![]() |
LeechCraft Monocle
%{LEECHCRAFT_VERSION}
Modular document viewer for LeechCraft
|
Classes | |
class | IAnnotation |
class | ITextAnnotation |
class | IBackendPlugin |
Basic interface for format backends plugins for Monocle. More... | |
struct | DocumentInfo |
Document metadata. 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 | IFormFieldText |
Interface to be implemented by text fields. More... | |
class | IFormFieldChoice |
Interface to be implemented by choice fields. More... | |
class | IFormFieldButton |
Interface to be implemented by button fields. More... | |
class | IHaveTextContent |
Interface for documents supporting querying text contents. More... | |
struct | TOCEntry |
A single table of contents entry. More... | |
class | IHaveTOC |
Interface for documents supporting table of contents. More... | |
class | ILink |
Base interface for links. More... | |
class | IPageLink |
Additional interface for page links. More... | |
class | ISaveableDocument |
Interface for documents that can be saved. More... | |
class | ISearchableDocument |
Interface for documents supporting searching for text. More... | |
class | ISupportAnnotations |
class | ISupportForms |
Interface for documents supporting inline forms. More... | |
Typedefs | |
typedef std::shared_ptr < IAnnotation > | IAnnotation_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< TOCEntry > | TOCEntryLevel_t |
A list of table of contents entries. More... | |
typedef std::shared_ptr< ILink > | ILink_ptr |
typedef QList< IFormField_ptr > | IFormFields_t |
Enumerations | |
enum | AnnotationType { AnnotationType::Text, AnnotationType::Highlight } |
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... | |
typedef std::shared_ptr< IAnnotation > LeechCraft::Monocle::IAnnotation_ptr |
Definition at line 67 of file iannotation.h.
typedef std::shared_ptr<IDocument> LeechCraft::Monocle::IDocument_ptr |
Shared pointer to a document.
Definition at line 228 of file idocument.h.
typedef std::shared_ptr< IFormField > LeechCraft::Monocle::IFormField_ptr |
A shared pointer to a IFormField.
Definition at line 141 of file iformfield.h.
typedef QList<IFormField_ptr> LeechCraft::Monocle::IFormFields_t |
Definition at line 42 of file isupportforms.h.
typedef std::shared_ptr<ILink> LeechCraft::Monocle::ILink_ptr |
typedef QList<TOCEntry> LeechCraft::Monocle::TOCEntryLevel_t |
A list of table of contents entries.
Definition at line 39 of file ihavetoc.h.
|
strong |
Enumerator | |
---|---|
Text | |
Highlight |
Definition at line 39 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 45 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. Links of this type should implement IPageLink as well.
|
URL |
A link to an URL. |
Command |
Some standard command like printing. |
OtherLink |
Other link type. |