DOM::CSSStyleDeclaration

DOM::CSSStyleDeclaration Class Reference

#include <css_value.h>

Public Member Functions

 CSSStyleDeclaration (const CSSStyleDeclaration &other)
 
 CSSStyleDeclaration (CSSStyleDeclarationImpl *impl)
 
DOM::DOMString cssText () const
 
CSSValue getPropertyCSSValue (const DOM::DOMString &propertyName) const
 
DOM::DOMString getPropertyPriority (const DOM::DOMString &propertyName) const
 
DOM::DOMString getPropertyValue (const DOM::DOMString &propertyName) const
 
CSSStyleDeclarationImpl * handle () const
 
bool isNull () const
 
DOM::DOMString item (unsigned long index) const
 
unsigned long length () const
 
CSSStyleDeclarationoperator= (const CSSStyleDeclaration &other)
 
CSSRule parentRule () const
 
DOM::DOMString removeProperty (const DOM::DOMString &propertyName)
 
void setCssText (const DOM::DOMString &)
 
void setProperty (const DOM::DOMString &propertyName, const DOM::DOMString &value, const DOM::DOMString &priority)
 

Protected Attributes

CSSStyleDeclarationImpl * impl
 

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.

Definition at line 59 of file css_value.h.

Member Function Documentation

DOMString DOM::CSSStyleDeclaration::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.

Definition at line 74 of file css_value.cpp.

CSSValue DOM::CSSStyleDeclaration::getPropertyCSSValue ( const DOM::DOMString propertyName) const

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.

Definition at line 98 of file css_value.cpp.

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

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.

Definition at line 114 of file css_value.cpp.

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

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.

Definition at line 90 of file css_value.cpp.

CSSStyleDeclarationImpl * DOM::CSSStyleDeclaration::handle ( ) const

not part of the DOM

Definition at line 157 of file css_value.cpp.

DOMString DOM::CSSStyleDeclaration::item ( unsigned long  index) const

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.

Definition at line 142 of file css_value.cpp.

unsigned long DOM::CSSStyleDeclaration::length ( ) const

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

Definition at line 134 of file css_value.cpp.

CSSRule DOM::CSSStyleDeclaration::parentRule ( ) const

The CSS rule that contains this declaration block.

Definition at line 149 of file css_value.cpp.

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

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.
Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly.

Definition at line 106 of file css_value.cpp.

void DOM::CSSStyleDeclaration::setCssText ( const DOM::DOMString value)

see cssText

Exceptions
CSSExceptionSYNTAX_ERR: Raised if the specified CSS string value has a syntax error and is unparsable.

Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly.

Definition at line 82 of file css_value.cpp.

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

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" ).
Returns
Exceptions
CSSExceptionSYNTAX_ERR: Raised if the specified value has a syntax error and is unparsable.
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly.

Definition at line 122 of file css_value.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 5 2020 22:46:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.