LeechCraft Monocle  0.6.70-6645-gcd10d7e
Modular document viewer for LeechCraft
LeechCraft::Monocle Namespace Reference

Classes

struct  DocumentInfo
 Document metadata. 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  IPageLink
 Additional interface for page links. 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  TOCEntry
 A single table of contents entry. More...
 

Typedefs

typedef std::shared_ptr< IAnnotationIAnnotation_ptr
 
typedef std::shared_ptr< ITextAnnotationITextAnnotation_ptr
 
typedef std::shared_ptr< IHighlightAnnotationIHighlightAnnotation_ptr
 
typedef std::shared_ptr< ILinkAnnotationILinkAnnotation_ptr
 
typedef std::shared_ptr< ICaretAnnotationICaretAnnotation_ptr
 
typedef std::shared_ptr< IRedirectProxyIRedirectProxy_ptr
 
typedef std::shared_ptr< IDocumentIDocument_ptr
 Shared pointer to a document. More...
 
typedef std::shared_ptr< IFormFieldIFormField_ptr
 A shared pointer to a IFormField. More...
 
typedef QList< FontInfoFontInfos_t
 A list of FontInfo structures. More...
 
typedef QList< TOCEntryTOCEntryLevel_t
 A list of table of contents entries. More...
 
typedef std::shared_ptr< ILinkILink_ptr
 
typedef QList< IFormField_ptrIFormFields_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...
 

Typedef Documentation

A list of FontInfo structures.

Definition at line 66 of file ihavefontinfo.h.

Definition at line 204 of file iannotation.h.

Definition at line 208 of file iannotation.h.

Shared pointer to a document.

Definition at line 237 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.

Definition at line 42 of file isupportforms.h.

Definition at line 206 of file iannotation.h.

typedef std::shared_ptr<ILink> LeechCraft::Monocle::ILink_ptr

Definition at line 110 of file ilink.h.

Definition at line 207 of file iannotation.h.

Definition at line 40 of file ibackendplugin.h.

Definition at line 205 of file iannotation.h.

A list of table of contents entries.

Definition at line 39 of file ihavetoc.h.

Enumeration Type Documentation

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 47 of file iannotation.h.

Describes the possible types of a form field.

See also
IFormField
Enumerator
Text 

A text entry field.

Fields of this type should also implement IFormFieldText.

See also
IFormFieldText
Choice 

A single- and multiple choice field.

Fields of this type should also implement IFormFieldChoice.

See also
IFormFieldChoice
Button 

A push button, radio button or check box.

Fields of this type should also implement IFormFieldButton.

See also
IFormFieldButton

Definition at line 45 of file iformfield.h.

Describes various link types known to Monocle.

All links implement the ILink interface.

See also
ILink
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.

See also
IPageLink
URL 

A link to an URL.

Command 

Some standard command like printing.

OtherLink 

Other link type.

Definition at line 46 of file ilink.h.