okular
#include <generator.h>
Public Types | |
typedef QList< ExportFormat > | List |
enum | StandardExportFormat { PlainText, PDF, OpenDocumentText, HTML } |
Public Member Functions | |
ExportFormat () | |
ExportFormat (const QString &description, const KMimeType::Ptr &mimeType) | |
ExportFormat (const KIcon &icon, const QString &description, const KMimeType::Ptr &mimeType) | |
ExportFormat (const ExportFormat &other) | |
~ExportFormat () | |
QString | description () const |
KIcon | icon () const |
bool | isNull () const |
KMimeType::Ptr | mimeType () const |
bool | operator!= (const ExportFormat &other) const |
ExportFormat & | operator= (const ExportFormat &other) |
bool | operator== (const ExportFormat &other) const |
Static Public Member Functions | |
static ExportFormat | standardFormat (StandardExportFormat type) |
Detailed Description
Defines an entry for the export menu.
This class encapsulates information about an export format. Every Generator can support 0 or more export formats which can be queried with Generator::exportFormats().
Definition at line 76 of file generator.h.
Member Typedef Documentation
Definition at line 79 of file generator.h.
Member Enumeration Documentation
Type of standard export format.
Enumerator | |
---|---|
PlainText |
Plain text. |
PDF, aka Portable Document Format. | |
OpenDocumentText |
OpenDocument Text format.
|
HTML |
OpenDocument Text format.
|
Definition at line 146 of file generator.h.
Constructor & Destructor Documentation
ExportFormat::ExportFormat | ( | ) |
ExportFormat::ExportFormat | ( | const QString & | description, |
const KMimeType::Ptr & | mimeType | ||
) |
Creates a new export format.
- Parameters
-
description The i18n'ed description of the format. mimeType The supported mime type of the format.
Definition at line 575 of file generator.cpp.
ExportFormat::ExportFormat | ( | const KIcon & | icon, |
const QString & | description, | ||
const KMimeType::Ptr & | mimeType | ||
) |
Creates a new export format.
- Parameters
-
icon The icon used in the GUI for this format. description The i18n'ed description of the format. mimeType The supported mime type of the format.
Definition at line 580 of file generator.cpp.
ExportFormat::~ExportFormat | ( | ) |
Destroys the export format.
Definition at line 585 of file generator.cpp.
ExportFormat::ExportFormat | ( | const ExportFormat & | other | ) |
Definition at line 589 of file generator.cpp.
Member Function Documentation
QString ExportFormat::description | ( | ) | const |
Returns the description of the format.
Definition at line 604 of file generator.cpp.
KIcon ExportFormat::icon | ( | ) | const |
Returns the icon for GUI representations of the format.
Definition at line 614 of file generator.cpp.
bool ExportFormat::isNull | ( | ) | const |
Returns whether the export format is null/valid.
An ExportFormat is null if the mimetype is not valid or the description is empty, or both.
Definition at line 619 of file generator.cpp.
KMimeType::Ptr ExportFormat::mimeType | ( | ) | const |
Returns the mime type of the format.
Definition at line 609 of file generator.cpp.
bool ExportFormat::operator!= | ( | const ExportFormat & | other | ) | const |
Definition at line 652 of file generator.cpp.
ExportFormat & ExportFormat::operator= | ( | const ExportFormat & | other | ) |
Definition at line 594 of file generator.cpp.
bool ExportFormat::operator== | ( | const ExportFormat & | other | ) | const |
Definition at line 647 of file generator.cpp.
|
static |
Builds a standard format for the specified type
.
Definition at line 624 of file generator.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.