libAlgAudio  v1.99-440-g08538e5-dirty
The development library for AlgAudio framework.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AlgAudio::UITextEntry Class Reference

#include <UITextEntry.hpp>

Inheritance diagram for AlgAudio::UITextEntry:
AlgAudio::UIWidget AlgAudio::UIMouseEventsBase AlgAudio::SubscriptionsManager AlgAudio::UIVisibilityBase

Public Member Functions

virtual void CustomDraw (DrawContext &c) override
 
std::string GetText () const
 
virtual void OnFocusChanged (bool) override
 
virtual void OnKeyboard (KeyData) override
 
void SetDefaultText (std::string d)
 
void SetDigitsOnly (bool d)
 
void SetFontSize (int size)
 
void SetMaxLength (int l)
 
void SetText (std::string text)
 
- Public Member Functions inherited from AlgAudio::UIWidget
virtual std::shared_ptr< UIWidgetCustomFindChild (ID) const
 
virtual void CustomResize (Size2D)
 
void Draw (DrawContext &c)
 
std::shared_ptr< UIWidgetFindChild (ID search_id)
 
Size2D GetCurrentSize () const
 
Point2D GetPosInParent (std::shared_ptr< UIWidget > ancestor)
 
Size2D GetRequestedSize () const
 
std::shared_ptr< WindowGetWindow ()
 
bool HasParent ()
 
bool HasZeroArea () const
 
virtual void RequestFocus () override
 
void Resize (Size2D s)
 
void SetBackColor (const Color &c)
 
void SetCustomSize (Size2D size)
 
void SetFrontColor (const Color &c)
 
void TriggerFakeResize ()
 
virtual ~UIWidget ()
 
- Public Member Functions inherited from AlgAudio::UIMouseEventsBase
virtual void CustomMouseEnter (Point2D)
 
virtual void CustomMouseLeave (Point2D)
 
virtual void CustomMouseMotion (Point2D, Point2D)
 
virtual bool CustomMousePress (bool, MouseButton, Point2D)
 
void OnMouseEnter (Point2D)
 
void OnMouseLeave (Point2D)
 
void OnMouseMotion (Point2D, Point2D)
 
bool OnMousePress (bool, MouseButton, Point2D)
 
void SetFocusable (bool f)
 
- Public Member Functions inherited from AlgAudio::UIVisibilityBase
bool IsDrawn () const
 
bool IsInvisible () const
 
void SetDisplayMode (DisplayMode m)
 

Static Public Member Functions

static std::shared_ptr
< UITextEntry
Create (std::weak_ptr< Window > parent_window, std::string text="")
 

Public Attributes

Signal on_edit_complete
 
Signal on_edit_exitted
 
Signal on_edited
 
- Public Attributes inherited from AlgAudio::UIWidget
bool debug_this_widget = false
 
std::weak_ptr< UIWidgetparent
 
ID widget_id
 
- Public Attributes inherited from AlgAudio::UIMouseEventsBase
Point2D last_mouse_pos
 
Signal on_clicked
 
Signal< Point2Don_motion
 
Signal< bool > on_pointed
 
Signal< bool > on_pressed
 
- Public Attributes inherited from AlgAudio::UIVisibilityBase
Signal on_display_mode_changed
 
- Public Attributes inherited from AlgAudio::SubscriptionsManager
SubscriptionList subscriptions
 

Additional Inherited Members

- Public Types inherited from AlgAudio::UIVisibilityBase
enum  DisplayMode { DisplayMode::Visible, DisplayMode::EmptySpace, DisplayMode::Invisible }
 
- Protected Member Functions inherited from AlgAudio::UIWidget
bool IsFocused () const
 
bool IsRoot () const
 
virtual void OnChildFocusRequested (std::shared_ptr< UIWidget >)
 
virtual bool OnChildFocusTested (std::shared_ptr< const UIWidget >)
 
virtual void OnChildRequestedSizeChanged ()
 
virtual void OnChildVisibilityChanged ()
 
void SetMinimalSize (Size2D)
 
void SetNeedsRedrawing ()
 
 UIWidget (std::weak_ptr< Window > parent_window)
 
- Protected Member Functions inherited from AlgAudio::UIMouseEventsBase
 UIMouseEventsBase ()
 
- Protected Member Functions inherited from AlgAudio::UIVisibilityBase
 UIVisibilityBase ()
 
- Protected Attributes inherited from AlgAudio::UIWidget
Size2D current_size = Size2D(0,0)
 
std::weak_ptr< Windowwindow
 
- Protected Attributes inherited from AlgAudio::UIMouseEventsBase
bool focusable = true
 
bool pointed = false
 
bool pressed = false
 
- Protected Attributes inherited from AlgAudio::UIVisibilityBase
DisplayMode display_mode = DisplayMode::Visible
 

Member Function Documentation

static std::shared_ptr<UITextEntry> AlgAudio::UITextEntry::Create ( std::weak_ptr< Window parent_window,
std::string  text = "" 
)
static
virtual void AlgAudio::UITextEntry::CustomDraw ( DrawContext c)
overridevirtual

Implements AlgAudio::UIWidget.

std::string AlgAudio::UITextEntry::GetText ( ) const
inline
virtual void AlgAudio::UITextEntry::OnFocusChanged ( bool  )
overridevirtual

This method is called when the widget focus state has changed. The only param states whether this widget has now the focus

Reimplemented from AlgAudio::UIWidget.

virtual void AlgAudio::UITextEntry::OnKeyboard ( KeyData  )
overridevirtual

Reimplemented from AlgAudio::UIWidget.

void AlgAudio::UITextEntry::SetDefaultText ( std::string  d)
inline

The default text is displayed when the typed in text is empty. Useful for setting up a placeholder message, or example value.

void AlgAudio::UITextEntry::SetDigitsOnly ( bool  d)
inline

If set to true, all non-digit keystrokes will be ignored.

void AlgAudio::UITextEntry::SetFontSize ( int  size)
void AlgAudio::UITextEntry::SetMaxLength ( int  l)

Sets the maximum allowed length of enterred text. Set to -1 to disable limit. By default there is no limit.

void AlgAudio::UITextEntry::SetText ( std::string  text)

Member Data Documentation

Signal AlgAudio::UITextEntry::on_edit_complete

Triggered when the Return key is pressed while entering text.

Signal AlgAudio::UITextEntry::on_edit_exitted

Triggered when focus is lost after user edited text.

Signal AlgAudio::UITextEntry::on_edited

Triggered when user does any change to the text.


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