Wt::WBorder Class Reference
[Style classes]

A style class for the border of a widget. More...

#include <Wt/WBorder>

List of all members.

Public Types

enum  Width { Thin, Medium, Thick, Explicit }
 Enumeration for border width. More...
enum  Style {
  None, Hidden, Dotted, Dashed,
  Solid, Double, Groove, Ridge,
  Inset, Outset
}
 Enumeration for border style. More...

Public Member Functions

 WBorder ()
 Create a border indicating no border.
 WBorder (Style style, Width=Medium, WColor color=WColor())
 Create a border with given style, thickness and color.
 WBorder (Style style, const WLength &width, WColor color=WColor())
 Create a border with an absolute width.
bool operator== (const WBorder &other) const
 Comparison operator.
bool operator!= (const WBorder &other) const
 Comparison operator.
void setWidth (Width width, const WLength &explicitWidth=WLength::Auto)
 Set the border width.
void setColor (WColor color)
 Set the border color.
void setStyle (Style style)
 Set the border style.
Width width () const
 Returns the border width.
WLength explicitWidth () const
 Returns the border width when set explicitly.
WColor color () const
 Returns the border color.
Style style () const
 Returns the border style.
std::string cssText () const
 Returns the CSS text for this border style.


Detailed Description

A style class for the border of a widget.

Member Enumeration Documentation

Enumeration for border width.

Enumerator:
Thin  Browser-dependent 'thin' border.
Medium  Browser-dependent 'medium' border, default.
Thick  Browser-dependent 'thin' border.
Explicit  Explicit width. See also explicitWidth().

Enumeration for border style.

Enumerator:
None  No border (width ignored), default.
Hidden  Invisible border (of specified width).
Dotted  Dotted border.
Dashed  Dashed border.
Solid  Solid border.
Double  Double lined border.
Groove  Relief border grooved into the canvas.
Ridge  Relief border coming out of the canvas.
Inset  Relief border lowering contents into the canvas.
Outset  Relief border letting contents come out of the canvas.


Member Function Documentation

void Wt::WBorder::setWidth ( Width  width,
const WLength explicitWidth = WLength::Auto 
)

Set the border width.

If width == Explicit, then the width specified in explicitWidth is used.

Width Wt::WBorder::width (  )  const [inline]

Returns the border width.

See also:
setWidth()

WLength Wt::WBorder::explicitWidth (  )  const [inline]

Returns the border width when set explicitly.

See also:
setWidth()

WColor Wt::WBorder::color (  )  const [inline]

Returns the border color.

See also:
setColor()

Style Wt::WBorder::style (  )  const [inline]

Returns the border style.

See also:
setStyle()


Generated on Tue Sep 1 17:51:15 2009 for Wt by doxygen 1.5.6