ExportedColours Class Reference

Encapsulate the process of maintaining an list of colours already exported from the current document out to file. More...

#include <expcol.h>

Inheritance diagram for ExportedColours:

List of all members.

Public Member Functions
	ExportedColours ()
	Construct the class which encapsulates a list of exported colours.
	~ExportedColours ()
	Destroy the class which encapsulates a list of exported colours.
BOOL	AddColour (IndexedColour *pNewCol, INT32 RecordNumber)
	Add the specified colour to the list of already exported colours.
BOOL	AddColour (PColourRGBT *pNewRGBCol, INT32 RecordNumber)
	Add the specified colour to the list of already exported colours.
ExportColour *	GetColour (IndexedColour *pSearchCol)
	Find an indexed colour in the exported list.
ExportColour *	GetColour (PColourRGBT *pNewRGBCol)
	Find a simpple RGB colour in the exported list.
Protected Attributes
ExportColourList	Colours

---

Detailed Description

Encapsulate the process of maintaining an list of colours already exported from the current document out to file.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

23/5/96

See also:

NewExportColour; ExportColourList

Definition at line 184 of file expcol.h.

---

Constructor & Destructor Documentation

ExportedColours::ExportedColours (   )

Construct the class which encapsulates a list of exported colours. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: ExportedColours Definition at line 265 of file expcol.cpp. { }

ExportedColours::~ExportedColours (   )

Destroy the class which encapsulates a list of exported colours. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: ExportedColours Definition at line 283 of file expcol.cpp. { }

---

Member Function Documentation

BOOL ExportedColours::AddColour (  PColourRGBT *  pNewRGBCol, INT32  RecordNumber )

Add the specified colour to the list of already exported colours. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 3/6/96 Parameters: pNewRGBCol  - the simple RGB colour to put in the list. [INPUTS] RecordNumber - the number of the record that this colour definition has been saved in. Returns: TRUE if the colour could be added; FALSE if not Errors: - See also: ExportColourList; Definition at line 331 of file expcol.cpp. { // Add the colour onto our list ExportColour * pExpCol = Colours.AddColour(pNewRGBCol, RecordNumber); if (pExpCol) return TRUE; return FALSE; }

BOOL ExportedColours::AddColour (  IndexedColour *  pNewCol, INT32  RecordNumber )

Add the specified colour to the list of already exported colours. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 Parameters: pNewCol  - the colour to put in the list. [INPUTS] RecordNumber - the number of the record that this colour definition has been saved in. Returns: TRUE if the colour could be added; FALSE if not Errors: - See also: ExportColourList; Definition at line 304 of file expcol.cpp. { // Add the colour onto our list ExportColour * pExpCol = Colours.AddColour(pNewCol, RecordNumber); if (pExpCol) return TRUE; return FALSE; }

ExportColour * ExportedColours::GetColour (  PColourRGBT *  pSearchRGBCol  )

Find a simpple RGB colour in the exported list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 3/6/96 Parameters: pSearchRGBCol  - the simple RGB colour to search for in the list. [INPUTS] Returns: if the item is found then returns - Pointer to the exported colour list item if the item is not found then returns - NULL. See also: ExportColourList Definition at line 391 of file expcol.cpp. { if (pSearchRGBCol == NULL) { ERROR3("ExportedColours::GetColour (Simple )- searching for a null indexed colour!"); } ExportColour* pExportedColour = (ExportColour *)Colours.GetHead(); while (pExportedColour) { // Only check if this is a simple colour if (pExportedColour->pCol == NULL) { // Compare the simple RGB colours and return the match if they are the same if ( pExportedColour->SimpleRGBColour.Red == pSearchRGBCol->Red && pExportedColour->SimpleRGBColour.Green == pSearchRGBCol->Green && pExportedColour->SimpleRGBColour.Blue == pSearchRGBCol->Blue && pExportedColour->SimpleRGBColour.Transparent == pSearchRGBCol->Transparent ) return pExportedColour; } // Try the next colour in the list pExportedColour = (ExportColour *)Colours.GetNext(pExportedColour); } // No - return failure. return NULL; }

ExportColour * ExportedColours::GetColour (  IndexedColour *  pSearchCol  )

Find an indexed colour in the exported list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 Parameters: pSearchCol  - the colour to search for in the list. [INPUTS] Returns: if the item is found then returns - Pointer to the exported colour list item if the item is not found then returns - NULL. See also: ExportColourList Definition at line 355 of file expcol.cpp. { if (pSearchCol == NULL) { ERROR3("ExportedColours::GetColour - searching for a null indexed colour!"); } ExportColour* pExportedColour = (ExportColour *)Colours.GetHead(); while (pExportedColour) { // Compare the indexed colour pointers and return the match if they are the same if (pExportedColour->pCol == pSearchCol) return pExportedColour; // Try the next colour in the list pExportedColour = (ExportColour *)Colours.GetNext(pExportedColour); } // No - return failure. return NULL; }

---

Member Data Documentation

ExportColourList ExportedColours::Colours [protected]

Definition at line 206 of file expcol.h.

---

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

• Kernel/expcol.h (r1785/r1282)
• Kernel/expcol.cpp (r1785/r1282)

---