The Battle for Wesnoth  1.17.6+dev
Public Member Functions | Private Attributes | List of all members
gui2::rectangle_shape Class Reference

Definition of a rectangle. More...

#include <canvas_private.hpp>

Inheritance diagram for gui2::rectangle_shape:

Public Member Functions

 rectangle_shape (const config &cfg)
 Constructor. More...
 
void draw (wfl::map_formula_callable &variables) override
 Draws the canvas. More...
 
- Public Member Functions inherited from gui2::canvas::shape
 shape (const config &cfg)
 
virtual ~shape ()
 
bool immutable () const
 

Private Attributes

int border_thickness_
 Border thickness. More...
 
typed_formula< color_tborder_color_
 The border color of the rectangle. More...
 
typed_formula< color_tfill_color_
 The border color of the rectangle. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::rect_bounded_shape
 rect_bounded_shape (const config &cfg)
 Constructor. More...
 
- Protected Attributes inherited from gui2::rect_bounded_shape
typed_formula< int > x_
 The x coordinate of the rectangle. More...
 
typed_formula< int > y_
 The y coordinate of the rectangle. More...
 
typed_formula< int > w_
 The width of the rectangle. More...
 
typed_formula< int > h_
 The height of the rectangle. More...
 

Detailed Description

Definition of a rectangle.

When drawing a rectangle it doesn't get blended on the surface but replaces the pixels instead. A blitting flag might be added later if needed.

Keys:

Key Type DefaultDescription
border_thickness unsigned 0 The thickness of the border if the thickness is zero it's not drawn.
border_color color "" The color of the border if empty it's not drawn.
fill_color color "" The color of the interior if omitted it's not drawn.
debug string "" Debug message to show upon creation this message is not stored.

Variables: see line_shape

Definition at line 156 of file canvas_private.hpp.

Constructor & Destructor Documentation

◆ rectangle_shape()

gui2::rectangle_shape::rectangle_shape ( const config cfg)
explicit

Constructor.

Parameters
cfgThe config object to define the rectangle.

Definition at line 83 of file canvas.cpp.

References border_color_, border_thickness_, DBG_GUI_P, debug, and gui2::typed_formula< T >::has_formula().

Member Function Documentation

◆ draw()

void gui2::rectangle_shape::draw ( wfl::map_formula_callable variables)
overridevirtual

Draws the canvas.

Parameters
variablesThe canvas can have formulas in it's definition, this parameter contains the values for these formulas.

Implements gui2::canvas::shape.

Definition at line 100 of file canvas.cpp.

References border_color_, border_thickness_, DBG_GUI_D, draw::fill(), fill_color_, h, gui2::rect_bounded_shape::h_, i, color_t::null(), draw::rect(), draw::set_color(), w, gui2::rect_bounded_shape::w_, gui2::rect_bounded_shape::x_, and gui2::rect_bounded_shape::y_.

Member Data Documentation

◆ border_color_

typed_formula<color_t> gui2::rectangle_shape::border_color_
private

The border color of the rectangle.

If the color is fully transparent the border isn't drawn.

Definition at line 181 of file canvas_private.hpp.

Referenced by draw(), and rectangle_shape().

◆ border_thickness_

int gui2::rectangle_shape::border_thickness_
private

Border thickness.

If 0 the fill color is used for the entire widget.

Definition at line 174 of file canvas_private.hpp.

Referenced by draw(), and rectangle_shape().

◆ fill_color_

typed_formula<color_t> gui2::rectangle_shape::fill_color_
private

The border color of the rectangle.

If the color is fully transparent the rectangle won't be filled.

Definition at line 188 of file canvas_private.hpp.

Referenced by draw().


The documentation for this class was generated from the following files: