The Battle for Wesnoth  1.17.12+dev
Protected Member Functions | Protected Attributes | List of all members
gui2::rect_bounded_shape Class Reference

Class holding common attribute names (for WML) and common implementation (in C++) for shapes placed with the 4 attributes x, y, w and h. More...

#include <canvas_private.hpp>

Inheritance diagram for gui2::rect_bounded_shape:

Protected Member Functions

 rect_bounded_shape (const config &cfg)
 Constructor. More...
 

Protected Attributes

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...
 

Additional Inherited Members

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

Detailed Description

Class holding common attribute names (for WML) and common implementation (in C++) for shapes placed with the 4 attributes x, y, w and h.

Keys:

Key Type DefaultDescription
x f_unsigned0 The x coordinate of the top left corner.
y f_unsigned0 The y coordinate of the top left corner.
w f_unsigned0 The width of the rectangle.
h f_unsigned0 The height of the rectangle.

Definition at line 116 of file canvas_private.hpp.

Constructor & Destructor Documentation

◆ rect_bounded_shape()

gui2::rect_bounded_shape::rect_bounded_shape ( const config cfg)
inlineexplicitprotected

Constructor.

Parameters
cfgThe config object to define the rectangle.

Definition at line 124 of file canvas_private.hpp.

Member Data Documentation

◆ h_

typed_formula<int> gui2::rect_bounded_shape::h_
protected

The height of the rectangle.

Definition at line 136 of file canvas_private.hpp.

Referenced by gui2::rectangle_shape::draw(), gui2::round_rectangle_shape::draw(), and gui2::text_shape::draw().

◆ w_

typed_formula<int> gui2::rect_bounded_shape::w_
protected

The width of the rectangle.

Definition at line 135 of file canvas_private.hpp.

Referenced by gui2::rectangle_shape::draw(), gui2::round_rectangle_shape::draw(), and gui2::text_shape::draw().

◆ x_

typed_formula<int> gui2::rect_bounded_shape::x_
protected

The x coordinate of the rectangle.

Definition at line 133 of file canvas_private.hpp.

Referenced by gui2::rectangle_shape::draw(), gui2::round_rectangle_shape::draw(), and gui2::text_shape::draw().

◆ y_

typed_formula<int> gui2::rect_bounded_shape::y_
protected

The y coordinate of the rectangle.

Definition at line 134 of file canvas_private.hpp.

Referenced by gui2::rectangle_shape::draw(), gui2::round_rectangle_shape::draw(), and gui2::text_shape::draw().


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