MythTV  master
Public Member Functions | List of all members
Image Class Reference

#include <image.h>

Inheritance diagram for Image:
Inheritance graph
[legend]
Collaboration diagram for Image:
Collaboration graph
[legend]

Public Member Functions

Q_INVOKABLE Image (QObject *=nullptr)
 
QString GetImageInfo (int id, const QString &tag) override
 Returns the value of the specified exif tag from the image file. More...
 
DTC::ImageMetadataInfoListGetImageInfoList (int id) override
 Returns all values from all available exif tags. More...
 
bool RemoveImage (int id) override
 Deletes an image file or dir subtree from filesystem and database. More...
 
bool RenameImage (int id, const QString &newName) override
 Renames the file to the new name. More...
 
bool StartSync (void) override
 Starts the synchronization of the images with the database. More...
 
bool StopSync (void) override
 Stops the image synchronization if its running. More...
 
DTC::ImageSyncInfoGetSyncStatus (void) override
 Returns a list with information if the synchronization is currently running, the already synchronized images and the total amount of images that shall be synchronized. More...
 
bool CreateThumbnail (int id) override
 Request creation of a thumbnail. More...
 
- Public Member Functions inherited from ImageServices
 ImageServices (QObject *parent=nullptr)
 
- Public Member Functions inherited from Service
 Service (QObject *parent=nullptr)
 
virtual QVariant ConvertToVariant (int nType, void *pValue)
 
virtual void * ConvertToParameterPtr (int nTypeId, const QString &sParamType, void *pParam, const QString &sValue)
 

Additional Inherited Members

- Public Slots inherited from ImageServices
- Static Public Member Functions inherited from Service
static bool ToBool (const QString &sVal)
 
- Public Attributes inherited from Service
QList< QString > m_parsedParams
 

Detailed Description

Definition at line 30 of file image.h.

Constructor & Destructor Documentation

◆ Image()

Q_INVOKABLE Image::Image ( QObject *  = nullptr)
inlineexplicit

Definition at line 35 of file image.h.

Member Function Documentation

◆ GetImageInfo()

QString Image::GetImageInfo ( int  id,
const QString &  tag 
)
overridevirtual

Returns the value of the specified exif tag from the image file.

If the filename or exif tag do not exist or the tag has no contents, an empty value is returned.

Parameters
idThe database id of the file
tagThe exif tag
Returns
QString The exif tag value if successful, otherwise empty

Implements ImageServices.

Definition at line 40 of file image.cpp.

Referenced by ScriptableImage::GetImageInfo().

◆ GetImageInfoList()

DTC::ImageMetadataInfoList * Image::GetImageInfoList ( int  id)
overridevirtual

Returns all values from all available exif tags.

Parameters
idThe database id of the file
Returns
DTC::ImageMetadataInfoList The list with all exif values

Implements ImageServices.

Definition at line 75 of file image.cpp.

Referenced by ScriptableImage::GetImageInfoList().

◆ RemoveImage()

bool Image::RemoveImage ( int  id)
overridevirtual

Deletes an image file or dir subtree from filesystem and database.

Parameters
idImage
Returns
bool True if deleted, false otherwise

Implements ImageServices.

Definition at line 134 of file image.cpp.

Referenced by ScriptableImage::RemoveImage().

◆ RenameImage()

bool Image::RenameImage ( int  id,
const QString &  newName 
)
overridevirtual

Renames the file to the new name.

Parameters
idThe database id of the file
newNameThe new name of the file (only the name, no path)
Returns
bool True if renaming was successful, otherwise false

Implements ImageServices.

Definition at line 148 of file image.cpp.

Referenced by ScriptableImage::RenameImage().

◆ StartSync()

bool Image::StartSync ( void  )
overridevirtual

Starts the synchronization of the images with the database.

Returns
bool True if the sync has started, otherwise false

Implements ImageServices.

Definition at line 160 of file image.cpp.

Referenced by ScriptableImage::StartSync().

◆ StopSync()

bool Image::StopSync ( void  )
overridevirtual

Stops the image synchronization if its running.

Returns
bool True if the sync has stopped, otherwise false

Implements ImageServices.

Definition at line 172 of file image.cpp.

Referenced by ScriptableImage::StopSync().

◆ GetSyncStatus()

DTC::ImageSyncInfo * Image::GetSyncStatus ( void  )
overridevirtual

Returns a list with information if the synchronization is currently running, the already synchronized images and the total amount of images that shall be synchronized.

Returns
DTC::ImageSyncInfo The status information

Implements ImageServices.

Definition at line 186 of file image.cpp.

Referenced by ScriptableImage::GetSyncStatus().

◆ CreateThumbnail()

bool Image::CreateThumbnail ( int  id)
overridevirtual

Request creation of a thumbnail.

Parameters
idImage
Returns
bool True if image is valid

Implements ImageServices.

Definition at line 219 of file image.cpp.

Referenced by ScriptableImage::CreateThumbnail().


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