DOM::CSS2Azimuth Class Reference

#include <css_extensions.h>

Inheritance diagram for DOM::CSS2Azimuth:

Public Member Functions
	CSS2Azimuth (const CSS2Azimuth &other)
	CSS2Azimuth (CSS2AzimuthImpl *impl)
CSS2Azimuth &	operator= (const CSS2Azimuth &other)
unsigned short	azimuthType () const
DOM::DOMString	identifier () const
bool	behind () const
void	setAngleValue (const unsigned short unitType, const float floatValue)
float	getAngleValue (const unsigned short unitType)
void	setIdentifier (const DOM::DOMString &identifier, const bool behind)
Public Member Functions inherited from DOM::CSSValue
	CSSValue (const CSSValue &other)
	CSSValue (CSSValueImpl *impl)
CSSValue &	operator= (const CSSValue &other)
DOM::DOMString	cssText () const
void	setCssText (const DOM::DOMString &)
unsigned short	cssValueType () const
bool	isCSSValueList () const
bool	isCSSPrimitiveValue () const
CSSValueImpl *	handle () const
bool	isNull () const

Additional Inherited Members
Public Types inherited from DOM::CSSValue
enum	UnitTypes {   CSS_INHERIT = 0 , CSS_PRIMITIVE_VALUE = 1 , CSS_VALUE_LIST = 2 , CSS_CUSTOM = 3 ,   CSS_INITIAL = 4 }
Protected Attributes inherited from DOM::CSSValue
CSSValueImpl *	impl

Detailed Description

The CSS2Azimuth interface represents the azimuth CSS Level 2 property.

Definition at line 41 of file css_extensions.h.

Constructor & Destructor Documentation

CSS2Azimuth() [1/3]

CSS2Azimuth::CSS2Azimuth

(

)

Definition at line 30 of file css_extensions.cpp.

CSS2Azimuth() [2/3]

CSS2Azimuth::CSS2Azimuth

(

const CSS2Azimuth &

other

)

Definition at line 34 of file css_extensions.cpp.

CSS2Azimuth() [3/3]

CSS2Azimuth::CSS2Azimuth

(

CSS2AzimuthImpl *

impl

)

Definition at line 38 of file css_extensions.cpp.

~CSS2Azimuth()

CSS2Azimuth::~CSS2Azimuth

(

)

Definition at line 48 of file css_extensions.cpp.

Member Function Documentation

azimuthType()

unsigned short CSS2Azimuth::azimuthType

(

)

const

A code defining the type of the value as defined in CSSValue .

It would be one of CSS_DEG , CSS_RAD , CSS_GRAD or CSS_IDENT .

Definition at line 52 of file css_extensions.cpp.

behind()

bool CSS2Azimuth::behind

(

)

const

behind indicates whether the behind identifier has been set.

Definition at line 64 of file css_extensions.cpp.

getAngleValue()

float CSS2Azimuth::getAngleValue

(

const unsigned short

unitType

)

Used to retrieved the float value of the azimuth property.

Parameters

unitType

The unit type can be only an angle unit type ( CSS_DEG , CSS_RAD or CSS_GRAD ).

Returns

The float value.

Exceptions

DOMException

INVALID_ACCESS_ERR: Raised if the unit type is invalid.

Definition at line 76 of file css_extensions.cpp.

identifier()

DOMString CSS2Azimuth::identifier

(

)

const

If azimuthType is CSS_IDENT , identifier contains one of left-side, far-left, left, center-left, center, center-right, right, far-right, right-side, leftwards, rightwards.

The empty string if none is set.

Definition at line 58 of file css_extensions.cpp.

operator=()

CSS2Azimuth & CSS2Azimuth::operator=

(

const CSS2Azimuth &

other

)

Definition at line 42 of file css_extensions.cpp.

setAngleValue()

void CSS2Azimuth::setAngleValue	(	const unsigned short	unitType,
		const float	floatValue
	)

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

This method will unset any previously set identifiers values.

Parameters

unitType	The unitType could only be one of CSS_DEG , CSS_RAD or CSS_GRAD ).
floatValue	The new float value of the angle.

Returns

Exceptions

DOMException

INVALID_ACCESS_ERR: Raised if the unit type is invalid.

NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

Definition at line 70 of file css_extensions.cpp.

setIdentifier()

void CSS2Azimuth::setIdentifier	(	const DOM::DOMString &	identifier,
		const bool	behind
	)

Setting the identifier for the azimuth property will unset any previously set angle value.

The value of azimuthType is set to CSS_IDENT

Parameters

identifier	The new identifier. If the identifier is "leftwards" or "rightward", the behind attribute is ignored.
behind	The new value for behind.

Returns

Exceptions

DOMException

SYNTAX_ERR: Raised if the specified identifier has a syntax error and is unparsable.

NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

Definition at line 82 of file css_extensions.cpp.

---

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

• css_extensions.h
• css_extensions.cpp