OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::ProgressBar Class Referenceabstract

#include <ProgressBar.hpp>

Public Member Functions

virtual bool isVisible () const =0
 get if visible
 
virtual int maximum () const =0
 get max
 
virtual int minimum () const =0
 get min
 
virtual void onPercentageUpdated (double percentage)
 virtual method called every time percentageUpdated fires
 
virtual void setMaximum (int max)=0
 set max
 
virtual void setMinimum (int min)=0
 set min
 
virtual void setRange (int min, int max)=0
 set range
 
virtual void setValue (int value)=0
 set value
 
virtual void setVisible (bool visible)=0
 set if visible
 
virtual void setWindowTitle (const std::string &title)=0
 set the window title
 
virtual std::string text () const =0
 get the text
 
virtual int value () const =0
 get value
 
virtual std::string windowTitle () const =0
 get the window title
 
virtual ~ProgressBar ()=default
 virtual destructor
 

Public Attributes

Nano::Signal< void(double)> percentageUpdated
 called every time progress increases by 1% more than last progress
 

Protected Member Functions

 ProgressBar ()
 
void updatePercentage ()
 

Detailed Description

ProgressBar is a pure virtual class providing virtual methods setRange, setValue, and setWindowTitle
which may be overridden.

Constructor & Destructor Documentation

◆ ~ProgressBar()

virtual openstudio::ProgressBar::~ProgressBar ( )
virtualdefault

virtual destructor

◆ ProgressBar()

openstudio::ProgressBar::ProgressBar ( )
protected

Member Function Documentation

◆ isVisible()

virtual bool openstudio::ProgressBar::isVisible ( ) const
pure virtual

get if visible

◆ maximum()

virtual int openstudio::ProgressBar::maximum ( ) const
pure virtual

get max

◆ minimum()

virtual int openstudio::ProgressBar::minimum ( ) const
pure virtual

get min

◆ onPercentageUpdated()

virtual void openstudio::ProgressBar::onPercentageUpdated ( double percentage)
virtual

virtual method called every time percentageUpdated fires

◆ setMaximum()

virtual void openstudio::ProgressBar::setMaximum ( int max)
pure virtual

set max

◆ setMinimum()

virtual void openstudio::ProgressBar::setMinimum ( int min)
pure virtual

set min

◆ setRange()

virtual void openstudio::ProgressBar::setRange ( int min,
int max )
pure virtual

set range

◆ setValue()

virtual void openstudio::ProgressBar::setValue ( int value)
pure virtual

set value

◆ setVisible()

virtual void openstudio::ProgressBar::setVisible ( bool visible)
pure virtual

set if visible

◆ setWindowTitle()

virtual void openstudio::ProgressBar::setWindowTitle ( const std::string & title)
pure virtual

set the window title

◆ text()

virtual std::string openstudio::ProgressBar::text ( ) const
pure virtual

get the text

◆ updatePercentage()

void openstudio::ProgressBar::updatePercentage ( )
protected

◆ value()

virtual int openstudio::ProgressBar::value ( ) const
pure virtual

get value

◆ windowTitle()

virtual std::string openstudio::ProgressBar::windowTitle ( ) const
pure virtual

get the window title

Member Data Documentation

◆ percentageUpdated

Nano::Signal<void(double)> openstudio::ProgressBar::percentageUpdated

called every time progress increases by 1% more than last progress