LibEngsas
Public Member Functions | Properties | List of all members
EFileSystemPlugin Class Reference

Handles files at the local filesystem. More...

#include <efilesystemplugin.h>

+ Inheritance diagram for EFileSystemPlugin:
+ Collaboration diagram for EFileSystemPlugin:

Public Member Functions

 EFileSystemPlugin (QObject *parent=NULL)
 
QString name () const
 
QString serviceId () const
 
QString description () const
 
EFileInfo info (QString uniqueId) const
 
EFileInfo add (QFileInfo info, bool create) const
 
bool move (EFileInfo source, QString target) const
 Moves the file from source to target. More...
 
bool copy (EFileInfo source, QString target) const
 Copies the file from source to target. More...
 
bool deleteFile (EFileInfo file) const
 
bool open (EFileInfo file)
 Open the given file. More...
 
ESettingsWidget * settingsWidget () const
 
- Public Member Functions inherited from EFileServicePlugin
virtual ~EFileServicePlugin ()
 
- Public Member Functions inherited from EObject
 EObject (QObject *parent=0)
 
virtual ~EObject ()
 
void connectByPass (QObject *object)
 

Properties

QString name
 
QString description
 

Additional Inherited Members

- Public Slots inherited from EObject
virtual void reloadSettings ()
 Used to reload the settings. More...
 
- 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. More...
 
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. More...
 
void doReloadSettings ()
 Emitted to bring the reload request back to the farest child. More...
 
- 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. More...
 

Detailed Description

Handles files at the local filesystem.

It is the simplest thinkable EFileServicePlugin. This is because the uniqueId is the same as the absolute file path.

Constructor & Destructor Documentation

◆ EFileSystemPlugin()

EFileSystemPlugin::EFileSystemPlugin ( QObject *  parent = NULL)
inline

Member Function Documentation

◆ add()

EFileInfo EFileSystemPlugin::add ( QFileInfo  info,
bool  create 
) const
virtual
Todo:
If we should create the object, we cannot decide whether it is a file or a directory.

Implements EFileServicePlugin.

+ Here is the call graph for this function:

◆ copy()

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

Copies the file from source to target.

target should be an absolute file path.

See also
move() to move source.

Implements EFileServicePlugin.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ deleteFile()

bool EFileSystemPlugin::deleteFile ( EFileInfo  file) const
virtual

Implements EFileServicePlugin.

+ Here is the call graph for this function:

◆ description()

QString EFileSystemPlugin::description ( ) const

◆ info()

EFileInfo EFileSystemPlugin::info ( QString  uniqueId) const
virtual
Todo:
Determine the mimetype.

Implements EFileServicePlugin.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ move()

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

Moves the file from source to target.

target should be an absolute file path.

See also
copy() to copy source.

Implements EFileServicePlugin.

+ Here is the call graph for this function:

◆ name()

QString EFileSystemPlugin::name ( ) const
virtual

Implements EFileServicePlugin.

◆ open()

bool EFileSystemPlugin::open ( EFileInfo  file)
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*).

Implements EFileServicePlugin.

+ Here is the call graph for this function:

◆ serviceId()

QString EFileSystemPlugin::serviceId ( ) const
virtual

Implements EFileServicePlugin.

◆ settingsWidget()

ESettingsWidget * EFileSystemPlugin::settingsWidget ( ) const
virtual

Implements EFileServicePlugin.

Property Documentation

◆ description

QString EFileSystemPlugin::description
read

◆ name

QString EFileSystemPlugin::name
read
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15