ai::ColorSpaceList Class Reference

This class represents a list of color spaces for Illustrator. More...

#include <IAIColorSpace.hpp>

List of all members.

Public Member Functions
void	swap (ColorSpaceList &rhs) AINOEXCEPT
	Swaps the contents of this ColorSpaceList with another ColorSpaceList.
ai::ColorSpaceList &	operator= (const ai::ColorSpaceList &rhs)
	Copy assignment operator.
bool	IsValid (void) const
	Reports whether this color-space list is valid.
void	AddColorSpace (const ai::ColorSpace &cs)
	Adds a color-space entry to this color-space list.
int	NumColorSpaces (void) const
	Reports the number of color-space entries in this list.
ai::ColorSpace	NthColorSpace (int n) const
	Retrieves a color space from this list.
void	Normalize (short docColorModel, bool convertGrayToFullProcess=false)
	Normalizes this color-space list by flattening any n-channel color-spaces, removing duplicates, compacting 4-process separation color spaces into a single CMYK process color space, and sorting the color spaces.
void	deleteImpl (void)
	Internal.
Constructors & Destructor
	ColorSpaceList (void) AINOTHROW
	Default color space list constructor.
	ColorSpaceList (const ai::ColorSpace &cs)
	Creates a color space list containing an initial color space entry.
	ColorSpaceList (const ai::ColorSpaceList &csList)
	Copy constructor.
	~ColorSpaceList ()
	Destructor.
Friends
class	ColorSpace
	Colorspaces that can be displayed by the Color palette for editing colors.

---

Detailed Description

This class represents a list of color spaces for Illustrator.

---

Constructor & Destructor Documentation

ai::ColorSpaceList::ColorSpaceList

(

void

)

[explicit]

Default color space list constructor.

Creates an invalid color space list. Throws no exceptions.

Returns:

The new list object.

ai::ColorSpaceList::ColorSpaceList

(

const ai::ColorSpace &

cs

)

[explicit]

Creates a color space list containing an initial color space entry.

Parameters:

cs

The initial color space object.

Returns:

The new list object.

ai::ColorSpaceList::ColorSpaceList

(

const ai::ColorSpaceList &

csList

)

Copy constructor.

Parameters:

csList

The color-space list object to copy.

Returns:

The new list object.

ai::ColorSpaceList::~ColorSpaceList

(

)

Destructor.

---

Member Function Documentation

void ai::ColorSpaceList::AddColorSpace

(

const ai::ColorSpace &

cs

)

Adds a color-space entry to this color-space list.

Parameters:

cs

The color-space list object to add.

Returns:

Nothing.

void ai::ColorSpaceList::deleteImpl

(

void

)

Internal.

bool ai::ColorSpaceList::IsValid

(

void

)

const

Reports whether this color-space list is valid.

Returns:

True if the list is valid.

void ai::ColorSpaceList::Normalize	(	short	docColorModel,
		bool	convertGrayToFullProcess = false
	)

Normalizes this color-space list by flattening any n-channel color-spaces, removing duplicates, compacting 4-process separation color spaces into a single CMYK process color space, and sorting the color spaces.

The order of the spot-separation color spaces is preserved.

Parameters:

	docColorModel	The document color model, an AIDocumentColorModelValue.
	convertGrayToFullProcess	Optional. When false (the default), if the document color model is CMYK, a gray color space is converted to separation Black. Otherwise, a gray color space is converted to the full process color in the document color space.

Returns:

Nothing.

ai::ColorSpace ai::ColorSpaceList::NthColorSpace

(

int

n

)

const

Retrieves a color space from this list.

Throws bad-parameter error if index is out of range.

Parameters:

n

The 0-based index of the color-space entry.

Returns:

The color-space object.

int ai::ColorSpaceList::NumColorSpaces

(

void

)

const

Reports the number of color-space entries in this list.

Returns:

The number of entries.

ai::ColorSpaceList& ai::ColorSpaceList::operator=

(

const ai::ColorSpaceList &

rhs

)

Copy assignment operator.

void ai::ColorSpaceList::swap

(

ColorSpaceList &

rhs

)

[inline]

Swaps the contents of this ColorSpaceList with another ColorSpaceList.

Inline implementations.

Parameters:

rhs

The ColorSpaceList to swap.

Returns:

Nothing.

swap function

---

Friends And Related Function Documentation

friend class ColorSpace [friend]

Colorspaces that can be displayed by the Color palette for editing colors.

---

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

• IAIColorSpace.hpp