Okular::GuiInterface Class Reference

#include <guiinterface.h>

Inheritance diagram for Okular::GuiInterface:

Public Member Functions
	GuiInterface (const GuiInterface &)=delete
	~GuiInterface () override
KXMLGUIClient *	guiClient ()
GuiInterface &	operator= (const GuiInterface &)=delete

Additional Inherited Members
Protected Member Functions inherited from KXMLGUIClient
void	loadStandardsXmlFile ()
virtual void	setComponentName (const QString &componentName, const QString &componentDisplayName)
virtual void	setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void	setLocalXMLFile (const QString &file)
virtual void	setXML (const QString &document, bool merge=false)
virtual void	setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void	stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
	KXMLGUIClient (KXMLGUIClient *parent)
virtual QAction *	action (const QDomElement &element) const
QAction *	action (const QString &name) const
virtual KActionCollection *	actionCollection () const
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
virtual QString	componentName () const
virtual QDomDocument	domDocument () const
KXMLGUIFactory *	factory () const
void	insertChildClient (KXMLGUIClient *child)
KXMLGUIClient *	parentClient () const
void	plugActionList (const QString &name, const QList< QAction * > &actionList)
void	reloadXML ()
void	removeChildClient (KXMLGUIClient *child)
void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void	setClientBuilder (KXMLGUIBuilder *builder)
void	setFactory (KXMLGUIFactory *factory)
void	setXMLGUIBuildDocument (const QDomDocument &doc)
void	unplugActionList (const QString &name)
virtual QString	xmlFile () const
QDomDocument	xmlguiBuildDocument () const
Static Protected Member Functions inherited from KXMLGUIClient
static QString	standardsXmlFileLocation ()
static QString	findVersionNumber (const QString &xml)

Detailed Description

Abstract interface for user interface control.

This interface defines an way to interact with the Okular user interface, e.g. adding actions in the menus.

How to use it in a custom Generator:

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

and - of course - implementing its methods.

Definition at line 36 of file guiinterface.h.

Constructor & Destructor Documentation

GuiInterface()

Okular::GuiInterface::GuiInterface ( )

inline

Definition at line 39 of file guiinterface.h.

~GuiInterface()

Okular::GuiInterface::~GuiInterface ( )

inlineoverride

Destroys the gui interface.

Definition at line 46 of file guiinterface.h.

Member Function Documentation

guiClient()

KXMLGUIClient * Okular::GuiInterface::guiClient ( )

inline

This method requests the XML GUI Client provided by the interface.

Definition at line 56 of file guiinterface.h.

---

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

• guiinterface.h