Okular::ConfigInterface Class Reference

#include <configinterface.h>

Inheritance diagram for Okular::ConfigInterface:

Public Member Functions
	ConfigInterface (const ConfigInterface &)=delete
virtual	~ConfigInterface ()
virtual void	addPages (KConfigDialog *dialog)=0
ConfigInterface &	operator= (const ConfigInterface &)=delete
virtual bool	reparseConfig ()=0

Detailed Description

Abstract interface for configuration control.

This interface defines a way to configure the Generator itself.

How to use it in a custom Generator:

class MyGenerator : public Okular::Generator, public Okular::ConfigInterface
{
    Q_OBJECT
    Q_INTERFACES( Okular::ConfigInterface )
 
    ...
};

and - of course - implementing its methods.

Definition at line 35 of file configinterface.h.

Constructor & Destructor Documentation

ConfigInterface()

Okular::ConfigInterface::ConfigInterface ( )

inline

Definition at line 38 of file configinterface.h.

~ConfigInterface()

virtual Okular::ConfigInterface::~ConfigInterface ( )

inlinevirtual

Destroys the config interface.

Definition at line 45 of file configinterface.h.

Member Function Documentation

addPages()

virtual void Okular::ConfigInterface::addPages ( KConfigDialog * dialog )

pure virtual

This method allows the generator to add custom configuration pages to the config dialog of okular.

Implemented in Okular::TextDocumentGenerator.

reparseConfig()

virtual bool Okular::ConfigInterface::reparseConfig ( )

pure virtual

This method is called to tell the generator to re-parse its configuration.

Returns true if something has changed.

Note

this method can be called also when the generator is not the active generator, or when there was not changed in the config added by the generator itself. So the suggestion is to check whether something changed, and only in that case return true

Implemented in Okular::TextDocumentGenerator.

---

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

• configinterface.h