ELVE  1
ELVE Logic Visualization Explorer
Elve::FileExporterPlugin Class Reference

The FileExporterPlugin abstract class. More...

#include <FileExporterPlugin.h>

Public Member Functions

 FileExporterPlugin ()
 FileExporterPlugin.
virtual void exportGraph (const QString &filename, const SharedEGraph &eg)=0
 export the given graph
QGraphicsScene * sceneForGraph (const SharedEGraph &eg)
 get the graph scene, ensuring that it is created
virtual QString formatName ()=0
 tells the name of the export format
virtual QString fileFilter ()=0
 tells the filefilter
virtual std::string cliName ()=0
 command line interface name

Detailed Description

The FileExporterPlugin abstract class.

The FileExporterPlugin is a QPlugin interface allowing to create file exporter plugins. These plugins can be dynamically loaded at runtime to extends the range of files elve can export.

Definition at line 19 of file FileExporterPlugin.h.

Inheritance diagram for Elve::FileExporterPlugin:
Elve::Plugin

Member Function Documentation

virtual std::string Elve::FileExporterPlugin::cliName ( ) [pure virtual]

command line interface name

Returns:

The name of the plugin in the command line, should not contain any spaces and be as short as possible

virtual void Elve::FileExporterPlugin::exportGraph ( const QString &  filename,
const SharedEGraph &  eg 
) [pure virtual]

export the given graph

Parameters:
filenamename of the file to write to
eggraph to export

Must be reimplemented in plugins, contains the export logic.

virtual QString Elve::FileExporterPlugin::fileFilter ( ) [pure virtual]

tells the filefilter

Returns:

This is the Qt filefilter that state the valid extensions and files to export

virtual QString Elve::FileExporterPlugin::formatName ( ) [pure virtual]

tells the name of the export format

Returns:
the name

The format name is the name diplayed in the Gui menus and captions, the true name of the exporter.

QGraphicsScene * Elve::FileExporterPlugin::sceneForGraph ( const SharedEGraph &  eg)

get the graph scene, ensuring that it is created

Parameters:
eg
Returns:
a valid QGraphicsScene, nullptr if something went wrong

Definition at line 10 of file FileExporterPlugin.cpp.

List of all members.


The documentation for this class was generated from the following files:
 All Classes Functions