Celartem::ImageStatusFlags

Celartem::ImageStatusFlags Struct Reference

#include <pxl_image.h>

List of all members.

Public Member Functions

bool isSizeChanged () const
bool isPhotometricChanged () const
bool isPictureChanged () const
bool isChanged () const
 ImageStatusFlags (unsigned int inFlags=0)

Public Attributes

unsigned int flags

Static Public Attributes

static const unsigned int SIZE_CHANGED = 1
 Indicates the the size of the Image is changed.
static const unsigned int PHOTOMETRIC_CHANGED = 2
 Indicates the Photometric of the Image is changed.
static const unsigned int PICTURE_CHANGED = 4
 Indicates the cached image of this Image should be cleared.

Detailed Description

This structure is used by Image::setParam function to return the status of the Image instance to the caller.
See also:
Image, Image::setParam

Definition at line 33 of file pxl_image.h.

Constructor & Destructor Documentation

Celartem::ImageStatusFlags::ImageStatusFlags ( unsigned int  inFlags = 0  )  [inline]

This constructor initializes the status flags.

Parameters:
inFlags The initial state of the flags.

Definition at line 101 of file pxl_image.h.

Member Function Documentation

bool Celartem::ImageStatusFlags::isSizeChanged (  )  const [inline]

This function checks whether the pixel size (width and/or height) of the Image are changed or not.

Returns:
true if the pixel size is changed, otherwise false.

Definition at line 59 of file pxl_image.h.

bool Celartem::ImageStatusFlags::isPhotometricChanged (  )  const [inline]

This function checks whether the photometric (colorspace and/or pixel layout) of the Image are changed or not.

Returns:
true if the photometric are changed, otherwise false.

Definition at line 70 of file pxl_image.h.

bool Celartem::ImageStatusFlags::isPictureChanged (  )  const [inline]

This function checks whether the contents of the Image are changed or not.

Returns:
true if the contents are changed, otherwise false.

Definition at line 81 of file pxl_image.h.

bool Celartem::ImageStatusFlags::isChanged (  )  const [inline]

This function checks whether the Image is changed or not.

Returns:
true if something has changed, otherwise false.

Definition at line 91 of file pxl_image.h.

Member Data Documentation

const unsigned int Celartem::ImageStatusFlags::SIZE_CHANGED = 1 [static]

Indicates the the size of the Image is changed.

Definition at line 35 of file pxl_image.h.

Referenced by isSizeChanged().

const unsigned int Celartem::ImageStatusFlags::PHOTOMETRIC_CHANGED = 2 [static]

Indicates the Photometric of the Image is changed.

Definition at line 38 of file pxl_image.h.

Referenced by isPhotometricChanged().

const unsigned int Celartem::ImageStatusFlags::PICTURE_CHANGED = 4 [static]

Indicates the cached image of this Image should be cleared.

Definition at line 41 of file pxl_image.h.

Referenced by isPictureChanged().

unsigned int Celartem::ImageStatusFlags::flags

Any combination of SIZE_CHANGED, PHOTOMETRIC_CHANGED and PICTURE_CHANGED.
You had better use the accessor functions instead of directly referencing this value.

See also:
isSizeChanged, isPhotometricChanged, isPictureChanged

Definition at line 51 of file pxl_image.h.

Referenced by isChanged(), isPhotometricChanged(), isPictureChanged(), and isSizeChanged().

The documentation for this struct was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:11 2008.