LeechCraft Monocle  %{LEECHCRAFT_VERSION}
Modular document viewer for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Monocle Namespace Reference

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< 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 }
 
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

Definition at line 67 of file iannotation.h.

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.

Definition at line 42 of file isupportforms.h.

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

Definition at line 110 of file ilink.h.

A list of table of contents entries.

Definition at line 39 of file ihavetoc.h.

Enumeration Type Documentation

Enumerator
Text 
Highlight 

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