Input class
#include <Magnum/Ui/Input.h>
Input widget.
Can attach to application-specific keyboard and text input.
Base classes
- class Widget
- Base for widgets.
Derived classes
- class ValidatedInput
- Validated input.
Constructors, destructors, conversion operators
-
Input(Plane& plane,
const Anchor& anchor,
std::
string value, std:: size_t maxValueSize, Style style = Style:: Default) explicit - Constructor.
-
Input(Plane& plane,
const Anchor& anchor,
std::
size_t maxValueSize, Style style = Style:: Default) explicit
Public functions
- auto setStyle(Style style) -> Input&
- Set widget style.
-
auto maxValueSize() const -> std::
size_t - Max value size.
-
auto value() const -> const std::
string& - Value.
-
auto setValue(const std::
string& value) -> Input& - Set value.
-
auto setValue(std::
string&& value) -> Input& -
auto setValue(Containers::
ArrayView<const char> value) -> Input& -
template<std::auto setValue(const char(&value)[size]) -> Input&
size_t size> -
template<class KeyEvent>auto handleKeyPress(KeyEvent& keyEvent) -> bool
- Handle key press from an application.
-
template<class TextInputEvent>auto handleTextInput(TextInputEvent& textInputEvent) -> bool
- Handle text input from an application.
- auto focused() -> Signal
- The widget was focused.
- auto blurred() -> Signal
- The widget was blurred.
-
auto valueChanged(const std::
string& value) -> Signal - The input value changed.
Function documentation
Magnum::
Constructor.
| Parameters | |
|---|---|
| plane | Plane this widget is a part of |
| anchor | Positioning anchor |
| value | Initial input value |
| maxValueSize | Max input text size |
| style | Widget style |
Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Input& Magnum::
Set value.
| Returns | Reference to self (for method chaining) |
|---|
The value is expected to not have more glyphs than the capacity set in constructor.
Input& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Input& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<std::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<class KeyEvent>
bool Magnum::
Handle key press from an application.
Handles keyboard input like cursor movement or backspace/delete keys. Should be called from within Platform::true if the event was accepted (and thus the input value changed), false otherwise.
template<class TextInputEvent>
bool Magnum::
Handle text input from an application.
Handles UTF-8 text input. Input that makes the value exceed maxValueSize is ignored. Should be called from within Platform::true if the event was accepted (and thus the input value changed), false otherwise.
Signal Magnum::
The widget was focused.
Text input from the application should be started upon signalling this and passed to handleKeyPress() and handleTextInput().
Signal Magnum::
The input value changed.
Useful for attaching input validators.