DOM::CSSPrimitiveValue Class Reference

The CSSPrimitiveValue interface represents a single CSS value . More...

#include <css_value.h>

Inheritance diagram for DOM::CSSPrimitiveValue:

[legend]

List of all members.

Public Types
enum	UnitTypes {   CSS_UNKNOWN = 0, CSS_NUMBER = 1, CSS_PERCENTAGE = 2, CSS_EMS = 3,   CSS_EXS = 4, CSS_PX = 5, CSS_CM = 6, CSS_MM = 7,   CSS_IN = 8, CSS_PT = 9, CSS_PC = 10, CSS_DEG = 11,   CSS_RAD = 12, CSS_GRAD = 13, CSS_MS = 14, CSS_S = 15,   CSS_HZ = 16, CSS_KHZ = 17, CSS_DIMENSION = 18, CSS_STRING = 19,   CSS_URI = 20, CSS_IDENT = 21, CSS_ATTR = 22, CSS_COUNTER = 23,   CSS_RECT = 24, CSS_RGBCOLOR = 25, CSS_PAIR = 100, CSS_HTML_RELATIVE = 255 }
Public Member Functions
	CSSPrimitiveValue (CSSPrimitiveValueImpl *impl)
	CSSPrimitiveValue (const CSSValue &other)
	CSSPrimitiveValue (const CSSPrimitiveValue &other)
	CSSPrimitiveValue ()
Counter	getCounterValue ()
float	getFloatValue (unsigned short unitType)
Rect	getRectValue ()
RGBColor	getRGBColorValue ()
DOM::DOMString	getStringValue ()
CSSPrimitiveValue &	operator= (const CSSValue &other)
CSSPrimitiveValue &	operator= (const CSSPrimitiveValue &other)
unsigned short	primitiveType () const
void	setFloatValue (unsigned short unitType, float floatValue)
void	setStringValue (unsigned short stringType, const DOM::DOMString &stringValue)
	~CSSPrimitiveValue ()

---

Detailed Description

The CSSPrimitiveValue interface represents a single CSS value .

This interface may be used to determine the value of a specific style property currently set in a block or to set a specific style properties explicitly within the block. An instance of this interface can be obtained from the getPropertyCSSValue method of the CSSStyleDeclaration interface.

Definition at line 373 of file css_value.h.

---

Member Enumeration Documentation

enum DOM::CSSPrimitiveValue::UnitTypes

An integer indicating which type of unit applies to the value.

Enumerator:

CSS_UNKNOWN
CSS_NUMBER
CSS_PERCENTAGE
CSS_EMS
CSS_EXS
CSS_PX
CSS_CM
CSS_MM
CSS_IN
CSS_PT
CSS_PC
CSS_DEG
CSS_RAD
CSS_GRAD
CSS_MS
CSS_S
CSS_HZ
CSS_KHZ
CSS_DIMENSION
CSS_STRING
CSS_URI
CSS_IDENT
CSS_ATTR
CSS_COUNTER
CSS_RECT
CSS_RGBCOLOR
CSS_PAIR
CSS_HTML_RELATIVE

Reimplemented from DOM::CSSValue.

Definition at line 390 of file css_value.h.

---

Constructor & Destructor Documentation

DOM::CSSPrimitiveValue::CSSPrimitiveValue

(

)

Definition at line 304 of file css_value.cpp.

DOM::CSSPrimitiveValue::CSSPrimitiveValue

(

const CSSPrimitiveValue &

other

)

Definition at line 308 of file css_value.cpp.

DOM::CSSPrimitiveValue::CSSPrimitiveValue

(

const CSSValue &

other

)

Definition at line 312 of file css_value.cpp.

DOM::CSSPrimitiveValue::CSSPrimitiveValue

(

CSSPrimitiveValueImpl *

impl

)

Definition at line 318 of file css_value.cpp.

DOM::CSSPrimitiveValue::~CSSPrimitiveValue

(

)

Definition at line 347 of file css_value.cpp.

---

Member Function Documentation

Counter DOM::CSSPrimitiveValue::getCounterValue

(

)

This method is used to get the Counter value.

If this CSS value doesn't contain a counter value, a DOMException is raised. Modification to the corresponding style property can be achieved using the Counter interface.

Returns:

The Counter value.

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the CSS value doesn't contain a Counter value.

Definition at line 395 of file css_value.cpp.

