Okular::ExportFormat Class Reference

#include <generator.h>

Public Types
typedef QList< ExportFormat >	List
enum	StandardExportFormat { PlainText , PDF , OpenDocumentText , HTML }

Public Member Functions
	ExportFormat ()
	ExportFormat (const ExportFormat &other)
	ExportFormat (const QIcon &icon, const QString &description, const QMimeType &mimeType)
	ExportFormat (const QString &description, const QMimeType &mimeType)
	~ExportFormat ()
QString	description () const
QIcon	icon () const
bool	isNull () const
QMimeType	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 79 of file generator.h.

Member Typedef Documentation

List

QList<ExportFormat> Okular::ExportFormat::List

Definition at line 82 of file generator.h.

Member Enumeration Documentation

StandardExportFormat

enum Okular::ExportFormat::StandardExportFormat

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 149 of file generator.h.

Constructor & Destructor Documentation

ExportFormat() [1/4]

ExportFormat::ExportFormat

(

)

Creates an empty export format.

See also

isNull()

Definition at line 715 of file generator.cpp.

ExportFormat() [2/4]

ExportFormat::ExportFormat	(	const QString &	description,
		const QMimeType &	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 720 of file generator.cpp.

ExportFormat() [3/4]

ExportFormat::ExportFormat	(	const QIcon &	icon,
		const QString &	description,
		const QMimeType &	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 725 of file generator.cpp.

~ExportFormat()

ExportFormat::~ExportFormat

(

)

Destroys the export format.

Definition at line 730 of file generator.cpp.

ExportFormat() [4/4]

ExportFormat::ExportFormat

(

const ExportFormat &

other

)

Definition at line 734 of file generator.cpp.

Member Function Documentation

description()

QString ExportFormat::description

(

)

const

Returns the description of the format.

Definition at line 750 of file generator.cpp.

icon()

QIcon ExportFormat::icon

(

)

const

Returns the icon for GUI representations of the format.

Definition at line 760 of file generator.cpp.

isNull()

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 765 of file generator.cpp.

mimeType()

QMimeType ExportFormat::mimeType

(

)

const

Returns the mime type of the format.

Definition at line 755 of file generator.cpp.

operator!=()

bool ExportFormat::operator!=

(

const ExportFormat &

other

)

const

Definition at line 796 of file generator.cpp.

operator=()

ExportFormat & ExportFormat::operator=

(

const ExportFormat &

other

)

Definition at line 739 of file generator.cpp.

operator==()

bool ExportFormat::operator==

(

const ExportFormat &

other

)

const

Definition at line 791 of file generator.cpp.

standardFormat()

ExportFormat ExportFormat::standardFormat ( StandardExportFormat type )

static

Builds a standard format for the specified type .

Definition at line 770 of file generator.cpp.

---

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

• generator.h
• generator.cpp