AvogadroLibs  1.96.0
Public Slots | Signals | Public Member Functions | List of all members
ExtensionPlugin Class Referenceabstract

The base class for extension plugin factories in Avogadro. More...

#include <avogadro/qtgui/extensionplugin.h>

Inheritance diagram for ExtensionPlugin:

Public Slots

virtual void setMolecule (QtGui::Molecule *mol)=0
 
virtual bool readMolecule (QtGui::Molecule &mol)
 
virtual void setScene (Rendering::Scene *scene)
 
virtual void setCamera (Rendering::Camera *camera)
 
virtual void setActiveWidget (QWidget *widget)
 

Signals

void moleculeReady (int numberOfMolecules)
 
void fileFormatsReady ()
 
void requestActiveTool (QString toolName)
 
void requestActiveDisplayTypes (QStringList displayTypes)
 

Public Member Functions

 ExtensionPlugin (QObject *parent=nullptr)
 
virtual QString name () const =0
 
virtual QString description () const =0
 
virtual QList< QAction * > actions () const =0
 
virtual QStringList menuPath (QAction *action=nullptr) const =0
 
virtual QList< Io::FileFormat * > fileFormats () const
 

Detailed Description

Author
Marcus D. Hanwell

Member Function Documentation

◆ name()

virtual QString name ( ) const
pure virtual

The name of the extension plugin, will be displayed in the user interface.

◆ description()

virtual QString description ( ) const
pure virtual

A description of the extension plugin, may be displayed in the user interface.

◆ actions()

virtual QList<QAction*> actions ( ) const
pure virtual
Returns
The QActions for this extension (should be at least one).

◆ menuPath()

virtual QStringList menuPath ( QAction *  action = nullptr) const
pure virtual
Returns
The menu path of the supplied action. This can be empty if the action was not recognized, or contain two or more strings (top level, plus name, e.g. File, &Open).

◆ fileFormats()

virtual QList<Io::FileFormat*> fileFormats ( ) const
virtual
Returns
A list of file format readers/writers.

The caller takes ownership of the objects in the returned list.

◆ setMolecule

virtual void setMolecule ( QtGui::Molecule mol)
pure virtualslot

Called when the current molecule changes.

◆ readMolecule

virtual bool readMolecule ( QtGui::Molecule mol)
virtualslot

Call this slot when the moleculeReady signal indicated that a molecule is ready to be read. The molecule will have the data read into it. The slot will

Returns
true if a molecule was successfully read in.

◆ setScene

virtual void setScene ( Rendering::Scene scene)
virtualslot

Called when the current scene changes.

◆ setCamera

virtual void setCamera ( Rendering::Camera camera)
virtualslot

Called when the active camera for the view changes.

◆ setActiveWidget

virtual void setActiveWidget ( QWidget *  widget)
virtualslot

Called when the active widget changes. This must be used carefully, and should check that the widget has been cast if used.

◆ moleculeReady

void moleculeReady ( int  numberOfMolecules)
signal

Signal that the extension has a new molecule that is ready to be loaded. The application must call readMolecule in order to actually read the molecule(s).

◆ fileFormatsReady

void fileFormatsReady ( )
signal

Signal that the extension has file formats that are ready to be registered. If emitted the application should call fileFormats to get the formats the extension is registering.

◆ requestActiveTool

void requestActiveTool ( QString  toolName)
signal

Signal to request a particular tool is set as the active tool. This is useful when loading a structure outside of the normal file API and setting "Navigator" to active instead of "Editor" (the default).

◆ requestActiveDisplayTypes

void requestActiveDisplayTypes ( QStringList  displayTypes)
signal

Request a specific display type (or types) are active, and all others are disabled. This can be useful when loading a specific type of data that would be most readily viewed with a specialized view.


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