.TH "DOM::CSS2BackgroundPosition" 3 "28 Jan 2004" "khtml Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DOM::CSS2BackgroundPosition \- The \fC \fBCSS2BackgroundPosition\fP \fP interface represents the \fCbackground-position \fP CSS Level 2 property.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <css_extensions.h>\fP
.PP
Inherits \fBDOM::CSSValue\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCSS2BackgroundPosition\fP (const  \fBCSS2BackgroundPosition\fP &other)"
.br
.ti -1c
.RI "\fBCSS2BackgroundPosition\fP (CSS2BackgroundPositionImpl *impl)"
.br
.ti -1c
.RI "\fBCSS2BackgroundPosition\fP & \fBoperator=\fP (const  \fBCSS2BackgroundPosition\fP &other)"
.br
.ti -1c
.RI "unsigned short \fBhorizontalType\fP () const "
.br
.RI "\fIA code defining the type of the horizontal value. \fP"
.ti -1c
.RI "unsigned short \fBverticalType\fP () const "
.br
.RI "\fIA code defining the type of the horizontal value. \fP"
.ti -1c
.RI "\fBDOM::DOMString\fP \fBhorizontalIdentifier\fP () const "
.br
.RI "\fIIf \fC horizontalType \fP is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , this attribute contains the string representation of the ident, otherwise it contains an empty string. \fP"
.ti -1c
.RI "\fBDOM::DOMString\fP \fBverticalIdentifier\fP () const "
.br
.RI "\fIIf \fC verticalType \fP is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , this attribute contains the string representation of the ident, otherwise it contains an empty string. \fP"
.ti -1c
.RI "float \fBgetHorizontalPosition\fP (const  float horizontalType)"
.br
.RI "\fIThis method is used to get the float value in a specified unit if the \fC horizontalPosition \fP represents a length or a percentage. \fP"
.ti -1c
.RI "float \fBgetVerticalPosition\fP (const  float verticalType)"
.br
.RI "\fIThis method is used to get the float value in a specified unit if the \fC verticalPosition \fP represents a length or a percentage. \fP"
.ti -1c
.RI "void \fBsetHorizontalPosition\fP (const  unsigned short horizontalType, const  float value)"
.br
.RI "\fIThis method is used to set the horizontal position with a specified unit. \fP"
.ti -1c
.RI "void \fBsetVerticalPosition\fP (const  unsigned short verticalType, const  float value)"
.br
.RI "\fIThis method is used to set the vertical position with a specified unit. \fP"
.ti -1c
.RI "void \fBsetPositionIdentifier\fP (const  \fBDOM::DOMString\fP &horizontalIdentifier, const  \fBDOM::DOMString\fP &verticalIdentifier)"
.br
.RI "\fISets the identifiers. \fP"
.in -1c
.SH "Detailed Description"
.PP 
The \fC \fBCSS2BackgroundPosition\fP \fP interface represents the \fCbackground-position \fP CSS Level 2 property. Definition at line 147 of file css_extensions.h.
.SH "Member Function Documentation"
.PP 
.SS "unsigned short CSS2BackgroundPosition::horizontalType () const"
.PP
A code defining the type of the horizontal value. It would be one \fC CSS_PERCENTAGE \fP , \fC CSS_EMS \fP , \fC CSS_EXS \fP , \fC CSS_PX \fP , \fC CSS_CM \fP , \fC CSS_MM \fP , \fC CSS_IN \fP , \fC CSS_PT \fP , \fC CSS_PC \fP , \fC CSS_IDENT \fP , \fC CSS_INHERIT \fP . If one of horizontal or vertical is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , it's guaranteed that the other is the same. Definition at line 113 of file css_extensions.cpp.
.SS "unsigned short CSS2BackgroundPosition::verticalType () const"
.PP
A code defining the type of the horizontal value. The code can be one of the following units : \fC CSS_PERCENTAGE \fP , \fC CSS_EMS \fP , \fC CSS_EXS \fP , \fC CSS_PX \fP , \fC CSS_CM \fP , \fC CSS_MM \fP , \fC CSS_IN \fP , \fC CSS_PT \fP , \fC CSS_PC \fP , \fC CSS_IDENT \fP , \fC CSS_INHERIT \fP . If one of horizontal or vertical is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , it's guaranteed that the other is the same. Definition at line 119 of file css_extensions.cpp.
.SS "\fBDOMString\fP CSS2BackgroundPosition::horizontalIdentifier () const"
.PP
If \fC horizontalType \fP is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , this attribute contains the string representation of the ident, otherwise it contains an empty string. Definition at line 125 of file css_extensions.cpp.
.SS "\fBDOMString\fP CSS2BackgroundPosition::verticalIdentifier () const"
.PP
If \fC verticalType \fP is \fC CSS_IDENT \fP or \fC CSS_INHERIT \fP , this attribute contains the string representation of the ident, otherwise it contains an empty string. The value is \fC 'center' \fP if only the horizontalIdentifier has been set. The value is \fC 'inherit' \fP if the horizontalIdentifier is \fC 'inherit' \fP . Definition at line 131 of file css_extensions.cpp.
.SS "float CSS2BackgroundPosition::getHorizontalPosition (const float horizontalType)"
.PP
This method is used to get the float value in a specified unit if the \fC horizontalPosition \fP represents a length or a percentage. If the float doesn't contain a float value or can't be converted into the specified unit, a \fC \fBDOMException\fP \fP is raised.
.PP
\fBParameters:\fP
.RS 4
\fIhorizontalType\fP The specified unit.
.RE
.PP
\fBReturns:\fP
.RS 4
The float value.
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted. 
.RE
.PP
Definition at line 137 of file css_extensions.cpp.
.SS "float CSS2BackgroundPosition::getVerticalPosition (const float verticalType)"
.PP
This method is used to get the float value in a specified unit if the \fC verticalPosition \fP represents a length or a percentage. If the float doesn't contain a float value or can't be converted into the specified unit, a \fC \fBDOMException\fP \fP is raised. The value is \fC 50% \fP if only the horizontal value has been specified.
.PP
\fBParameters:\fP
.RS 4
\fIverticalType\fP The specified unit.
.RE
.PP
\fBReturns:\fP
.RS 4
The float value.
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INVALID_ACCESS_ERR: Raises if the property doesn't contain a float or the value can't be converted. 
.RE
.PP
Definition at line 143 of file css_extensions.cpp.
.SS "void CSS2BackgroundPosition::setHorizontalPosition (const unsigned short horizontalType, const float value)"
.PP
This method is used to set the horizontal position with a specified unit. If the vertical value is not a percentage or a length, it sets the vertical position to \fC 50% \fP .
.PP
\fBParameters:\fP
.RS 4
\fIhorizontalType\fP The specified unit (a length or a percentage).
.br
\fIvalue\fP The new value.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INVALID_ACCESS_ERR: Raises if the specified unit is not a length or a percentage.
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly. Definition at line 149 of file css_extensions.cpp.
.SS "void CSS2BackgroundPosition::setVerticalPosition (const unsigned short verticalType, const float value)"
.PP
This method is used to set the vertical position with a specified unit. If the horizontal value is not a percentage or a length, it sets the vertical position to \fC 50% \fP .
.PP
\fBParameters:\fP
.RS 4
\fIverticalType\fP The specified unit (a length or a percentage).
.br
\fIvalue\fP The new value.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INVALID_ACCESS_ERR: Raises if the specified unit is not a length or a percentage.
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly. Definition at line 155 of file css_extensions.cpp.
.SS "void CSS2BackgroundPosition::setPositionIdentifier (const \fBDOM::DOMString\fP & horizontalIdentifier, const \fBDOM::DOMString\fP & verticalIdentifier)"
.PP
Sets the identifiers. If the second identifier is the empty string, the vertical identifier is set to his default value ( \fC 'center' \fP ). If the first identfier is \fC 'inherit \fP , the second identifier is ignored and is set to \fC 'inherit' \fP .
.PP
\fBParameters:\fP
.RS 4
\fIhorizontalIdentifier\fP The new horizontal identifier.
.br
\fIverticalIdentifier\fP The new vertical identifier.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP SYNTAX_ERR: Raises if the identifiers have a syntax error and is unparsable.
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raises if this property is readonly. Definition at line 161 of file css_extensions.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for khtml Library from the source code.
