GGUI::GGInputValue class

A value given to one of an asset's inputs, or one of its literals.

Public types

struct OwnedText
Text it holds a copy of.

Public static functions

static auto Image(ImageID image) -> GGInputValue
An image.

Constructors, destructors, conversion operators

GGInputValue() defaulted
Nothing: the input's default.
GGInputValue(float number)
A number.
GGInputValue(int number)
A whole number, held as a float.
GGInputValue(bool flag)
True or false.
GGInputValue(const GGText& text)
Text: a string ID, looked up; GGText::Verbatim for data.
GGInputValue(const char* text)
A string ID, looked up.
GGInputValue(const GGColor& colour)
A colour.
GGInputValue(const GGBinding& binding)
A number read as it changes.
GGInputValue(const GGContextValue& context)
A context.

Public functions

auto IsEmpty() const -> bool
Whether it holds nothing.
auto Number() const -> const float*
The number it holds; null if it holds something else.
auto Flag() const -> const bool*
The flag it holds; null if it holds something else.
auto Text() const -> const OwnedText*
The text it holds; null if it holds something else.
auto Colour() const -> const GGColor*
The colour it holds; null if it holds something else.
auto Binding() const -> const GGBinding*
The binding it holds; null if it holds something else.
auto Context() const -> const GGContextValue*
The context it holds; null if it holds something else.
auto Picture() const -> const ImageID*
The image it holds; null if it holds something else.

Friends

auto operator==(const GGInputValue&, const GGInputValue&) -> bool defaulted
every member equal