OpenStudio:utilities
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "ProgressBar.hpp"

Public Member Functions

virtual bool isVisible () const =0
virtual int maximum () const =0
virtual int minimum () const =0
virtual void onPercentageUpdated (double percentage)
virtual void setMaximum (int max)=0
virtual void setMinimum (int min)=0
virtual void setRange (int min, int max)=0
virtual void setValue (int value)=0
virtual void setVisible (bool visible)=0
virtual void setWindowTitle (const std::string &title)=0
virtual std::string text () const =0
virtual int value () const =0
virtual std::string windowTitle () const =0
virtual ~ProgressBar ()=default

Public Attributes

Nano::Signal< void(double)> percentageUpdated

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