• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::ExportFormat

Okular::ExportFormat Class Reference

#include <generator.h>

List of all members.


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


Public Types

enum  StandardExportFormat { PlainText, PDF }
typedef QList< ExportFormat > List

Public Member Functions

 ExportFormat ()
 ExportFormat (const QString &description, const KMimeType::Ptr &mimeType)
 ExportFormat (const KIcon &icon, const QString &description, const KMimeType::Ptr &mimeType)
 ~ExportFormat ()
 ExportFormat (const ExportFormat &other)
ExportFormat & operator= (const ExportFormat &other)
QString description () const
KMimeType::Ptr mimeType () const
KIcon icon () const
bool isNull () const
bool operator== (const ExportFormat &other) const
bool operator!= (const ExportFormat &other) const

Static Public Member Functions

static ExportFormat standardFormat (StandardExportFormat type)

Member Typedef Documentation

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

Definition at line 72 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.

Definition at line 139 of file generator.h.


Constructor & Destructor Documentation

ExportFormat::ExportFormat (  ) 

Creates an empty export format.

See also:
isNull()

Definition at line 433 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 438 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 443 of file generator.cpp.

ExportFormat::~ExportFormat (  ) 

Destroys the export format.

Definition at line 448 of file generator.cpp.

ExportFormat::ExportFormat ( const ExportFormat &  other  ) 

Definition at line 452 of file generator.cpp.


Member Function Documentation

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

Definition at line 457 of file generator.cpp.

QString ExportFormat::description (  )  const

Returns the description of the format.

Definition at line 467 of file generator.cpp.

KMimeType::Ptr ExportFormat::mimeType (  )  const

Returns the mime type of the format.

Definition at line 472 of file generator.cpp.

KIcon ExportFormat::icon (  )  const

Returns the icon for GUI representations of the format.

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

ExportFormat ExportFormat::standardFormat ( StandardExportFormat  type  )  [static]

Builds a standard format for the specified type .

Definition at line 487 of file generator.cpp.

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

Definition at line 501 of file generator.cpp.

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

Definition at line 506 of file generator.cpp.


The documentation for this class was generated from the following files:
  • generator.h
  • generator.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal