ACloudViewer  3.9.4
A Modern Library for 3D Data Processing
cloudViewer::visualization::gui::TextEdit Class Reference

#include <TextEdit.h>

Inheritance diagram for cloudViewer::visualization::gui::TextEdit:
Collaboration diagram for cloudViewer::visualization::gui::TextEdit:

Classes

struct  Impl
 

Public Member Functions

 TextEdit ()
 
 ~TextEdit ()
 
const char * GetText () const
 Returns the current text value displayed. More...
 
void SetText (const char *text)
 
const char * GetPlaceholderText () const
 Returns the text displayed if the text value is empty. More...
 
void SetPlaceholderText (const char *text)
 Sets the text to display if the text value is empty. More...
 
Size CalcPreferredSize (const LayoutContext &context, const Constraints &constraints) const override
 
DrawResult Draw (const DrawContext &context) override
 
void SetOnTextChanged (std::function< void(const char *)> on_text_changed)
 
void SetOnValueChanged (std::function< void(const char *)> on_value_changed)
 
- Public Member Functions inherited from cloudViewer::visualization::gui::Widget
 Widget ()
 
 Widget (const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Widget ()
 
virtual void AddChild (std::shared_ptr< Widget > child)
 
virtual const std::vector< std::shared_ptr< Widget > > GetChildren () const
 
virtual const RectGetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
virtual const ColorGetBackgroundColor () const
 
virtual bool IsDefaultBackgroundColor () const
 
virtual void SetBackgroundColor (const Color &color)
 
virtual bool IsVisible () const
 
virtual void SetVisible (bool vis)
 
virtual bool IsEnabled () const
 
virtual void SetEnabled (bool enabled)
 
virtual void SetTooltip (const char *text)
 
virtual const char * GetTooltip () const
 
virtual Size CalcMinimumSize (const LayoutContext &context) const
 
virtual void Layout (const LayoutContext &context)
 
virtual EventResult Mouse (const MouseEvent &e)
 
virtual EventResult Key (const KeyEvent &e)
 
virtual DrawResult Tick (const TickEvent &e)
 

Protected Member Functions

virtual bool ValidateNewText (const char *text)
 
- Protected Member Functions inherited from cloudViewer::visualization::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 
void DrawImGuiTooltip ()
 

Additional Inherited Members

- Public Types inherited from cloudViewer::visualization::gui::Widget
enum class  DrawResult { NONE , REDRAW , RELAYOUT }
 
enum class  EventResult { IGNORED , CONSUMED , DISCARD }
 
- Static Public Attributes inherited from cloudViewer::visualization::gui::Widget
static constexpr int DIM_GROW = 10000
 

Detailed Description

Definition at line 18 of file TextEdit.h.

Constructor & Destructor Documentation

◆ TextEdit()

cloudViewer::visualization::gui::TextEdit::TextEdit ( )

Definition at line 45 of file TextEdit.cpp.

References patch::to_string().

◆ ~TextEdit()

cloudViewer::visualization::gui::TextEdit::~TextEdit ( )

Definition at line 50 of file TextEdit.cpp.

Member Function Documentation

◆ CalcPreferredSize()

Size cloudViewer::visualization::gui::TextEdit::CalcPreferredSize ( const LayoutContext context,
const Constraints constraints 
) const
overridevirtual

◆ Draw()

Widget::DrawResult cloudViewer::visualization::gui::TextEdit::Draw ( const DrawContext context)
overridevirtual

Draws the widget. If this is a Dear ImGUI widget, this is where the actual event processing happens. Return NONE if no action needs to be taken, REDRAW if the widget needs to be redrawn (e.g. its value changed), and RELAYOUT if the widget wishes to change size.

Reimplemented from cloudViewer::visualization::gui::Widget.

Definition at line 83 of file TextEdit.cpp.

References cloudViewer::visualization::gui::colorToImgui(), context, cloudViewer::visualization::gui::Widget::DrawImGuiPopEnabledState(), cloudViewer::visualization::gui::Widget::DrawImGuiPushEnabledState(), cloudViewer::visualization::gui::Widget::DrawImGuiTooltip(), frame, cloudViewer::visualization::gui::Widget::GetFrame(), cloudViewer::visualization::gui::Widget::IsEnabled(), cloudViewer::visualization::gui::Widget::NONE, cloudViewer::visualization::gui::Widget::REDRAW, result, ValidateNewText(), and width.

◆ GetPlaceholderText()

const char * cloudViewer::visualization::gui::TextEdit::GetPlaceholderText ( ) const

Returns the text displayed if the text value is empty.

Definition at line 56 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ GetText()

const char * cloudViewer::visualization::gui::TextEdit::GetText ( ) const

Returns the current text value displayed.

Definition at line 52 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetOnTextChanged()

void cloudViewer::visualization::gui::TextEdit::SetOnTextChanged ( std::function< void(const char *)>  on_text_changed)

Sets the function that is called whenever the text in the widget changes. This will be called for every keystroke and edit.

Definition at line 64 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetOnValueChanged()

void cloudViewer::visualization::gui::TextEdit::SetOnValueChanged ( std::function< void(const char *)>  on_value_changed)

Sets the function that is called whenever the text is the widget is finished editing via pressing enter or clicking off the widget.

Definition at line 69 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetPlaceholderText()

void cloudViewer::visualization::gui::TextEdit::SetPlaceholderText ( const char *  text)

Sets the text to display if the text value is empty.

Definition at line 60 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetText()

void cloudViewer::visualization::gui::TextEdit::SetText ( const char *  text)

Sets the current text value displayed. Does not call onTextChanged or onValueChanged.

Definition at line 54 of file TextEdit.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ ValidateNewText()

bool cloudViewer::visualization::gui::TextEdit::ValidateNewText ( const char *  text)
protectedvirtual

Returns true if new text is valid. Otherwise call SetText() with a valid value and return false.

Definition at line 74 of file TextEdit.cpp.

Referenced by Draw().


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