Okular::SaveInterface

Search for usage in LXR

Okular::SaveInterface Class Referenceabstract

#include <saveinterface.h>

Public Types

enum  SaveOption { NoOption = 0 , SaveChanges = 1 }
 
typedef QFlags< SaveOptionSaveOptions
 

Public Member Functions

 SaveInterface (const SaveInterface &)=delete
 
virtual ~SaveInterface ()
 
virtual AnnotationProxyannotationProxy () const =0
 
SaveInterfaceoperator= (const SaveInterface &)=delete
 
virtual bool save (const QString &fileName, SaveOptions options, QString *errorText)=0
 
virtual bool supportsOption (SaveOption option) const =0
 

Detailed Description

Abstract interface for saving.

This interface defines a way to save (or help saving) the document opened by the Generator.

How to use it in a custom Generator:

class MyGenerator : public Okular::Generator, public Okular::SaveInterface
{
Q_OBJECT
Q_INTERFACES( Okular::SaveInterface )
...
};
[Abstract Class] The information generator.
Definition generator.h:188
Abstract interface for saving.

and - of course - implementing its methods.

Definition at line 36 of file saveinterface.h.

Member Typedef Documentation

◆ SaveOptions

Definition at line 46 of file saveinterface.h.

Member Enumeration Documentation

◆ SaveOption

The possible options for the saving.

Enumerator
SaveChanges 

The possibility to save with the current changes to the document.

Definition at line 42 of file saveinterface.h.

Constructor & Destructor Documentation

◆ SaveInterface()

Okular::SaveInterface::SaveInterface ( )
inline

Definition at line 48 of file saveinterface.h.

◆ ~SaveInterface()

virtual Okular::SaveInterface::~SaveInterface ( )
inlinevirtual

Destroys the save interface.

Definition at line 55 of file saveinterface.h.

Member Function Documentation

◆ annotationProxy()

virtual AnnotationProxy * Okular::SaveInterface::annotationProxy ( ) const
pure virtual

Returns the annotation proxy.

Generators can return NULL if native annotations are not supported.

Note
Returning NULL is equivalent to returning an AnnotationProxy that doesn't support any capability.
Since
0.15 (KDE 4.9)

◆ save()

virtual bool Okular::SaveInterface::save ( const QString & fileName,
SaveOptions options,
QString * errorText )
pure virtual

Save to the specified fileName with the specified options.

◆ supportsOption()

virtual bool Okular::SaveInterface::supportsOption ( SaveOption option) const
pure virtual

Query for the supported saving options.

Note
NoOption is never queried

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:57:55 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.