RVC::UI::FORM_RASTER_COMPRESSION Class Reference

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

#include <rvc/uiformrastercompression.h>

Inheritance diagram for RVC::UI::FORM_RASTER_COMPRESSION:

[legend]

List of all members.

Public Types
enum	FORMSTYLE { FORMSTYLE_Default = 0x00, FORMSTYLE_NoLossy = 0x01, FORMSTYLE_NoReadOnly = 0x02 }
Public Member Functions
	FORM_RASTER_COMPRESSION ()
virtual	~FORM_RASTER_COMPRESSION ()
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, FORMSTYLE Style=FORMSTYLE_Default, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedHeight)
MGUI::CTRL_COMBOBOX &	GetComboBox ()
UINT16	GetCompressionQualityRatio ()
RVC::RASTER::COMPTYPE	GetCompressionType () const
MGUI::CTRL_LABEL &	GetLabel ()
void	IniRead (INIHANDLE IniHandle, const char *IniGroup, const char *IniField, bool notify)
void	IniWrite (INIHANDLE IniHandle, const char *IniGroup, const char *IniField) const
bool	IsLossy () const
void	SetCellType (RVC::IMAGE::CELLTYPE CellType)
void	SetCompression (RVC::RASTER::COMPTYPE CompType, UINT16 CompQualityRatio=0)
void	SetDelegateOnChangeCompressionType (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnChangeQualityRatio (DELEGATE_VOID_NOPARMS delegate)
void	SetFromMakeParms (const RVC::RASTER::MAKEPARMS &MakeParms)

---

Detailed Description

Form for setting raster internal compression type and quality.

---

Member Enumeration Documentation

enum RVC::UI::FORM_RASTER_COMPRESSION::FORMSTYLE

Form style enumeration.

Enumerator:

FORMSTYLE_Default
FORMSTYLE_NoLossy	Don't allow lossy compression choices.
FORMSTYLE_NoReadOnly	Don't allow compression which does not support overwrite.

---

Constructor & Destructor Documentation

RVC::UI::FORM_RASTER_COMPRESSION::FORM_RASTER_COMPRESSION

(

)

Constructor.

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

virtual RVC::UI::FORM_RASTER_COMPRESSION::~FORM_RASTER_COMPRESSION

(

)

[virtual]

Destructor.

---

Member Function Documentation

ERRVALUE RVC::UI::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

MGUI::CTRL_COMBOBOX& RVC::UI::FORM_RASTER_COMPRESSION::GetComboBox

(

)

[inline]

Retrieve combo box control for form.

UINT16 RVC::UI::FORM_RASTER_COMPRESSION::GetCompressionQualityRatio

(

)

Get currently selected compression quality/ratio.

Returns:

Compression quality/ratio.

RVC::RASTER::COMPTYPE RVC::UI::FORM_RASTER_COMPRESSION::GetCompressionType

(

)

const

Get currently selected compression type.

MGUI::CTRL_LABEL& RVC::UI::FORM_RASTER_COMPRESSION::GetLabel

(

)

[inline]

Retrieve label control for form.

Usually the label control is only retrieved for alignment purposes.

void RVC::UI::FORM_RASTER_COMPRESSION::IniRead	(	INIHANDLE	IniHandle,
		const char *	IniGroup,
		const char *	IniField,
		bool	notify
	)

Read settings from INI file.

Parameters:

	IniHandle	Handle to INI file to read from, 0 for default
	IniGroup	INI group to read from
	IniField	INI field to read from
	notify	Call delegates if changed

void RVC::UI::FORM_RASTER_COMPRESSION::IniWrite	(	INIHANDLE	IniHandle,
		const char *	IniGroup,
		const char *	IniField
	)			const

Write settings to INI file.

Parameters:

	IniHandle	Handle to INI file to read from, 0 for default
	IniGroup	INI group to read from
	IniField	INI field to read from

bool RVC::UI::FORM_RASTER_COMPRESSION::IsLossy

(

)

const

Determine if lossy compression type is selected.

void RVC::UI::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 RVC::UI::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 RVC::UI::FORM_RASTER_COMPRESSION::SetDelegateOnChangeCompressionType

(

DELEGATE_VOID_NOPARMS

delegate

)

[inline]

Set delegate to call when compression type changed.

void RVC::UI::FORM_RASTER_COMPRESSION::SetDelegateOnChangeQualityRatio

(

DELEGATE_VOID_NOPARMS

delegate

)

Set delegate to call when quality/ratio value changed.

void RVC::UI::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:

• rvc/uiformrastercompression.h