khtml Library API Documentation

DOM::CSS2PageSize Class Reference

The CSS2Cursor interface represents the size CSS Level 2 descriptor. More...

#include <css_extensions.h>

Inheritance diagram for DOM::CSS2PageSize:

Inheritance graph
[legend]
Collaboration diagram for DOM::CSS2PageSize:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CSS2PageSize (const CSS2PageSize &other)
 CSS2PageSize (CSS2PageSizeImpl *impl)
CSS2PageSizeoperator= (const CSS2PageSize &other)
unsigned short widthType () const
 A code defining the type of the width of the page.

unsigned short heightType () const
 A code defining the type of the height of the page.

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

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

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

void setWidthSize (const unsigned short widthType, const float value)
 This method is used to set the width position with a specified unit.

void setHeightSize (const unsigned short heightType, const float value)
 This method is used to set the height position with a specified unit.

void setIdentifier (const DOM::DOMString &identifier)
 Sets the identifier.


Detailed Description

The CSS2Cursor interface represents the size CSS Level 2 descriptor.

Definition at line 741 of file css_extensions.h.


Member Function Documentation

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 503 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 509 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 515 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:
widthType The specified unit.
Returns:
The float value.
Exceptions:
DOMException INVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted.

Definition at line 521 of file css_extensions.cpp.

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:
heightType The specified unit.
Returns:
The float value.
Exceptions:
DOMException INVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted.

Definition at line 527 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:
widthType The specified unit.
value The new value.
Returns:
Exceptions:
DOMException INVALID_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 533 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:
heightType The specified unit.
value The new value.
Returns:
Exceptions:
DOMException INVALID_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 539 of file css_extensions.cpp.

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

Sets the identifier.

Parameters:
identifier The new identifier.
Returns:
Exceptions:
DOMException SYNTAX_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 545 of file css_extensions.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:35:24 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001