OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
openstudio::ProgressBar Class Referenceabstract

#include <ProgressBar.hpp>

Public Member Functions

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

Public Attributes

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

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

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

virtual destructor

openstudio::ProgressBar::ProgressBar ( )
protected

Member Function Documentation

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

get if visible

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

get max

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

get min

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

virtual method called every time percentageUpdated fires

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

set max

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

set min

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

set range

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

set value

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

set if visible

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

set the window title

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

get the text

void openstudio::ProgressBar::updatePercentage ( )
protected
virtual int openstudio::ProgressBar::value ( ) const
pure virtual

get value

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

get the window title

Member Data Documentation

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

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