Computer Assisted Medical Intervention Tool Kit  version 5.2
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
}
 list of supported screenshot export formats More...
 

Public Member Functions

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

Static Public Member Functions

static const ScreenshotFormatInfodefaultFormat ()
 
static const QString fileFilters ()
 return a list of supported format that can be used in a QFileDialog More...
 
static const ScreenshotFormatInfoget (QString)
 get the information from the extension (QString) More...
 
static const ScreenshotFormatInfoget (ScreenshotFormat)
 retun the information concerning the supporting format using an index corresponding to the enum (check index validity) More...
 
static const ScreenshotFormatInfoget (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...
 

Detailed Description

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

Member Enumeration Documentation

◆ 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

References get(), and PNG.

+ Here is the call graph for this function:

◆ fileFilters()

const QString camitk::ScreenshotFormatInfo::fileFilters ( )
static

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

References description, extension, get(), and NOT_SUPPORTED.

Referenced by camitk::InteractiveViewer::screenshot().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get() [1/3]

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

get the information from the extension (QString)

References extension, get(), and NOT_SUPPORTED.

+ 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)

References getMap().

+ Here is the call graph for this function:

◆ 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)

References NOT_SUPPORTED.

Referenced by defaultFormat(), fileFilters(), and get().

+ Here is the caller graph for this function:

◆ getMap()

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

get the map

Referenced by get().

+ Here is the caller graph for this function:

Member Data Documentation

◆ description

QString camitk::ScreenshotFormatInfo::description

file format description

Referenced by fileFilters().

◆ extension

QString camitk::ScreenshotFormatInfo::extension

file extension (suffix)

Referenced by fileFilters(), and get().

◆ type

ScreenshotFormat camitk::ScreenshotFormatInfo::type {NOT_SUPPORTED}

the corresponding type (key)


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