Okular::EmbeddedFile

Okular::EmbeddedFile Class Referenceabstract

#include <document.h>

Public Member Functions

 EmbeddedFile ()
 
 EmbeddedFile (const EmbeddedFile &)=delete
 
virtual ~EmbeddedFile ()
 
virtual QDateTime creationDate () const =0
 
virtual QByteArray data () const =0
 
virtual QString description () const =0
 
virtual QDateTime modificationDate () const =0
 
virtual QString name () const =0
 
EmbeddedFileoperator= (const EmbeddedFile &)=delete
 
virtual int size () const =0
 

Detailed Description

An embedded file into the document.

This class represents a sort of interface of an embedded file in a document.

Generators must re-implement its members to give the all the information about an embedded file, like its name, its description, the date of creation and modification, and the real data of the file.

Definition at line 1385 of file document.h.

Constructor & Destructor Documentation

EmbeddedFile::EmbeddedFile ( )

Creates a new embedded file.

EmbeddedFile.

Definition at line 5452 of file document.cpp.

EmbeddedFile::~EmbeddedFile ( )
virtual

Destroys the embedded file.

Definition at line 5456 of file document.cpp.

Member Function Documentation

virtual QDateTime Okular::EmbeddedFile::creationDate ( ) const
pure virtual

Returns the creation date of the file, or an invalid date if not available.

virtual QByteArray Okular::EmbeddedFile::data ( ) const
pure virtual

Returns the real data representing the file contents.

virtual QString Okular::EmbeddedFile::description ( ) const
pure virtual

Returns the description of the file, or an empty string if not available.

virtual QDateTime Okular::EmbeddedFile::modificationDate ( ) const
pure virtual

Returns the modification date of the file, or an invalid date if not available.

virtual QString Okular::EmbeddedFile::name ( ) const
pure virtual

Returns the name of the file.

virtual int Okular::EmbeddedFile::size ( ) const
pure virtual

Returns the size (in bytes) of the file, if available, or -1 otherwise.

Note
this method should be a fast way to know the size of the file with no need to extract all the data from it

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Dec 3 2020 22:36:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.