LibEngsas
Public Member Functions | List of all members
ESpreadsheetProvider Class Reference

Interface to implement spreadsheet providers (e. g. to create excel files or ods, ...)An ESpreadsheetProvider is an interface, to add support for specific spreadsheet file types (like csv, xls, ods, ...). A provider must be build as a plugin and placed at the ENGSAS_ESPREADSHEET_PROVIDER_PLUGIN_DIR, which is per default below the EPart directory. More...

#include <espreadsheetprovider.h>

+ Inheritance diagram for ESpreadsheetProvider:
+ Collaboration diagram for ESpreadsheetProvider:

Public Member Functions

virtual ~ESpreadsheetProvider ()
virtual QString name () const =0
virtual QString providerId () const =0
virtual ESettingsWidgetsettingsWidget () const =0
virtual QStringList filters () const =0
virtual bool sheetsSupported () const =0
 Return true, if (more than one) sheet is supported.
virtual bool create (QFile *file)=0
virtual bool load (QFile *file)=0
virtual bool writeData ()=0
virtual void close ()=0
 Closes the opened file and deletes the spreadsheets.
virtual ESpreadsheetappendSpreadsheet (QString name)=0
virtual EngSaS::Spreadsheets spreadsheets ()=0
- Public Member Functions inherited from EObject
 EObject (QObject *parent=0)
virtual ~EObject ()
void connectByPass (QObject *object)

Additional Inherited Members

- Public Slots inherited from EObject
virtual void reloadSettings ()
 Used to reload the settings.
- Signals inherited from EObject
void error (const QString &message)
void warning (const QString &message)
void information (const QString &message)
void reloadEnableActions ()
 Request reloading of enabled actions in EMainWindow.
void addMenu (QMenu *newMenu, const QString &parent, QString before=QString())
void addAction (QAction *newAction, const QString &parent, QString before=QString())
void addToolBar (QToolBar *newToolBar, Qt::ToolBarArea area=Qt::TopToolBarArea)
void addNewDockWidget (QDockWidget *widget, const Qt::DockWidgetArea &area)
void setCentralWidget (QWidget *centralWidget)
void showSettings ()
void showHelp (const QString &page)
void showStatusWidget (QWidget *widget)
void reloadSettingsRequest ()
 Indicates, that a reload of the settings is needed.
void doReloadSettings ()
 Emitted to bring the reload request back to the farest child.
- Static Public Member Functions inherited from EObject
static void connectByPass (QObject *parent, QObject *child)
- Protected Slots inherited from EObject
virtual void errorByPass (const QString &message)
virtual void warningByPass (const QString &message)
virtual void informationByPass (const QString &message)
virtual void reloadEnableActionsByPass ()
virtual void addMenuByPass (QMenu *newMenu, const QString &parent, QString before=QString())
virtual void addActionByPass (QAction *newAction, const QString &parent, QString before=QString())
virtual void addToolBarByPass (QToolBar *newToolBar, Qt::ToolBarArea area=Qt::TopToolBarArea)
virtual void addNewDockWidgetByPass (QDockWidget *widget, const Qt::DockWidgetArea &area)
virtual void setCentralWidgetByPass (QWidget *centralWidget)
virtual void showSettingsByPass ()
virtual void showHelpByPass (const QString &page)
virtual void showStatusWidgetByPass (QWidget *widget)
virtual void reloadSettingsRequestByPass ()
- Protected Member Functions inherited from EObject
void addManagedDockWidget (QDockWidget *widget, const Qt::DockWidgetArea &area, QString actionLabel=QString(), QString actionParent=QString())
 Adds an dock widget via addNewDockWidget() and adds widget to the list of managed dock widgets.

Detailed Description

Interface to implement spreadsheet providers (e. g. to create excel files or ods, ...)

An ESpreadsheetProvider is an interface, to add support for specific spreadsheet file types (like csv, xls, ods, ...). A provider must be build as a plugin and placed at the ENGSAS_ESPREADSHEET_PROVIDER_PLUGIN_DIR, which is per default below the EPart directory.

Constructor & Destructor Documentation

virtual ESpreadsheetProvider::~ESpreadsheetProvider ( )
inlinevirtual

Member Function Documentation

virtual ESpreadsheet* ESpreadsheetProvider::appendSpreadsheet ( QString  name)
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual void ESpreadsheetProvider::close ( )
pure virtual

Closes the opened file and deletes the spreadsheets.

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual bool ESpreadsheetProvider::create ( QFile *  file)
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual QStringList ESpreadsheetProvider::filters ( ) const
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual bool ESpreadsheetProvider::load ( QFile *  file)
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual QString ESpreadsheetProvider::name ( ) const
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual QString ESpreadsheetProvider::providerId ( ) const
pure virtual
virtual ESettingsWidget* ESpreadsheetProvider::settingsWidget ( ) const
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual bool ESpreadsheetProvider::sheetsSupported ( ) const
pure virtual

Return true, if (more than one) sheet is supported.

E. g. CSV returns false, but XLS or ODS return true.

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

virtual EngSaS::Spreadsheets ESpreadsheetProvider::spreadsheets ( )
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:

virtual bool ESpreadsheetProvider::writeData ( )
pure virtual

Implemented in ESpreadsheetProviderMs, and ESpreadsheetProviderCsv.

+ Here is the caller graph for this function:


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