Wt::WLength Class Reference

A class that specifies 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.
 WLength (double value, Unit unit=Pixel)
 Creates a length with value and unit.
bool isAuto () const
 Returns whether the ength 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 () const
 Returns the (approximate) length in pixels.

Static Public Attributes

static WLength Auto
 An 'auto' length.


Detailed Description

A class that specifies 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

The unit.

Enumerator:
FontEm  The relative font size.
FontEx  The height of an 'x' in the font.
Pixel  Pixel, relative to canvas resolution.
Inch  Inche.
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

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

Creates a length with value and unit.

This constructor will also provide the implicit conversion between a double and WLength, using a pixel unit.


Member Function Documentation

bool Wt::WLength::isAuto (  )  const [inline]

Returns whether the ength is 'auto'.

See also:
WLength(), Auto

double Wt::WLength::value (  )  const [inline]

Returns the value.

See also:
unit()

Unit Wt::WLength::unit (  )  const [inline]

Returns the unit.

See also:
value()

double Wt::WLength::toPixels (  )  const

Returns the (approximate) length in pixels.

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


Member Data Documentation

An 'auto' length.

See also:
WLength()


Generated on Fri Mar 26 17:12:07 2010 for Wt by doxygen 1.5.6