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

A plugin used by EFileService to handle special file system types. More...

#include <efileserviceplugin.h>

+ Inheritance diagram for EFileServicePlugin:
+ Collaboration diagram for EFileServicePlugin:

Public Member Functions

virtual ~EFileServicePlugin ()
virtual QString name () const =0
virtual QString serviceId () const =0
virtual EFileInfo info (QString uniqueId) const =0
virtual EFileInfo add (QFileInfo info, bool create) const =0
 Adds file described by info to the handled files.
virtual bool move (EFileInfo source, QString target) const =0
 Moves the file from source to target.
virtual bool copy (EFileInfo source, QString target) const =0
 Copies the file from source to target.
virtual bool deleteFile (EFileInfo file) const =0
virtual bool open (EFileInfo file)=0
 Open the given file.
virtual ESettingsWidgetsettingsWidget () const =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

A plugin used by EFileService to handle special file system types.

E.g. you can store the files in a database or an application server.

Constructor & Destructor Documentation

virtual EFileServicePlugin::~EFileServicePlugin ( )
inlinevirtual

Member Function Documentation

virtual EFileInfo EFileServicePlugin::add ( QFileInfo  info,
bool  create 
) const
pure virtual

Adds file described by info to the handled files.

If create is set to true, the file should be created, if it does not exists already.

Adding as is can mean, add a local file to an repository or to a remote file system or something else. In the case of the EFileSystemPlugin, this functions only converts the QFileInfo into an EFileInfo, because the files are the physically the same.

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual bool EFileServicePlugin::copy ( EFileInfo  source,
QString  target 
) const
pure virtual

Copies the file from source to target.

target should be an absolute file path.

See Also
move() to move source.

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual bool EFileServicePlugin::deleteFile ( EFileInfo  file) const
pure virtual

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual EFileInfo EFileServicePlugin::info ( QString  uniqueId) const
pure virtual

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual bool EFileServicePlugin::move ( EFileInfo  source,
QString  target 
) const
pure virtual

Moves the file from source to target.

target should be an absolute file path.

See Also
copy() to copy source.

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual QString EFileServicePlugin::name ( ) const
pure virtual

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual bool EFileServicePlugin::open ( EFileInfo  file)
pure virtual

Open the given file.

If the file must be prepared before it can be opened (like the file must be downloaded first), do such actions in a seperate thread in background. Just start these action and return true here to not freeze the GUI. To open the file, please use EOpenFileExternal::openFile(QString, QString, QObject*).

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual QString EFileServicePlugin::serviceId ( ) const
pure virtual

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:

virtual ESettingsWidget* EFileServicePlugin::settingsWidget ( ) const
pure virtual

Implemented in EFileSystemPlugin.

+ Here is the caller graph for this function:


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