Dialog Class Reference

Generic dialog box or other popup window. More...

#include <Dialog.h>

Inheritance diagram for Dialog:

Public Member Functions
	Dialog (const std::string &title, const std::string &id, ImVec2 defaultSize=ImVec2(300, 100))
virtual bool	Render ()
	Renders the dialog and handles UI events. More...
void	RenderAsChild ()
	Runs the dialog's contents directly into a parent window.
virtual bool	DoRender ()=0
const std::string &	GetID ()
std::string	GetTitleAndID ()

Static Public Member Functions
static bool	Combo (const std::string &label, const std::vector< std::string > &items, int &selection)
	Displays a combo box from a vector<string>
static bool	UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, float &committedValue, Unit unit)
	Input box for a floating point value with an associated unit. More...
static bool	UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, double &committedValue, Unit unit)
	Input box for a double precision floating point value with an associated unit. More...
static bool	UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, int64_t &committedValue, Unit unit)
	Input box for an integer value with an associated unit. More...
static bool	TextInputWithImplicitApply (const std::string &label, std::string &currentValue, std::string &committedValue)
static void	Tooltip (const std::string &str, bool allowDisabled=false)
	Helper based on imgui demo for displaying tooltip text over the previously rendered widget.
static void	HelpMarker (const std::string &str)
static void	HelpMarker (const std::string &header, const std::vector< std::string > &bullets)

Protected Member Functions
bool	FloatInputWithApplyButton (const std::string &label, float &currentValue, float &committedValue)
	Helper for displaying a floating-point input box with an "apply" button.
bool	TextInputWithApplyButton (const std::string &label, std::string &currentValue, std::string &committedValue)
bool	IntInputWithImplicitApply (const std::string &label, int &currentValue, int &committedValue)
bool	UnitInputWithExplicitApply (const std::string &label, std::string &currentValue, float &committedValue, Unit unit)
	Input box for a floating point value with an associated unit and an "apply" button. More...
void	RenderErrorPopup ()
	Popup message when we fail to connect.
void	ShowErrorPopup (const std::string &title, const std::string &msg)
	Opens the error popup.

Protected Attributes
bool	m_open
std::string	m_id
std::string	m_title
ImVec2	m_defaultSize
std::string	m_errorPopupTitle
std::string	m_errorPopupMessage

Detailed Description

Generic dialog box or other popup window.

Member Function Documentation

DoRender()

virtual bool Dialog::DoRender ( )

pure virtual

Implemented in AboutDialog, AddInstrumentDialog, BERTOutputChannelDialog, ChannelPropertiesDialog, FilterGraphEditor, FilterPropertiesDialog, HistoryDialog, ManageInstrumentsDialog, MetricsDialog, PersistenceSettingsDialog, PreferenceDialog, ProtocolAnalyzerDialog, ScopeDeskewWizard, TriggerPropertiesDialog, BERTInputChannelDialog, CreateFilterBrowser, DigitalInputChannelDialog, DigitalIOChannelDialog, DigitalOutputChannelDialog, MeasurementsDialog, NotesDialog, and StreamBrowserDialog.

Render()

bool Dialog::Render ( )

virtual

Renders the dialog and handles UI events.

Returns

True if we should continue showing the dialog False if it's been closed

Reimplemented in FilterGraphEditor, FilterPropertiesDialog, and BERTInputChannelDialog.

UnitInputWithExplicitApply()

bool Dialog::UnitInputWithExplicitApply ( const std::string &  label, std::string &  currentValue, float &  committedValue, Unit  unit  )

protected

Input box for a floating point value with an associated unit and an "apply" button.

Parameters

label	Text label
currentValue	Current text box content
committedValue	Most recently applied value
unit	The unit for the input

Returns

True the "apply" button is pressed

UnitInputWithImplicitApply() [1/3]

bool Dialog::UnitInputWithImplicitApply ( const std::string &  label, std::string &  currentValue, double &  committedValue, Unit  unit  )

static

Input box for a double precision floating point value with an associated unit.

Parameters

label	Text label
currentValue	Current text box content
committedValue	Most recently applied value
unit	The unit for the input

Returns

True when focus is lost or user presses enter

UnitInputWithImplicitApply() [2/3]

bool Dialog::UnitInputWithImplicitApply ( const std::string &  label, std::string &  currentValue, float &  committedValue, Unit  unit  )

static

Input box for a floating point value with an associated unit.

Parameters

label	Text label
currentValue	Current text box content
committedValue	Most recently applied value
unit	The unit for the input

Returns

True when focus is lost or user presses enter

UnitInputWithImplicitApply() [3/3]

bool Dialog::UnitInputWithImplicitApply ( const std::string &  label, std::string &  currentValue, int64_t &  committedValue, Unit  unit  )

static

Input box for an integer value with an associated unit.

Parameters

label	Text label
currentValue	Current text box content
committedValue	Most recently applied value
unit	The unit for the input

Returns

True when focus is lost or user presses enter

---

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

• src/ngscopeclient/Dialog.h
• src/ngscopeclient/Dialog.cpp