[][src]Module pushrod::render::widget_config

This is a configuration object that stores information about Widgets.

Structs

PaddingConstraint

This struct stores padding constraints.

WidgetConfig

This is the store for the WidgetConfig, which each Widget object needs. This stores information about the Widget. It currently contains the point of origin, size, a HashMap of different Colors, a border width, and an invalidation flag.

Enums

CompassPosition

This enum is used by the ImageWidget, which controls the positioning of the image being rendered within the bounds of the Widget.

Config

Configuration object type - allows configurations to be set using Piston, Pushrod, or native types.

Constants

CONFIG_BORDER_WIDTH

Widget configuration that stores the display border in pixels. This is stored as a Config::Numeric value.

CONFIG_COLOR_BASE

Widget Base Color key for colors HashMap. This is the base fill color of a Widget that is in an unselected state. This stored as a Config::Color.

CONFIG_COLOR_BORDER

Widget Border Color key for colors HashMap. This should be used for the color of the border, if the Widget draws a border. This stored as a Config::Color.

CONFIG_COLOR_HOVER

Widget Hover Color key for colors HashMap. This is the base fill color of a Widget that has a mouse hovering over the top of the Widget, or when a mouse_entered event is triggered. This is optional; the Widget does not need to honor this color if it does not support a hover state. This stored as a Config::Color.

CONFIG_COLOR_SECONDARY

Widget Secondary Color key for colors HashMap. This is the color the Widget should display for any secondary properties, such as a fill color for a progress widget, a spinner, etc. This stored as a Config::Color.

CONFIG_COLOR_SELECTED

Widget Selected Color key for colors HashMap. This is the color the Widget should display when in selected state. This stored as a Config::Color.

CONFIG_COLOR_TEXT

Widget Text Color key for colors HashMap. This should be the color for the text being displayed inside the Widget. This stored as a Config::Color.

CONFIG_FONT_SIZE

TextWidget font size control. This is stored as a Config::Numeric value.

CONFIG_IMAGE_POSITION

Widget image position direction, controls the position of an Image within the bounds of a Widget. This is stored as a Config::CompassPosition value.

CONFIG_ORIGIN

Widget configuration to store its origin on the screen. This is a Config::Points object in the config.

CONFIG_SELECTED_STATE

PushButtonWidget selected state. This is stored as a Config::Toggle value.

CONFIG_SIZE

Widget configuration that stores the size of the Widget. This is a Config::Size object in the config.

CONFIG_TEXT

Widget text store, used to display text on the screen. This is stored as a Config::Text value.