LeechCraft Monocle  0.6.70-13729-g7046a9d2a7
Modular document viewer for LeechCraft
LC::Monocle::ISupportForms Class Referenceabstract

Interface for documents supporting inline forms. More...

#include "isupportforms.h"

Public Member Functions

virtual ~ISupportForms ()
 
virtual IFormFields_t GetFormFields (int page)=0
 Returns the list of fields for the given page. More...
 

Detailed Description

Interface for documents supporting inline forms.

If a document is of format that supports page forms that can be filled, it should implement this interface.

It also makes sense to implement ISaveableDocument so that changes to the forms could be saved.

There is no "Apply" method in either this interface or form field interfaces. Changes should be applied as soon as corresponding interface's setter method is called.

See also
ISaveableDocument, IFormField

Definition at line 58 of file isupportforms.h.

Constructor & Destructor Documentation

◆ ~ISupportForms()

virtual LC::Monocle::ISupportForms::~ISupportForms ( )
inlinevirtual

Definition at line 61 of file isupportforms.h.

Member Function Documentation

◆ GetFormFields()

virtual IFormFields_t LC::Monocle::ISupportForms::GetFormFields ( int  page)
pure virtual

Returns the list of fields for the given page.

This function should return the list of form fields found on the given page, or an empty list if no fields are present.

Parameters
[in]pageThe zero-based index of the page to query.
Returns
The list of form fields on the page.

The documentation for this class was generated from the following file: