Carpenter Engine
A C++ game engine with a build once run anywhere solution
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Engine::UI::UIInput Class Reference

An input field for UI. More...

#include <UIInput.hpp>

Inheritance diagram for Engine::UI::UIInput:
Engine::UI::UIElement Engine::Node

Public Member Functions

 UIInput (std::string name, const char *placeholder="")
 Default Constructor.
 
void Init () override
 Creates the UI element and adds it to the DOM.
 
int getInputInt ()
 Returns the input as an integer.
 
double getInputDouble ()
 Returns the input as a double.
 
std::string getInputString ()
 Returns the input as a string.
 
- Public Member Functions inherited from Engine::UI::UIElement
 UIElement (std::string name)
 Default Constructor.
 
 ~UIElement () override
 
void AddTheme (const char *theme)
 Sets the theme of the UI element.
 
void SetAnchor (const char *anchor)
 Sets the anchor of the UI element.
 
void SetDimensions (Vec2f dimensions)
 Sets the dimensions of the UI element.
 
void SetOffset (Vec2f offset)
 Sets the offset of the UI element.
 
void OnEnable () override
 Shows the UI element when enabled.
 
void OnDisable () override
 Hides the UI element when disabled.
 
- Public Member Functions inherited from Engine::Node
 Node (std::string name)
 Default constructor.
 
virtual ~Node ()
 Default destructor.
 
size_t AddChild (Node *child)
 Adds a child to the node and assigns itself as the parent of the new node.
 
NodeGetChild (size_t index)
 Returns a reference to the child at the specified index.
 
Success RemoveChild (size_t index)
 Removes the child at the specified index.
 
Success SetEnabled (bool enabled=true)
 Toggles the state of the node.
 
virtual void Draw ()
 Overridable draw method for the node.
 
virtual void Update (float dt)
 Overridable update method for the node.
 

Additional Inherited Members

- Public Attributes inherited from Engine::Node
const char * m_nodeType
 
std::string m_name
 
- Protected Attributes inherited from Engine::UI::UIElement
const char * m_uiTag
 
const char * m_uiClass
 
- Protected Attributes inherited from Engine::Node
Nodem_parent
 

Detailed Description

An input field for UI.

Takes in a text input, and you can get the input as an integer, double, or string.

See also
UIElement
Author
Roberto Selles

Constructor & Destructor Documentation

◆ UIInput()

Engine::UI::UIInput::UIInput ( std::string  name,
const char *  placeholder = "" 
)

Default Constructor.

takes in a name, and a placeholder text

Parameters
nameThe name of the UI element
placeholderThe placeholder text
See also
UIElement

Member Function Documentation

◆ getInputDouble()

double Engine::UI::UIInput::getInputDouble ( )

Returns the input as a double.

Returns
The input as a double

◆ getInputInt()

int Engine::UI::UIInput::getInputInt ( )

Returns the input as an integer.

Returns
The input as an integer

◆ getInputString()

std::string Engine::UI::UIInput::getInputString ( )

Returns the input as a string.

Returns
The input as a string

◆ Init()

void Engine::UI::UIInput::Init ( )
overridevirtual

Creates the UI element and adds it to the DOM.

Reimplemented from Engine::UI::UIElement.


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