okular

Okular::SaveInterface

Okular::SaveInterface Class Reference

#include <saveinterface.h>

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 )

        ...
    };

and - of course - implementing its methods.

Definition at line 39 of file saveinterface.h.


Public Types
enum	SaveOption { NoOption = 0, SaveChanges = 1 }
Public Member Functions
virtual bool	save (const QString &fileName, SaveOptions options)=0
virtual bool	supportsOption (SaveOption option) const =0
virtual	~SaveInterface ()

Member Enumeration Documentation

enum Okular::SaveInterface::SaveOption

The possible options for the saving.

Enumerator:

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

Definition at line 45 of file saveinterface.h.

Constructor & Destructor Documentation

virtual Okular::SaveInterface::~SaveInterface ( ) [inline, virtual]

Destroys the save interface.

Definition at line 55 of file saveinterface.h.

Member Function Documentation

virtual bool Okular::SaveInterface::save	(	const QString &	fileName,
		SaveOptions	options
	)			`[pure virtual]`

Save to the specified fileName with the specified options.

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:

saveinterface.h

okular

Okular::SaveInterface Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

okular

kdegraphics