![]() |
LeechCraft Monocle
0.6.70-13729-g7046a9d2a7
Modular document viewer for LeechCraft
|
Interface for documents that can be saved. More...
#include "isaveabledocument.h"
Classes | |
struct | SaveQueryResult |
Describes the result of check for the possibility of saving. More... | |
Public Member Functions | |
virtual | ~ISaveableDocument () |
Virtual destructor. More... | |
virtual SaveQueryResult | CanSave () const =0 |
Checks whether this document can be saved. More... | |
virtual bool | Save (const QString &path)=0 |
Saves the document at the given path. More... | |
Interface for documents that can be saved.
This interface should be implemented by documents for formats that allow saving the document after its editable elements (like forms or annotations) were modified.
Not all documents of the same format support saving: for example, encrypted PDF documents cannot be saved, while regular ones can. Thus the CanSave() method checks whether this particular document can be saved.
Definition at line 51 of file isaveabledocument.h.
|
inlinevirtual |
Virtual destructor.
Definition at line 56 of file isaveabledocument.h.
|
pure virtual |
Checks whether this document can be saved.
This method should check if the document can be saved and return a proper SaveQueryResult.
|
pure virtual |
Saves the document at the given path.
The path can be equal to the original document path, plugins should take this into account.
[in] | path | The full path to the target file including the file name. |