|CSS::DOM::Value::Primitive(3pm)||User Contributed Perl Documentation||CSS::DOM::Value::Primitive(3pm)|
CSS::DOM::Value::Primitive - CSSPrimitiveValue class for CSS::DOM
This module implements objects that represent CSS primitive property values (as opposed to lists). It implements the DOM CSSPrimitiveValue, Rect, and RGBColor interfaces.
If you need the constructor, it's below the object methods. Normally you would get an object via CSS::DOM::Style's "getPropertyCSSValue" method.
- Returns one of the "CONSTANTS" listed below.
- Returns a number if the value is numeric.
The rest have still to be implemented.
The four methods "top", "right", "bottom" and "left" each return another value object representing the individual value.
The four methods "red", "green", "blue" and "alpha" each return another value object representing the individual value.
You probably don't need to call this, but here it is anyway:
$val = new CSS::DOM::Value::Primitive:: %args;
The hash-style arguments are as follows. Only "type" and "value" are required.
- One of the constants listed below under "CONSTANTS"
- The data stored inside the value object. The format expected depends on the type. See below.
- CSS code used for serialisation. This will make reading "cssText" faster at least until the value is modified.
- The style object that owns this value; if this is omitted, then the value is read-only. The value object holds a weak reference to the owner.
- The name of the CSS property to which this value belongs. "cssText" uses this to determine how to parse text passed to it. This does not apply to the sub-values of colours, counters and rects, but it does apply to individual elements of a list value.
- The index of this value within a list value (only applies to elements of a list, of course).
- This is used by sub-values of colours and rects. It determines how assignment to "cssText" is handled. This uses the same syntax as the formats in CSS::DOM::PropertyParser.
Here are the formats for the "value" argument, which depend on the type:
- A string of CSS code.
- CSS_NUMBER, CSS_PERCENTAGE
- A simple scalar containing a number.
- Standard Dimensions
- Also a simple scalar containing a number.
This applies to "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" and "CSS_KHZ".
- An array ref: "[$number, $unit_text]"
- A simple scalar containing a string (not a CSS string literal; i.e., no quotes or escapes).
- The URL (not a CSS literal)
- A string (no escapes)
- A string containing the name of the attribute.
- An array ref: "[$name, $separator,
$separator and $style may each be "undef". If $separator is "undef", the object represents a "counter(...)". Otherwise it represents "counters(...)".
- An array ref: "[$top, $right, $bottom,
The four elements are either CSSValue objects or array refs of arguments to be passed to the constructor. E.g.:
[ [type => CSS_PX, value => 20], [type => CSS_PERCENTAGE, value => 50], [type => CSS_PERCENTAGE, value => 50], [type => CSS_PX, value => 50], ]
When these array refs are converted to objects, the "format" argument is supplied automatically, so you do not need to include it here.
- A string beginning with '#', with no escapes (such as '#fff' or
'#c0ffee'), a colour name (like red) or an array ref with three to four
[$r, $g, $b] [$r, $g, $b, $alpha]
The elements are either CSSValue objects or array refs of argument lists, as with "CSS_RECT".
The following constants can be imported with "use CSS::DOM::Value::Primitive ':all'". They represent the type of primitive value.