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

Member Typedef Documentation

typedef QList<ExportFormat> Okular::ExportFormat::List

Definition at line 78 of file generator.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

ExportFormat::ExportFormat ( )

Creates an empty export format.

See also: isNull()

Definition at line 528 of file generator.cpp.

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

ExportFormat::~ExportFormat ( )

Destroys the export format.

Definition at line 543 of file generator.cpp.

ExportFormat::ExportFormat ( const ExportFormat & other )

Definition at line 547 of file generator.cpp.

Member Function Documentation

QString ExportFormat::description ( ) const

Returns the description of the format.

Definition at line 562 of file generator.cpp.

KIcon ExportFormat::icon ( ) const

Returns the icon for GUI representations of the format.

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

KMimeType::Ptr ExportFormat::mimeType ( ) const

Returns the mime type of the format.

Definition at line 567 of file generator.cpp.

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

Definition at line 610 of file generator.cpp.

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

Definition at line 552 of file generator.cpp.

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

Definition at line 605 of file generator.cpp.

ExportFormat ExportFormat::standardFormat ( StandardExportFormat type )

static

Builds a standard format for the specified type .

Definition at line 582 of file generator.cpp.

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

okular

Public Types

Public Member Functions

Static Public Member Functions