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.

typedef std::shared_ptr< IFormField >	IFormField_ptr
	A shared pointer to a IFormField.

typedef QList< FontInfo >	FontInfos_t
	A list of FontInfo structures.

template<typename T >
using	TOCEntryLevelT = QVector<TOCEntryT<T>>
	A list of table of contents entries.

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

◆ CustomAction

using LC::Monocle::CustomAction = std::function<void ()>

Definition at line 106 of file ilink.h.

◆ FontInfos_t

typedef QList<FontInfo> LC::Monocle::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

typedef std::shared_ptr<ICaretAnnotation> LC::Monocle::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 198 of file idocument.h.

◆ IFormField_ptr

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

A shared pointer to a IFormField.

Definition at line 119 of file iformfield.h.

◆ IFormFields_t

typedef QList<IFormField_ptr> LC::Monocle::IFormFields_t

Definition at line 21 of file isupportforms.h.

◆ IHighlightAnnotation_ptr

typedef std::shared_ptr<IHighlightAnnotation> LC::Monocle::IHighlightAnnotation_ptr

Definition at line 185 of file iannotation.h.

◆ ILink_ptr

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

Definition at line 152 of file ilink.h.

◆ ILinkAnnotation_ptr

typedef std::shared_ptr<ILinkAnnotation> LC::Monocle::ILinkAnnotation_ptr

Definition at line 186 of file iannotation.h.

◆ IRedirectProxy_ptr

typedef std::shared_ptr<IRedirectProxy> LC::Monocle::IRedirectProxy_ptr

Definition at line 20 of file ibackendplugin.h.

◆ ITextAnnotation_ptr

typedef std::shared_ptr<ITextAnnotation> LC::Monocle::ITextAnnotation_ptr

Definition at line 184 of file iannotation.h.

◆ LinkAction

using LC::Monocle::LinkAction = std::variant<NoAction, NavigationAction, ExternalNavigationAction, UrlAction, CustomAction>

Definition at line 110 of file ilink.h.

◆ TOCEntry

using LC::Monocle::TOCEntry = TOCEntryT<NavigationAction>

Definition at line 43 of file ihavetoc.h.

◆ TOCEntryID

using LC::Monocle::TOCEntryID = TOCEntryT<QByteArray>

Definition at line 46 of file ihavetoc.h.

◆ TOCEntryIDLevel

using LC::Monocle::TOCEntryIDLevel = TOCEntryLevelT<QByteArray>

Definition at line 45 of file ihavetoc.h.

◆ TOCEntryLevel_t

using LC::Monocle::TOCEntryLevel_t = TOCEntryLevelT<NavigationAction>

Definition at line 42 of file ihavetoc.h.

◆ TOCEntryLevelT

template<typename T >

using LC::Monocle::TOCEntryLevelT = QVector<TOCEntryT<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 23 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. The ILink::GetLinkAction() for `PageLink`s is supposed to return a `NavigationAction`. @sa NavigationAction
URL	A link to an URL.
Command	Some standard command like printing.
OtherLink	Other link type.

Definition at line 25 of file ilink.h.

Classes

Typedefs

Enumerations

Typedef Documentation

◆ CustomAction

◆ FontInfos_t

◆ IAnnotation_ptr

◆ ICaretAnnotation_ptr

◆ IDocument_ptr

◆ IFormField_ptr

◆ IFormFields_t

◆ IHighlightAnnotation_ptr

◆ ILink_ptr

◆ ILinkAnnotation_ptr

◆ IRedirectProxy_ptr

◆ ITextAnnotation_ptr

◆ LinkAction

◆ TOCEntry

◆ TOCEntryID

◆ TOCEntryIDLevel

◆ TOCEntryLevel_t

◆ TOCEntryLevelT

Enumeration Type Documentation

◆ AnnotationType

◆ FormType

◆ LinkType