camitk::ScreenshotFormatInfo Class Reference

class containing all information concerning exporting images (screenshot) and the different supported format and extension. More...

#include <ScreenshotFormatInfo.h>

Collaboration diagram for camitk::ScreenshotFormatInfo:

Public Types
enum	ScreenshotFormat {   PNG = 0, JPG, BMP, PS,   EPS, PDF, TEX, SVG,   OBJ, RIB, VRML, NOT_SUPPORTED }

Public Member Functions
	ScreenshotFormatInfo ()
	default constructor More...
	ScreenshotFormatInfo (ScreenshotFormat t, QString e, QString d)
	Constructor. More...

Static Public Member Functions
static const ScreenshotFormatInfo *	defaultFormat ()
static const QString	fileFilters ()
	return a list of supported format that can be used in a QFileDialog More...
static const ScreenshotFormatInfo *	get (QString)
	get the information from the extension (QString) More...
static const ScreenshotFormatInfo *	get (ScreenshotFormat)
	retun the information concerning the supporting format using an index corresponding to the enum (check index validity) More...
static const ScreenshotFormatInfo *	get (unsigned int)
	return the information concerning the supporting format using an index corresponding to the enum (check index validity) More...
static const QMap< ScreenshotFormat, ScreenshotFormatInfo * >	getMap ()
	get the map More...

Public Attributes
QString	description
	file format description More...
QString	extension
	file extension (suffix) More...
ScreenshotFormat	type {NOT_SUPPORTED}
	the corresponding type (key) More...

Static Private Member Functions
static QMap< ScreenshotFormat, ScreenshotFormatInfo * >	initMap ()
	build the map More...

Detailed Description

class containing all information concerning exporting images (screenshot) and the different supported format and extension.

Member Enumeration Documentation

ScreenshotFormat

enum camitk::ScreenshotFormatInfo::ScreenshotFormat

list of supported screenshot export formats

Enumerator
PNG	Portable Network Graphics.
JPG	JPEG.
BMP	Bitmap.
PS	PostScript.
EPS	Encapsulated PostScript.
PDF	Portable Document Format.
TEX	LaTeX (only the text is exported)
SVG	Scalable Vector Graphics.
OBJ	Alias Wavefront .OBJ.
RIB	RenderMan/BMRT .RIB.
VRML	VRML 2.0.
NOT_SUPPORTED

Constructor & Destructor Documentation

ScreenshotFormatInfo() [1/2]

camitk::ScreenshotFormatInfo::ScreenshotFormatInfo ( ScreenshotFormat  t, QString  e, QString  d  )

inline

Constructor.

ScreenshotFormatInfo() [2/2]

camitk::ScreenshotFormatInfo::ScreenshotFormatInfo ( )

inline

default constructor

Member Function Documentation

defaultFormat()

const camitk::ScreenshotFormatInfo * camitk::ScreenshotFormatInfo::defaultFormat ( )

static

fileFilters()

const QString camitk::ScreenshotFormatInfo::fileFilters ( )

static

return a list of supported format that can be used in a QFileDialog

get() [1/3]

const ScreenshotFormatInfo * camitk::ScreenshotFormatInfo::get ( QString  ext )

static

get the information from the extension (QString)

References extension, and get().

Here is the call graph for this function:

get() [2/3]

const ScreenshotFormatInfo * camitk::ScreenshotFormatInfo::get ( ScreenshotFormat  f )

static

retun the information concerning the supporting format using an index corresponding to the enum (check index validity)

get() [3/3]

const ScreenshotFormatInfo * camitk::ScreenshotFormatInfo::get ( unsigned int  id )

static

return the information concerning the supporting format using an index corresponding to the enum (check index validity)

Referenced by get().

Here is the caller graph for this function:

getMap()

const QMap< ScreenshotFormatInfo::ScreenshotFormat, ScreenshotFormatInfo * > camitk::ScreenshotFormatInfo::getMap ( )

static

get the map

initMap()

QMap< camitk::ScreenshotFormatInfo::ScreenshotFormat, camitk::ScreenshotFormatInfo * > camitk::ScreenshotFormatInfo::initMap ( )

staticprivate

build the map

Member Data Documentation

description

QString camitk::ScreenshotFormatInfo::description

file format description

extension

QString camitk::ScreenshotFormatInfo::extension

file extension (suffix)

Referenced by get().

type

ScreenshotFormat camitk::ScreenshotFormatInfo::type {NOT_SUPPORTED}

the corresponding type (key)

---

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

• ScreenshotFormatInfo.h
• ScreenshotFormatInfo.cpp