MGUI::FORM_RASTER_COMPRESSION Class Reference

Form for setting raster internal compression type and quality. More...

#include <mgui/formrcmp.h>

Inheritance diagram for MGUI::FORM_RASTER_COMPRESSION:

[legend]List of all members.

Public Types
enum	FORMSTYLE { FORMSTYLE_Default = 0x00, FORMSTYLE_NoLossy = 0x01, FORMSTYLE_NoReadOnly = 0x02 }
Public Member Functions
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, FORMSTYLE Style=FORMSTYLE_Default, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedHeight)
	FORM_RASTER_COMPRESSION ()
UINT16	GetCompressionQualityRatio ()
RVC::RASTER::COMPTYPE	GetCompressionType () const
bool	IsLossy () const
void	SetCellType (RVC::IMAGE::CELLTYPE CellType)
void	SetCompression (RVC::RASTER::COMPTYPE CompType, UINT16 CompQualityRatio=0)
void	SetFromMakeParms (const RVC::RASTER::MAKEPARMS &MakeParms)
virtual	~FORM_RASTER_COMPRESSION ()

---

Detailed Description

Form for setting raster internal compression type and quality.

Definition at line 58 of file formrcmp.h.

---

Member Enumeration Documentation

enum MGUI::FORM_RASTER_COMPRESSION::FORMSTYLE

Form style enumeration. Enumeration values: FORMSTYLE_Default  FORMSTYLE_NoLossy  Don't allow lossy compression choices. FORMSTYLE_NoReadOnly  Don't allow compression which does not support overwrite. Definition at line 62 of file formrcmp.h.

---

Constructor & Destructor Documentation

MGUI::FORM_RASTER_COMPRESSION::FORM_RASTER_COMPRESSION (   )

Constructor. Defaults to a celltype of RVC::IMAGE::CELLTYPE_Unsigned_8 for menu generation purposes

virtual MGUI::FORM_RASTER_COMPRESSION::~FORM_RASTER_COMPRESSION (   )  [virtual]

Destructor.

---

Member Function Documentation

ERRVALUE MGUI::FORM_RASTER_COMPRESSION::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, FORMSTYLE  Style = FORMSTYLE_Default, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight )

Create the form. Parameters: ParentPane  Parent pane Style  Form style

UINT16 MGUI::FORM_RASTER_COMPRESSION::GetCompressionQualityRatio (   )

Get currently selected compression quality/ratio. Returns: Compression quality/ratio.

RVC::RASTER::COMPTYPE MGUI::FORM_RASTER_COMPRESSION::GetCompressionType (   )  const

Get currently selected compression type.

bool MGUI::FORM_RASTER_COMPRESSION::IsLossy (   )  const

Determine if lossy compression type is selected.

void MGUI::FORM_RASTER_COMPRESSION::SetCellType (  RVC::IMAGE::CELLTYPE  CellType  )

Set cell type for limiting compression choices. If current compression type not allowed for specified CELLTYPE the selection will be reset to 'uncompressed'. Create() must be called before using this method.

void MGUI::FORM_RASTER_COMPRESSION::SetCompression (  RVC::RASTER::COMPTYPE  CompType, UINT16  CompQualityRatio = 0 )

Set selected compression parameters. If specified values are not allowed for current CELLTYPE the selection will be left unchanged. Create() must be called before using this method. Parameters: CompType  Compression type CompQualityRatio  Compression quality or ratio, 0 for maximum quality/lossless

void MGUI::FORM_RASTER_COMPRESSION::SetFromMakeParms (  const RVC::RASTER::MAKEPARMS &  MakeParms  )

Set cell type and compression selection from RASTER::MAKEPARMS.

---

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

• mgui/formrcmp.h

---