Open3D (C++ API)
Data Structures | Public Member Functions
open3d::gui::Combobox Class Reference

#include <Combobox.h>

Inheritance diagram for open3d::gui::Combobox:
open3d::gui::Widget

Data Structures

struct  Impl
 

Public Member Functions

 Combobox ()
 
 Combobox (const std::vector< const char *> &items)
 
 ~Combobox () override
 
void ClearItems ()
 
void AddItem (const char *name)
 
const char * GetItem (int index) const
 
int GetSelectedIndex () const
 
const char * GetSelectedValue () const
 Returns the text of the selected value, or "" if nothing is selected. More...
 
void SetSelectedIndex (int index)
 
void SetSelectedValue (const char *value)
 
Size CalcPreferredSize (const Theme &theme) const override
 
DrawResult Draw (const DrawContext &context) override
 
void SetOnValueChanged (std::function< void(const char *, int)> on_value_changed)
 
- Public Member Functions inherited from open3d::gui::Widget
 Widget ()
 
 Widget (const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Widget ()
 
void AddChild (std::shared_ptr< Widget > child)
 
const std::vector< std::shared_ptr< Widget > > GetChildren () const
 
const RectGetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
const ColorGetBackgroundColor () const
 
bool IsDefaultBackgroundColor () const
 
void SetBackgroundColor (const Color &color)
 
bool IsVisible () const
 
virtual void SetVisible (bool vis)
 
bool IsEnabled () const
 
virtual void SetEnabled (bool enabled)
 
virtual void Layout (const Theme &theme)
 
virtual EventResult Mouse (const MouseEvent &e)
 
virtual EventResult Key (const KeyEvent &e)
 
virtual DrawResult Tick (const TickEvent &e)
 

Additional Inherited Members

- Public Types inherited from open3d::gui::Widget
enum  DrawResult { DrawResult::NONE, DrawResult::REDRAW, DrawResult::RELAYOUT }
 
enum  EventResult { EventResult::IGNORED, EventResult::CONSUMED, EventResult::DISCARD }
 
- Static Public Attributes inherited from open3d::gui::Widget
static constexpr int DIM_GROW = 10000
 
- Protected Member Functions inherited from open3d::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 

Constructor & Destructor Documentation

◆ Combobox() [1/2]

open3d::gui::Combobox::Combobox ( )

◆ Combobox() [2/2]

open3d::gui::Combobox::Combobox ( const std::vector< const char *> &  items)
explicit

◆ ~Combobox()

open3d::gui::Combobox::~Combobox ( )
override

Member Function Documentation

◆ AddItem()

void open3d::gui::Combobox::AddItem ( const char *  name)

Adds an item to the combobox. Its index is the order in which it is added, so the first item's index is 0, the second is 1, etc.

◆ CalcPreferredSize()

Size open3d::gui::Combobox::CalcPreferredSize ( const Theme theme) const
overridevirtual

Reimplemented from open3d::gui::Widget.

◆ ClearItems()

void open3d::gui::Combobox::ClearItems ( )

◆ Draw()

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

◆ GetItem()

const char * open3d::gui::Combobox::GetItem ( int  index) const

◆ GetSelectedIndex()

int open3d::gui::Combobox::GetSelectedIndex ( ) const

◆ GetSelectedValue()

const char * open3d::gui::Combobox::GetSelectedValue ( ) const

Returns the text of the selected value, or "" if nothing is selected.

◆ SetOnValueChanged()

void open3d::gui::Combobox::SetOnValueChanged ( std::function< void(const char *, int)>  on_value_changed)

Specifies a callback function which will be called when the value changes as a result of user action.

◆ SetSelectedIndex()

void open3d::gui::Combobox::SetSelectedIndex ( int  index)

Sets the selected item by index. Does not call the onValueChanged callback.

◆ SetSelectedValue()

void open3d::gui::Combobox::SetSelectedValue ( const char *  value)

Sets the selected item by value. Does nothing if

Parameters
valueis not an item. Does not call the onValueChanged callback

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