LeechCraft Monocle 0.6.70-14794-g33744ae6ce
Modular document viewer for LeechCraft
Loading...
Searching...
No Matches
LC::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.
 
typedef std::shared_ptr< IFormFieldIFormField_ptr
 A shared pointer to a IFormField.
 
typedef QList< FontInfoFontInfos_t
 A list of FontInfo structures.
 
typedef QList< TOCEntryTOCEntryLevel_t
 A list of table of contents entries.
 
typedef std::shared_ptr< ILinkILink_ptr
 
typedef QList< IFormField_ptrIFormFields_t
 

Enumerations

enum class  AnnotationType {
  Text , Highlight , Link , Caret ,
  Other
}
 Defines an annotation type. More...
 
enum class  FormType { Text , Choice , Button }
 Describes the possible types of a form field. More...
 
enum class  LinkType { PageLink , URL , Command , OtherLink }
 Describes various link types known to Monocle. More...
 

Typedef Documentation

◆ FontInfos_t

A list of FontInfo structures.

Definition at line 45 of file ihavefontinfo.h.

◆ IAnnotation_ptr

typedef std::shared_ptr< IAnnotation > LC::Monocle::IAnnotation_ptr

Definition at line 183 of file iannotation.h.

◆ ICaretAnnotation_ptr

Definition at line 187 of file iannotation.h.

◆ IDocument_ptr

typedef std::shared_ptr<IDocument> LC::Monocle::IDocument_ptr

Shared pointer to a document.

Definition at line 232 of file idocument.h.

◆ IFormField_ptr

typedef std::shared_ptr< IFormField > LC::Monocle::IFormField_ptr

A shared pointer to a IFormField.

Definition at line 120 of file iformfield.h.

◆ IFormFields_t

Definition at line 21 of file isupportforms.h.

◆ IHighlightAnnotation_ptr

Definition at line 185 of file iannotation.h.

◆ ILink_ptr

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

Definition at line 89 of file ilink.h.

◆ ILinkAnnotation_ptr

Definition at line 186 of file iannotation.h.

◆ IRedirectProxy_ptr

Definition at line 20 of file ibackendplugin.h.

◆ ITextAnnotation_ptr

Definition at line 184 of file iannotation.h.

◆ TOCEntryLevel_t

A list of table of contents entries.

Definition at line 22 of file ihavetoc.h.

Enumeration Type Documentation

◆ AnnotationType

enum class LC::Monocle::AnnotationType
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.

◆ FormType

enum class LC::Monocle::FormType
strong

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.

   @sa IFormFieldText
Choice 

A single- and multiple choice field.

   Fields of this type should also implement IFormFieldChoice.

   @sa IFormFieldChoice
Button 

A push button, radio button or check box.

   Fields of this type should also implement IFormFieldButton.

   @sa IFormFieldButton

Definition at line 24 of file iformfield.h.

◆ LinkType

enum class LC::Monocle::LinkType
strong

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.

   @sa IPageLink
URL 

A link to an URL.

Command 

Some standard command like printing.

OtherLink 

Other link type.

Definition at line 25 of file ilink.h.