#include <TextEdit.h>

Inheritance diagram for open3d::visualization::gui::TextEdit:

Data Structures
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 open3d::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 Rect &	GetFrame () const
	Returns the frame size in pixels. More...

virtual void	SetFrame (const Rect &f)

virtual const Color &	GetBackgroundColor () 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 open3d::visualization::gui::Widget
void	DrawImGuiPushEnabledState ()

void	DrawImGuiPopEnabledState ()

void	DrawImGuiTooltip ()

Additional Inherited Members
Public Types inherited from open3d::visualization::gui::Widget
enum class	DrawResult { NONE , REDRAW , RELAYOUT }

enum class	EventResult { IGNORED , CONSUMED , DISCARD }

Static Public Attributes inherited from open3d::visualization::gui::Widget
static constexpr int	DIM_GROW = 10000

Constructor & Destructor Documentation

◆ TextEdit()

open3d::visualization::gui::TextEdit::TextEdit ( )

◆ ~TextEdit()

open3d::visualization::gui::TextEdit::~TextEdit ( )

Member Function Documentation

◆ CalcPreferredSize()

Size open3d::visualization::gui::TextEdit::CalcPreferredSize	(	const LayoutContext &	context,
		const Constraints &	constraints
	)		const

overridevirtual

Reimplemented from open3d::visualization::gui::Widget.

◆ Draw()

Widget::DrawResult open3d::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 open3d::visualization::gui::Widget.

◆ GetPlaceholderText()

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

Returns the text displayed if the text value is empty.

◆ GetText()

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

Returns the current text value displayed.

◆ SetOnTextChanged()

void open3d::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.

◆ SetOnValueChanged()

void open3d::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.

◆ SetPlaceholderText()

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

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

◆ SetText()

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

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

◆ ValidateNewText()

bool open3d::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.

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

/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/gui/TextEdit.h (5c982c7 (Thu Apr 18 12:15:13 2024 -0700))
/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/gui/TextEdit.cpp (5c982c7 (Thu Apr 18 12:15:13 2024 -0700))

Data Structures

Public Member Functions

Protected Member Functions

Additional Inherited Members