Search for usage in LXR

Okular::GuiInterface Class Reference

#include <guiinterface.h>

Inheritance diagram for Okular::GuiInterface:

Public Member Functions

 GuiInterface (const GuiInterface &)=delete
 ~GuiInterface () override
KXMLGUIClientguiClient ()
GuiInterfaceoperator= (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)
QActionaction (const char *name) const
virtual QActionaction (const QDomElement &element) const
virtual KActionCollectionactionCollection () const
QList< KXMLGUIClient * > childClients ()
KXMLGUIBuilderclientBuilder () const
virtual QString componentName () const
virtual QDomDocument domDocument () const
KXMLGUIFactoryfactory () const
void insertChildClient (KXMLGUIClient *child)
KXMLGUIClientparentClient () 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_INTERFACES( Okular::GuiInterface )

and - of course - implementing its methods.

Definition at line 36 of file guiinterface.h.

Constructor & Destructor Documentation

◆ ~GuiInterface()

Okular::GuiInterface::~GuiInterface ( )

Destroys the gui interface.

Definition at line 46 of file guiinterface.h.

Member Function Documentation

◆ guiClient()

KXMLGUIClient* Okular::GuiInterface::guiClient ( )

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:
[Abstract Class] The information generator.
Definition: generator.h:187
Abstract interface for user interface control.
Definition: guiinterface.h:36
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 19 2022 04:10:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.