class BorderWidget

Defined in: C4Widgets.h

The BorderWidget class represents an interface widget that displays a rectangular border.

Definition

class LineWidget : public RenderableWidget

Member Functions

`BorderWidget::GetLineStyle`	Returns the line style used by a border widget.
`BorderWidget::SetLineStyle`	Sets the line style used by a border widget.

Constructor

BorderWidget(const Vector2D& size, long style = kLineSolid, const ColorRGBA& color = K::black);

Parameters

`size`	The size of the border, in pixels.
`style`	The line style. See below for possible values.
`color`	The initial color of the border.

Description

The BorderWidget class is used to render a rectangular border. The border is always one pixel thick, and its dimensions are determined by the size of the widget.

The style parameter determines whether the border is rendered solid, dotted, or dashed. It can be one of the following values.

`kLineSolid`	A solid line.
`kLineDotted1`	A dotted line with one-pixel-wide dots.
`kLineDotted2`	A dotted line with two-pixel-wide dots.
`kLineDashed`	A dashed line.

The default widget color corresponds to the kWidgetColorBorder color type. No other color types are supported by the border widget.

Base Classes

RenderableWidget All rendered interface widgets are subclasses of RenderableWidget. The default widget color corresponds to the kWidgetColorBorder color type. No other color types are supported by the border widget.