ngscopeclient 0.1-dev+51fbda87c
Public Member Functions | Protected Attributes | List of all members
TimebasePropertiesDialog Class Reference
Inheritance diagram for TimebasePropertiesDialog:
Inheritance graph
[legend]
Collaboration diagram for TimebasePropertiesDialog:
Collaboration graph
[legend]

Public Member Functions

 TimebasePropertiesDialog (Session *session)
 
void Refresh ()
 Refreshes the dialog whenever the set of valid configurations changes. More...
 
virtual bool DoRender ()
 Renders the dialog and handles UI events. More...
 
- Public Member Functions inherited from Dialog
 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 ()
 

Protected Attributes

Sessionm_session
 
std::vector< std::unique_ptr< TimebasePropertiesPage > > m_pages
 
- Protected Attributes inherited from Dialog
bool m_open
 
std::string m_id
 
std::string m_title
 
ImVec2 m_defaultSize
 
std::string m_errorPopupTitle
 
std::string m_errorPopupMessage
 

Additional Inherited Members

- Static Public Member Functions inherited from Dialog
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 inherited from Dialog
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.
 

Member Function Documentation

◆ DoRender()

bool TimebasePropertiesDialog::DoRender ( )
virtual

Renders the dialog and handles UI events.

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

Implements Dialog.

◆ Refresh()

void TimebasePropertiesDialog::Refresh ( )

Refreshes the dialog whenever the set of valid configurations changes.

Examples of events that will need to trigger a refresh: Enabling or disabling a channel Changing ADC mode


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