SugElement is really the current heart of libsugar.

Inheritance:

Public Methods

	SugElement () The class constructor
void	addAttribute (char* name, char* value) Adds an attribute and it's corresponding value to the attribute map
bool	getColorAttribute (char* attrName, SugColor& attrValue) Gets the specified attribute's value in color format.
SugTypes::ElementType	getElementType () returns the mElementType, this is later used for casting
bool	getFloatAttribute (char* attrName, float& attrValue) Gets the specified attribute's value in float format.
const char*	getId () Returns the id of this element.
bool	getIntegerAttribute (char* attrName, int& attrValue) Gets the specified attribute's value in integer format.
bool	getPointListAttribute (char* attrName, vector<SugPoint>& attrValue) Gets the specified attribute's value in point list format.
const char*	getStringAttribute (char* attrName) Gets the specified attribute's value in string format.
bool	getTransformListAttribute (vector<SugTransform>& attrValue) Gets the "transform" attribute's value in transform list format.
void	printAttributes () Debug function that prints the names and values of all attributes
void	setElementType (SugTypes::ElementType newType) sets the mElementType of this class
	~SugElement () The class destructor

Protected Fields

map<string, string>	mAttributes A map containing all the attributes of this element.
SugTypes::ElementType	mElementType This is the element type identifier, this is how we know what to cast our element as (see above)

Inherited from SugNode:

Public Methods

SugNode* appendChild(SugNode* newChild)

vector<SugNode> * getChildNodes()

SugNode* getFirstChild()

SugNode* getLastChild()

SugNode* getNextSibling()

char* getNodeName()

unsigned short getNodeType()

char* getNodeValue()

SugNode* getParentNode()

SugNode* getPreviousSibling()

bool hasAttributes()

bool hasChildNodes()

SugNode* insertBefore(SugNode* newChild, SugNode* refChild)

SugNode* removeChild(SugNode* oldChild)

SugNode* replaceChild(SugNode* newChild, SugNode* oldChild)

SugNode* setFirstChild(SugNode* newFirstChild)

SugNode* setLastChild(SugNode* newLastChild)

SugNode* setNextSibling(SugNode* newNextSibling)

char* setNodeName(char* newNodeName)

unsigned short setNodeType(unsigned short newNodeType)

char* setNodeValue(char* newNodeValue)

SugNode* setParentNode(SugNode* newParentNode)

SugNode* setPreviousSibling(SugNode* newPreviousSibling)

Protected Fields

vector<SugNode> mChildNodes

SugNode* mFirstChild

SugNode* mLastChild

SugNode* mNextSibling

char* mNodeName

unsigned short mNodeType

char* mNodeValue

SugNode* mParentNode

SugNode* mPreviousSibling

Documentation

SugElement is really the current heart of libsugar. The parser will output a vector of SugElements. These SugElements are not of type SugElement but are of one of a derived class, so you can think of SugElement as the cookie cutter parent class that they all conform to.

SugTypes::ElementType mElementType

This is the element type identifier, this is how we know what to cast our element as (see above)

map<string, string> mAttributes

A map containing all the attributes of this element. It is a string to string mapping.

const char* getStringAttribute(char* attrName)

Gets the specified attribute's value in string format.

Parameters:

attrName - The name of the attribute we are getting the value for.

Returns:

The attribute's value in string format. NULL if the attribute doesn't exist in the element.

bool getIntegerAttribute(char* attrName, int& attrValue)

Gets the specified attribute's value in integer format.

Parameters:

attrName - The name of the attribute we are getting the value for.
attrValue - The value of the attribute.

Returns:

Boolean value indicating whether or not the attribute exists in this element.

bool getFloatAttribute(char* attrName, float& attrValue)

Gets the specified attribute's value in float format.

Parameters:

attrName - The name of the attribute we are getting the value for.
attrValue - The value of the attribute.

Returns:

Boolean value indicating whether or not the attribute exists in this element.

bool getColorAttribute(char* attrName, SugColor& attrValue)

Gets the specified attribute's value in color format.

Parameters:

attrName - The name of the attribute we are getting the value for.
attrValue - The value of the attribute.

Returns:

Boolean value indicating whether or not the attribute exists in this element.

bool getPointListAttribute(char* attrName, vector<SugPoint>& attrValue)

Gets the specified attribute's value in point list format.

Parameters:

attrName - The name of the attribute we are getting the value for.
attrValue - The value of the attribute.

Returns:

Boolean value indicating whether or not the attribute exists in this element.

bool getTransformListAttribute(vector<SugTransform>& attrValue)

Gets the "transform" attribute's value in transform list format.

Parameters:

attrValue - The value of the attribute.

Returns:

Boolean value indicating whether or not the attribute exists in this element.

const char* getId()

Returns the id of this element.

Returns:

The id string if it exists, NULL otherwise.

SugTypes::ElementType getElementType()

returns the mElementType, this is later used for casting

void setElementType(SugTypes::ElementType newType)

sets the mElementType of this class

void addAttribute(char* name, char* value)

Adds an attribute and it's corresponding value to the attribute map

void printAttributes()

Debug function that prints the names and values of all attributes

SugElement()

The class constructor

~SugElement()

The class destructor

Direct child classes:

SugUseElement
SugTextElement
SugSymbolElement
SugSvgElement
SugRectElement
SugPolylineElement
SugPolygonElement
SugPathElement
SugGroupElement
SugDocument
SugDefsElement

Alphabetic index HTML hierarchy of classes or Java