class CSSStyleDeclaration

The CSSStyleDeclaration interface represents a single More...

Full nameDOM::CSSStyleDeclaration
Definition#include <css_value.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Members


Detailed Description

The CSSStyleDeclaration interface represents a single CSS declaration block . This interface may be used to determine the style properties currently set in a block or to set style properties explicitly within the block.

While an implementation may not recognize all CSS properties within a CSS declaration block, it is expected to provide access to all specified properties through the CSSStyleDeclaration interface. Furthermore, implementations that support a specific level of CSS should correctly handle CSS shorthand properties for that level. For a further discussion of shorthand properties, see the CSS2Properties interface.

 CSSStyleDeclaration ()

CSSStyleDeclaration

 CSSStyleDeclaration (const CSSStyleDeclaration &other)

CSSStyleDeclaration

 CSSStyleDeclaration (CSSStyleDeclarationImpl *impl)

CSSStyleDeclaration

CSSStyleDeclaration &  operator = (const CSSStyleDeclaration &other)

operator =

 ~CSSStyleDeclaration ()

~CSSStyleDeclaration

DOM::DOMString  cssText ()

cssText

[const]

The parsable textual representation of the declaration block (including the surrounding curly braces). Setting this attribute will result in the parsing of the new value and resetting of the properties in the declaration block.

void  setCssText ( const DOM::DOMString & )

setCssText

see cssText

Throws: CSSException, SYNTAX_ERR:, Raised, if, the, specified, CSS, string, value, has, a, syntax, error, and, is, unparsable., DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, this, declaration, is, readonly.

unsigned long  length ()

length

[const]

The number of properties that have been explicitly set in this declaration block.

CSSRule  parentRule ()

parentRule

[const]

The CSS rule that contains this declaration block.

DOM::DOMString  getPropertyValue ( const DOM::DOMString &propertyName )

getPropertyValue

Used to retrieve the value of a CSS property if it has been explicitly set within this declaration block.

Parameters:
propertyNameThe name of the CSS property. See the CSS property index .

Returns: Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set.

CSSValue  getPropertyCSSValue ( const DOM::DOMString &propertyName )

getPropertyCSSValue

Used to retrieve the object representation of the value of a CSS property if it has been explicitly set within this declaration block. This method returns null if the property is a shorthand property. Shorthand property values can only be accessed and modified as strings, using the getPropertyValue and setProperty methods.

Parameters:
propertyNameThe name of the CSS property. See the CSS property index .

Returns: Returns the value of the property if it has been explicitly set for this declaration block. Returns the null if the property has not been set.

DOM::DOMString  removeProperty ( const DOM::DOMString &propertyName )

removeProperty

Used to remove a CSS property if it has been explicitly set within this declaration block.

Parameters:
propertyNameThe name of the CSS property. See the CSS property index .

Returns: Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set or the property name does not correspond to a valid CSS2 property.

Throws: DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, this, declaration, is, readonly.

DOM::DOMString  getPropertyPriority ( const DOM::DOMString &propertyName )

getPropertyPriority

Used to retrieve the priority of a CSS property (e.g. the "important" qualifier) if the property has been explicitly set in this declaration block.

Parameters:
propertyNameThe name of the CSS property. See the CSS property index .

Returns: A string representing the priority (e.g. "important" ) if one exists. The empty string if none exists.

void  setProperty ( const DOM::DOMString &propertyName, const DOM::DOMString &value, const DOM::DOMString &priority )

setProperty

Used to set a property value and priority within this declaration block.

Parameters:
propertyNameThe name of the CSS property. See the CSS property index .
valueThe new value of the property.
priorityThe new priority of the property (e.g. "important" ).

Throws: CSSException, SYNTAX_ERR:, Raised, if, the, specified, value, has, a, syntax, error, and, is, unparsable., DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, this, declaration, is, readonly.

DOM::DOMString  item ( unsigned long index )

item

Used to retrieve the properties that have been explicitly set in this declaration block. The order of the properties retrieved using this method does not have to be the order in which they were set. This method can be used to iterate over all properties in this declaration block.

Parameters:
indexIndex of the property name to retrieve.

Returns: The name of the property at this ordinal position. The empty string if no property exists at this position.

CSSStyleDeclarationImpl * handle ()

handle

[const]

not part of the DOM

bool  isNull ()

isNull

[const]

CSSStyleDeclarationImpl * impl

impl

[protected]


Generated by: dfaure on kde.faure.org on Thu Jan 17 22:18:15 2002, using kdoc 2.0a53.