doccolor.h File Reference

(r1785/r1605)

#include "colmodel.h"
#include "stockcol.h"

Go to the source code of this file.

Classes
struct	ColourInfo
class	DocColour
	This class defines a colour. A DocColour stores an original definition of a colour, a cache containing the definition of the colour in the last colour context in which it was used, and sundry information. DocColours have been designed to be small things to put in attributes. More...
Defines
#define	DOCCOLOUR_RGBT(col)   DocColour(COLOURMODEL_RGBT, (ColourGeneric *) col)
#define	DOCCOLOUR_HSVT(col)   DocColour(COLOURMODEL_HSVT, (ColourGeneric *) col)
#define	DOCCOLOUR_CMYK(col)   DocColour(COLOURMODEL_CMYK, (ColourGeneric *) col)
#define	DOCCOLOUR_CIET(col)   DocColour(COLOURMODEL_CIET, (ColourGeneric *) col)
Typedefs
typedef UINT32	ColourContextHandle
Variables
const UINT32	COL_NAMED = 1
const UINT32	COL_BLACK = 2
const UINT32	COL_WHITE = 3
const UINT32	COL_OVERRIDABLE = 4

---

Define Documentation

#define DOCCOLOUR_CIET (  col   )     DocColour(COLOURMODEL_CIET, (ColourGeneric *) col)

Definition at line 350 of file doccolor.h.

#define DOCCOLOUR_CMYK (  col   )     DocColour(COLOURMODEL_CMYK, (ColourGeneric *) col)

Definition at line 349 of file doccolor.h.

#define DOCCOLOUR_HSVT (  col   )     DocColour(COLOURMODEL_HSVT, (ColourGeneric *) col)

Definition at line 348 of file doccolor.h.

#define DOCCOLOUR_RGBT (  col   )     DocColour(COLOURMODEL_RGBT, (ColourGeneric *) col)

Comment: These macros simplify construction of DocColour objects in given colour models. Use something like this: { ColourRGBT TheDefinition; DocColour TheColour = DOCCOLOURRGBT(&TheDefinition); } Notes: Note that these macros explicitly cast 'col' to a (ColourGeneric *), so if it is not a pointer to a 128-bit colour structure (ColourGeneric, ColourRGBT, ColourCIET etc) then nasty things may occur. See also: DocColour::DocColour Definition at line 347 of file doccolor.h.

---

Typedef Documentation

typedef UINT32 ColourContextHandle

Definition at line 112 of file doccolor.h.

---

Variable Documentation

const UINT32 COL_BLACK = 2

Definition at line 120 of file doccolor.h.

const UINT32 COL_NAMED = 1

Definition at line 119 of file doccolor.h.

const UINT32 COL_OVERRIDABLE = 4

Definition at line 122 of file doccolor.h.

const UINT32 COL_WHITE = 3

Definition at line 121 of file doccolor.h.

---