Imagemap Class Reference

This is a list of clickable areas. More...

#include <imagemap.h>

Inheritance diagram for Imagemap:

List of all members.

Public Member Functions
	Imagemap ()
	Default constructor.
	~Imagemap ()
	Destructor.
void	AddRectangle (DocRect rectToAdd, TCHAR *pcURL=NULL, TCHAR *pcFrame=NULL)
	Adds a rectangular clickable region to the imagemap.
void	AddCircle (Path *pthToAdd, TCHAR *pcURL=NULL, TCHAR *pcFrame=NULL)
	Adds a circular clickable region to the imagemap.
void	AddPolygon (Path *pthToAdd, TCHAR *pcURL=NULL, TCHAR *pcFrame=NULL)
	Adds a straight-sided polygon to the imagemap.
INT32	Write (CCLexFile *pfileToWrite=NULL, TCHAR *pcBuffer=NULL)
	Writes out the imagemap.

---

Detailed Description

This is a list of clickable areas.

Author:

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

Date:

15/4/97

The clickable areas can be any of the following objects:

ImagemapClickableCircle ImagemapClickableRectangle ImagemapClickablePolygon

All these classes are derived from the ImagemapClickableArea class, which is in turn derived from ListItem.

This imagemap class also has the ability to write itself out to a file, via the Write function.

Definition at line 133 of file imagemap.h.

---

Constructor & Destructor Documentation

Imagemap::Imagemap (   )

Default constructor. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Definition at line 126 of file imagemap.cpp. : OverrideList() { //Does nothing }

Imagemap::~Imagemap (   )

Destructor. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Definition at line 147 of file imagemap.cpp. { //Delete all our list items DeleteAll(); }

---

Member Function Documentation

void Imagemap::AddCircle (  Path *  pthToAdd, TCHAR *  pcURL = NULL, TCHAR *  pcFrame = NULL )

Adds a circular clickable region to the imagemap. > Imagemap::AddCircle(Path* pthToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL); Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Parameters: pthToAdd  The circular path to add to the imagemap [INPUTS] Definition at line 194 of file imagemap.cpp. { //Create a new ImagemapClickableCircle with our scaled path ImagemapClickableCircle* pCircle=new ImagemapClickableCircle(pthToAdd, pcURL, pcFrame); //And add it to the imagemap //Note that we add it to the head of the list. That's because, in imagemaps, //the first clickable area found in the file is the one nearest the front. AddHead(pCircle); }

void Imagemap::AddPolygon (  Path *  pthToAdd, TCHAR *  pcURL = NULL, TCHAR *  pcFrame = NULL )

Adds a straight-sided polygon to the imagemap. > Imagemap::AddPolygon(Path* pthToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL); Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Parameters: pthToAdd  The path to add to the imagemap [INPUTS] Definition at line 218 of file imagemap.cpp. { //Create a new ImagemapClickableCircle with the path we've been given ImagemapClickablePolygon* pPolygon=new ImagemapClickablePolygon(pthToAdd, pcURL, pcFrame); //And add it to the imagemap //Note that we add it to the head of the list. That's because, in imagemaps, //the first clickable area found in the file is the one nearest the front. AddHead(pPolygon); }

void Imagemap::AddRectangle (  DocRect  rectToAdd, TCHAR *  pcURL = NULL, TCHAR *  pcFrame = NULL )

Adds a rectangular clickable region to the imagemap. > Imagemap::AddRectangle(DocRect rectToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL); Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Parameters: rectToAdd  The rectangle to add to the imagemap [INPUTS] Definition at line 171 of file imagemap.cpp. { //Create a new ImagemapClickableRectangle with the rectangle we've been given ImagemapClickableRectangle* pRectangle=new ImagemapClickableRectangle(rectToAdd, pcURL, pcFrame); //And add it to the imagemap //Note that we add it to the head of the list. That's because, in imagemaps, //the first clickable area found in the file is the one nearest the front. AddHead(pRectangle); }

INT32 Imagemap::Write (  CCLexFile *  pfileToWrite = NULL, TCHAR *  pcBuffer = NULL )

Writes out the imagemap. > INT32 Imagemap::WriteHelper(CCLexFile* pfileToWrite=NULL, TCHAR* pcBuffer=NULL) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 16/4/97 Parameters: pfileToWrite  - The file to write to [INPUTS] pcBuffer - Pointer to a text buffer to write to Either of the above may be NULL. Returns: The number of TCHARs written. This function simply iterates through the list and calls on the members to write themselves out. SeeAlso: ImagemapRenderRegion::Write() Definition at line 258 of file imagemap.cpp. { //Set up a variable to remember how many bytes we have written INT32 lBytesWritten=0; //Now, get the first clickable area in the imagemap ImagemapClickableArea* pAreaToWrite=(ImagemapClickableArea*) GetHead(); //And while we're still looking at a valid clickable area while (pAreaToWrite!=NULL) { //Tell that area to write itself out to the imagemap. //This function will return the number of TCHARs it writes lBytesWritten+=pAreaToWrite->Write(pfileToWrite, pcBuffer); //And move on to the next clickable area pAreaToWrite=(ImagemapClickableArea*) GetNext(pAreaToWrite); } //And return the number of TCHARs we have written return lBytesWritten; }

---

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

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

---