Celartem::PFZInfoProvider Class Reference

#include <pxl_pfzutils.h>

List of all members.

Public Member Functions
	PFZInfoProvider (Image *inImage)
	PFZInfoProvider (Doc *inDoc)
	PFZInfoProvider (Storage *inStorage)
bool	isPfz () const
size_t	getWidthLimit () const
size_t	getHeightLimit () const
size_t	getZoomLimit () const
size_t	getLevelLimit () const
Celartem::Guid	getGUID () const
String	getPadsAddress () const
bool	isPrintable () const
bool	isExportable () const
bool	isDuplicatable () const
bool	hasVisibleWatermark () const
bool	hasInvisibleWatermark () const
bool	isAcceptableScale (ssize_t inWidth, ssize_t inHeight) const
Static Public Attributes
static const size_t	Unlimited = (size_t)-1

---

Detailed Description

PFZInfoProvider provides information about an Image or a Doc that is created from PFZ file. Even if the specified instance is not a PFZ, this function also works and the information obtained this class is also correct with non-PFZ files.

Definition at line 26 of file pxl_pfzutils.h.

---

Constructor & Destructor Documentation

Celartem::PFZInfoProvider::PFZInfoProvider

(

Image *

inImage

)

This constructor create a PFZInfoProvider instance from an Image instance. It accepts any Image instances and the PFZInfoProvider created works correctly with non-PFZ files.

See also:

PFZInfoProvider (Doc version)

PFZInfoProvider (Storage version)

Celartem::PFZInfoProvider::PFZInfoProvider

(

Doc *

inDoc

)

This constructor create a PFZInfoProvider instance from a Doc instance. It accepts any Doc instances and the PFZInfoProvider created works correctly with non-PFZ files.

See also:

PFZInfoProvider (Image version)

PFZInfoProvider (Storage version)

Celartem::PFZInfoProvider::PFZInfoProvider

(

Storage *

inStorage

)

This constructor create a PFZInfoProvider instance from a Storage instance. It accepts any Storage instances and the PFZInfoProvider created works correctly with non-PFZ files. Anyway, the PFZInfoProvider instance initialized with this constructor only supports isPfz, getGUID and getPadsAddress functions. The other functions return invalid values.

See also:

PFZInfoProvider (Image version)

PFZInfoProvider (Doc version)

---

Member Function Documentation

bool Celartem::PFZInfoProvider::isPfz

(

)

const

This function checks whether the instance is PFZ or not.

Returns:

true if the instance is PFZ, otherwise false.

size_t Celartem::PFZInfoProvider::getWidthLimit

(

)

const

This function returns the maximum width that the Image instance can be zoomed up to.

Returns:

The maximum width. If there is no restriction on width, this function returns PFZInfoProvider::Unlimited.

See also:

getHeightLimit, getZoomLimit

size_t Celartem::PFZInfoProvider::getHeightLimit

(

)

const

This function returns the maximum height that the Image instance can be zoomed up to.

Returns:

The maximum height. If there is no restriction on height, this function returns PFZInfoProvider::Unlimited.

See also:

getWidthLimit, getZoomLimit

size_t Celartem::PFZInfoProvider::getZoomLimit

(

)

const

This function returns the maximum zoom percentage that the Image instance can be zoomed up to.

Returns:

The maximum percentage. If there is no restriction on zoom percentage, this function returns PFZInfoProvider::Unlimited.

See also:

getWidthLimit, getHeightLimit

size_t Celartem::PFZInfoProvider::getLevelLimit

(

)

const

This function returns the maximum quality level that is imposed to the image. This function only returns a valid value if the image is PFZ or VFZ.

Returns:

The maximum level. If there are no restrictions on the level, this function returns PFZInfoProvider::Unlimited.

Celartem::Guid Celartem::PFZInfoProvider::getGUID

(

)

const

This function returns the GUID of the PFZ image.

Returns:

The GUID of the image if available. If no GUID is associated to the image, this function return a GUID of all 0.

See also:

GUID

String Celartem::PFZInfoProvider::getPadsAddress

(

)

const

This function returns PixelSafe Server address of the PFZ image.

Returns:

The address of the PixelSafe Server if available. For local PFZ or non-PFZ files, this function returns NullString.

bool Celartem::PFZInfoProvider::isPrintable

(

)

const

This function checks whether this image can be printed or not. All PixelSafe Server client must obey this condition.

Returns:

true if printable, otherwise false.

See also:

isExportable, isDuplicatable

bool Celartem::PFZInfoProvider::isExportable

(

)

const

This function checks whether this image can be exported or not. All PixelSafe Server client must obey this condition.

Returns:

true if exportable, otherwise false.

See also:

isPrintable, isDuplicatable

bool Celartem::PFZInfoProvider::isDuplicatable

(

)

const

This function checks whether this image can be duplicated or not. All PixelSafe Server client must obey this condition.

Returns:

true if duplicatable, otherwise false.

See also:

isPrintable, isExportable

bool Celartem::PFZInfoProvider::hasVisibleWatermark

(

)

const

This function checks whether this image has visible watermark or not.

Returns:

true if it has visible watermarks, otherwise false.

See also:

hasInvisibleWatermark

bool Celartem::PFZInfoProvider::hasInvisibleWatermark

(

)

const

This function checks whether this image has invisible watermark or not.

Returns:

true if it has invisible watermarks, otherwise false.

See also:

hasVisibleWatermark

bool Celartem::PFZInfoProvider::isAcceptableScale	(	ssize_t	inWidth,
		ssize_t	inHeight
	)			const

This function verifies the specified dimensions can be acceptable or not. This verification is done based on the maximum width and the maximum height. This function is designed to ease the limit-check on zooming images and inWidth and inHeight are signed.

Parameters:

	inWidth	The width to zoom up to.
	inHeight	The height to zoom up to.

Returns:

ture if acceptable, otherwise false.

See also:

getWidthLimit, getHeightLimit, getZoomLimit

---

Member Data Documentation

const size_t Celartem::PFZInfoProvider::Unlimited = (size_t)-1 [static]

The functions that returns limitation information uses this value to indicate that there are no restrictions on the parameter.

Definition at line 33 of file pxl_pfzutils.h.

---

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

• pxl_pfzutils.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:12 2008.