Wt::WLength Class Reference

A value class that describes a CSS length. More...

#include <Wt/WLength>

List of all members.

Public Types
enum	Unit {   FontEm, FontEx, Pixel, Inch,   Centimeter, Millimeter, Point, Pica,   Percentage }
	The unit. More...
Public Member Functions
	WLength ()
	Creates an 'auto' length.
template<std::size_t N>
	WLength (const char(&str)[N])
	Creates a length by parsing the argument as a css length string.
	WLength (const std::string &str)
	Creates a length by parsing the argument as a css length string.
	WLength (double value, Unit unit=Pixel)
	Creates a length with value and unit.
bool	isAuto () const
	Returns whether the length is 'auto'.
double	value () const
	Returns the value.
Unit	unit () const
	Returns the unit.
const std::string	cssText () const
	Returns the CSS text.
bool	operator== (const WLength &other) const
	Comparison operator.
bool	operator!= (const WLength &other) const
	Comparison operator.
double	toPixels (double fontSize=16.0) const
	Returns the (approximate) length in pixels.
Static Public Attributes
static WLength	Auto
	An 'auto' length.

---

Detailed Description

A value class that describes a CSS length.

The class combines a value with a unit. There is a special value auto which has a different meaning depending on the context.

---

Member Enumeration Documentation

enum Wt::WLength::Unit

The unit.

Enumerator:

FontEm	The relative font size.
FontEx	The height of an 'x' in the font.
Pixel	Pixel, relative to canvas resolution.
Inch	Inch.
Centimeter	Centimeter.
Millimeter	Millimeter.
Point	Point (1/72 Inch)
Pica	Pica (12 Point)
Percentage	Percentage (meaning context-sensitive)

---

Constructor & Destructor Documentation

Wt::WLength::WLength

(

)

Creates an 'auto' length.

Specifies an 'auto' length.

See also:

Auto

template<std::size_t N>

Wt::WLength::WLength

(

const char(&)

str[N]

)

Creates a length by parsing the argument as a css length string.

This supports all CSS length formats that have an API counterpart.

This is an overload for the std::string version that accepts a string literal.

Wt::WLength::WLength

(

const std::string &

str

)

Creates a length by parsing the argument as a css length string.

This supports all CSS length formats that have an API counterpart.

Wt::WLength::WLength	(	double	value,
		Unit	unit = Pixel
	)

Creates a length with value and unit.

This constructor is also used for the implicit conversion of a double to a WLength, assuming a pixel unit.

---

Member Function Documentation

bool Wt::WLength::isAuto

(

)

const

Returns whether the length is 'auto'.

See also:

WLength(), Auto

double Wt::WLength::toPixels

(

double

fontSize = 16.0

)

const

Returns the (approximate) length in pixels.

When the length isAuto(), 0 is returned, otherwise the approximate length in pixels.

Unit Wt::WLength::unit

(

)

const

Returns the unit.

See also:

value()

double Wt::WLength::value

(

)

const

Returns the value.

See also:

unit()

---

Member Data Documentation

WLength Wt::WLength::Auto [static]

An 'auto' length.

See also:

WLength()