DOM::CSS2PageSize

DOM::CSS2PageSize Class Reference

#include <css_extensions.h>

Inheritance diagram for DOM::CSS2PageSize:

Public Member Functions

 CSS2PageSize (const CSS2PageSize &other)
 
 CSS2PageSize (CSS2PageSizeImpl *impl)
 
float getHeightSize (const float heightType)
 
float getWidth (const float widthType)
 
unsigned short heightType () const
 
DOM::DOMString identifier () const
 
CSS2PageSizeoperator= (const CSS2PageSize &other)
 
void setHeightSize (const unsigned short heightType, const float value)
 
void setIdentifier (const DOM::DOMString &identifier)
 
void setWidthSize (const unsigned short widthType, const float value)
 
unsigned short widthType () const
 
- Public Member Functions inherited from DOM::CSSValue
 CSSValue (const CSSValue &other)
 
 CSSValue (CSSValueImpl *impl)
 
DOM::DOMString cssText () const
 
unsigned short cssValueType () const
 
CSSValueImpl * handle () const
 
bool isCSSPrimitiveValue () const
 
bool isCSSValueList () const
 
bool isNull () const
 
CSSValueoperator= (const CSSValue &other)
 
void setCssText (const DOM::DOMString &)
 

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, CSS_SVG_VALUE = 1001
}
 
- Protected Attributes inherited from DOM::CSSValue
CSSValueImpl * impl
 

Detailed Description

The CSS2Cursor interface represents the size CSS Level 2 descriptor.

Definition at line 732 of file css_extensions.h.

Member Function Documentation

float CSS2PageSize::getHeightSize ( const float  heightType)

This method is used to get the float value in a specified unit if the heightType represents a length.

If the float doesn't contain a float value or can't be converted into the specified unit, a DOMException is raised. If only the width value has been specified, the height value is the same.

Parameters
heightTypeThe specified unit.
Returns
The float value.
Exceptions
DOMExceptionINVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted.

Definition at line 589 of file css_extensions.cpp.

float CSS2PageSize::getWidth ( const float  widthType)

This method is used to get the float value in a specified unit if the widthType represents a length.

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

Parameters
widthTypeThe specified unit.
Returns
The float value.
Exceptions
DOMExceptionINVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted.

Definition at line 581 of file css_extensions.cpp.

unsigned short CSS2PageSize::heightType ( ) const

A code defining the type of the height of the page.

It would be one of CSS_EMS , CSS_EXS , CSS_PX , CSS_CM , CSS_MM , CSS_IN , CSS_PT , CSS_PC , CSS_IDENT , CSS_INHERIT . If one of width or height is CSS_IDENT or CSS_INHERIT , it's guaranteed that the other is the same.

Definition at line 565 of file css_extensions.cpp.

DOMString CSS2PageSize::identifier ( ) const

If width is CSS_IDENT or CSS_INHERIT , this attribute contains the string representation of the ident, otherwise it contains an empty string.

Definition at line 573 of file css_extensions.cpp.

void CSS2PageSize::setHeightSize ( const unsigned short  heightType,
const float  value 
)

This method is used to set the height position with a specified unit.

If the widthType is not a length, it sets the width position to the same value.

Parameters
heightTypeThe specified unit.
valueThe new value.
Returns
Exceptions
DOMExceptionINVALID_ACCESS_ERR: Raises if the specified unit is not a length or a percentage.

NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly.

Definition at line 604 of file css_extensions.cpp.

void CSS2PageSize::setIdentifier ( const DOM::DOMString identifier)

Sets the identifier.

Parameters
identifierThe new identifier.
Returns
Exceptions
DOMExceptionSYNTAX_ERR: Raises if the identifier has a syntax error and is unparsable.

NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly.

Definition at line 611 of file css_extensions.cpp.

void CSS2PageSize::setWidthSize ( const unsigned short  widthType,
const float  value 
)

This method is used to set the width position with a specified unit.

If the heightType is not a length, it sets the height position to the same value.

Parameters
widthTypeThe specified unit.
valueThe new value.
Returns
Exceptions
DOMExceptionINVALID_ACCESS_ERR: Raises if the specified unit is not a length or a percentage.

NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly.

Definition at line 597 of file css_extensions.cpp.

unsigned short CSS2PageSize::widthType ( ) const

A code defining the type of the width of the page.

It would be one of CSS_EMS , CSS_EXS , CSS_PX , CSS_CM , CSS_MM , CSS_IN , CSS_PT , CSS_PC , CSS_IDENT , CSS_INHERIT . If one of width or height is CSS_IDENT or CSS_INHERIT , it's guaranteed that the other is the same.

Definition at line 557 of file css_extensions.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 Tue Jun 2 2020 22:35:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.