Okular::ExportFormat

#include <generator.h>

Public Types

typedef QList< ExportFormatList
 
enum  StandardExportFormat { PlainText, PDF, OpenDocumentText, HTML }
 

Public Member Functions

 ExportFormat ()
 
 ExportFormat (const QString &description, const QMimeType &mimeType)
 
 ExportFormat (const QIcon &icon, const QString &description, const QMimeType &mimeType)
 
 ExportFormat (const ExportFormat &other)
 
 ~ExportFormat ()
 
QString description () const
 
QIcon icon () const
 
bool isNull () const
 
QMimeType mimeType () const
 
bool operator!= (const ExportFormat &other) const
 
ExportFormatoperator= (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 80 of file generator.h.

Member Enumeration Documentation

Type of standard export format.

Enumerator
PlainText 

Plain text.

PDF 

PDF, aka Portable Document Format.

OpenDocumentText 

OpenDocument Text format.

Since
0.8 (KDE 4.2)
HTML 

OpenDocument Text format.

Since
0.8 (KDE 4.2)

Definition at line 150 of file generator.h.

Constructor & Destructor Documentation

ExportFormat::ExportFormat ( )

Creates an empty export format.

See also
isNull()

Definition at line 690 of file generator.cpp.

ExportFormat::ExportFormat ( const QString description,
const QMimeType mimeType 
)

Creates a new export format.

Parameters
descriptionThe i18n'ed description of the format.
mimeTypeThe supported mime type of the format.

Definition at line 695 of file generator.cpp.

ExportFormat::ExportFormat ( const QIcon icon,
const QString description,
const QMimeType mimeType 
)

Creates a new export format.

Parameters
iconThe icon used in the GUI for this format.
descriptionThe i18n'ed description of the format.
mimeTypeThe supported mime type of the format.

Definition at line 700 of file generator.cpp.

ExportFormat::~ExportFormat ( )

Destroys the export format.

Definition at line 705 of file generator.cpp.

ExportFormat::ExportFormat ( const ExportFormat other)

Definition at line 709 of file generator.cpp.

Member Function Documentation

QString ExportFormat::description ( ) const

Returns the description of the format.

Definition at line 724 of file generator.cpp.

QIcon ExportFormat::icon ( ) const

Returns the icon for GUI representations of the format.

Definition at line 734 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 739 of file generator.cpp.

QMimeType ExportFormat::mimeType ( ) const

Returns the mime type of the format.

Definition at line 729 of file generator.cpp.

ExportFormat & ExportFormat::operator= ( const ExportFormat other)

Definition at line 714 of file generator.cpp.

ExportFormat ExportFormat::standardFormat ( StandardExportFormat  type)
static

Builds a standard format for the specified type .

Definition at line 744 of file generator.cpp.


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 Fri Nov 27 2020 22:37:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.