float DOM::CSSPrimitiveValue::getFloatValue

(

unsigned short

unitType

)

This method is used to get a float value in a specified unit.

If this CSS value doesn't contain a float value or can't be converted into the specified unit, a DOMException is raised.

Parameters:

unitType

A unit code to get the float value. The unit code can only be a float unit type (e.g. CSS_NUMBER , CSS_PERCENTAGE , CSS_EMS , CSS_EXS , CSS_PX , CSS_PX , CSS_CM , CSS_MM , CSS_IN , CSS_PT , CSS_PC , CSS_DEG , CSS_RAD , CSS_GRAD , CSS_MS , CSS_S , CSS_HZ , CSS_KHZ , CSS_DIMENSION ).

Returns:

The float value in the specified unit.

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the CSS value doesn't contain a float value or if the float value can't be converted into the specified unit.

Definition at line 368 of file css_value.cpp.

Rect DOM::CSSPrimitiveValue::getRectValue

(

)

This method is used to get the Rect value.

If this CSS value doesn't contain a rect value, a DOMException is raised. Modification to the corresponding style property can be achieved using the Rect interface.

Returns:

The Rect value.

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the CSS value doesn't contain a Rect value.

Definition at line 401 of file css_value.cpp.

RGBColor DOM::CSSPrimitiveValue::getRGBColorValue

(

)

This method is used to get the RGB color.

If this CSS value doesn't contain a RGB color value, a DOMException is raised. Modification to the corresponding style property can be achieved using the RGBColor interface.

Returns:

the RGB color value.

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the attached property can't return a RGB color value.

Definition at line 407 of file css_value.cpp.

DOMString DOM::CSSPrimitiveValue::getStringValue

(

)

This method is used to get the string value in a specified unit.

If the CSS value doesn't contain a string value, a DOMException is raised.

Returns:

The string value in the current unit. The current valueType can only be a string unit type (e.g. CSS_URI , CSS_IDENT and CSS_ATTR ).

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the CSS value doesn't contain a string value.

Definition at line 389 of file css_value.cpp.

CSSPrimitiveValue & DOM::CSSPrimitiveValue::operator=

(

const CSSValue &

other

)

Reimplemented from DOM::CSSValue.

Definition at line 332 of file css_value.cpp.

CSSPrimitiveValue & DOM::CSSPrimitiveValue::operator=

(

const CSSPrimitiveValue &

other

)

Definition at line 322 of file css_value.cpp.

unsigned short DOM::CSSPrimitiveValue::primitiveType

(

)

const

The type of the value as defined by the constants specified above.

Definition at line 351 of file css_value.cpp.

void DOM::CSSPrimitiveValue::setFloatValue	(	unsigned short	unitType,
		float	floatValue
	)

A method to set the float value with a specified unit.

If the property attached with this value can not accept the specified unit or the float value, the value will be unchanged and a DOMException will be raised.

Parameters:

	unitType	A unit code as defined above. The unit code can only be a float unit type (e.g. NUMBER , PERCENTAGE , CSS_EMS , CSS_EXS , CSS_PX , CSS_PX , CSS_CM , CSS_MM , CSS_IN , CSS_PT , CSS_PC , CSS_DEG , CSS_RAD , CSS_GRAD , CSS_MS , CSS_S , CSS_HZ , CSS_KHZ , CSS_DIMENSION ).
	floatValue	The new float value.

Returns:

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the attached property doesn't support the float value or the unit type.

NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

Definition at line 357 of file css_value.cpp.

void DOM::CSSPrimitiveValue::setStringValue	(	unsigned short	stringType,
		const DOM::DOMString &	stringValue
	)

A method to set the string value with a specified unit.

If the property attached to this value can't accept the specified unit or the string value, the value will be unchanged and a DOMException will be raised.

Parameters:

	stringType	A string code as defined above. The string code can only be a string unit type (e.g. CSS_URI , CSS_IDENT , CSS_INHERIT and CSS_ATTR ).
	stringValue	The new string value. If the stringType is equal to CSS_INHERIT , the stringValue should be inherit .

Returns:

Exceptions:

DOMException

INVALID_ACCESS_ERR: Raises if the CSS value doesn't contain a string value or if the string value can't be converted into the specified unit.

NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

Definition at line 377 of file css_value.cpp.

---

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

• css_value.h
• css_value.cpp