ngscopeclient 0.1-dev+51fbda87c
Public Member Functions | Protected Attributes | List of all members
HistoryDialog Class Reference

UI for the history system. More...

#include <HistoryDialog.h>

Inheritance diagram for HistoryDialog:
Inheritance graph
[legend]
Collaboration diagram for HistoryDialog:
Collaboration graph
[legend]

Public Member Functions

 HistoryDialog (HistoryManager &mgr, Session &session, MainWindow &wnd)
 
virtual bool DoRender ()
 Renders the dialog and handles UI events. More...
 
bool PollForSelectionChanges ()
 
void LoadHistoryFromSelection (Session &session)
 Applies waveforms from the currently selected history row to the scopes. More...
 
void UpdateSelectionToLatest ()
 Selects the last row in the history.
 
void SelectTimestamp (TimePoint t)
 Selects the row with a specified timestamp.
 
TimePoint GetSelectedPoint ()
 Gets the timestamp of our selection.
 
- 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

HistoryManagerm_mgr
 
Sessionm_session
 
MainWindowm_parent
 
float m_rowHeight
 Height of a row in the dialog.
 
bool m_selectionChanged
 True if a new row in the dialog was selected this frame.
 
std::shared_ptr< HistoryPointm_selectedPoint
 The currently selected point of history.
 
Markerm_selectedMarker
 The currently selected marker.
 
- 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.
 

Detailed Description

UI for the history system.

Member Function Documentation

◆ DoRender()

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

◆ LoadHistoryFromSelection()

void HistoryDialog::LoadHistoryFromSelection ( Session session)

Applies waveforms from the currently selected history row to the scopes.

This is done at the very end of the frame following the actual selection change, to avoid inconsistent UI state from making the change mid-frame.


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