RADLib
RADical C++ application framework
RADUi::ProgressModel Class Reference

Progress state model. More...

#include <RADAppKit.h>

+ Inheritance diagram for RADUi::ProgressModel:
+ Collaboration diagram for RADUi::ProgressModel:

Public Member Functions

void setRange (double minimum, double maximum)
 Sets range. More...
 
void setValue (double value)
 Sets current value. More...
 
void setBusy (bool busy)
 Sets busy/indeterminate state. More...
 
double minimum () const
 Returns minimum. More...
 
double maximum () const
 Returns maximum. More...
 
double value () const
 Returns value. More...
 
bool busy () const
 Returns true when busy. More...
 
double normalized () const
 Returns normalized 0..1 progress. More...
 
- Public Member Functions inherited from RADCore::RADObject
 RADObject ()
 Creates a RADObject bound to the current thread. More...
 
virtual ~RADObject ()
 Disconnects tracked event links and releases lifetime token. More...
 
void registerLink (const ConnectionRecord &record)
 Registers a connection for cleanup when this object is destroyed. More...
 
std::thread::id threadId () const
 Returns the thread id this object is currently associated with. More...
 
EventLoopassociatedEventLoop () const
 Returns the associated event loop, if any. More...
 
ThreadAffinity threadAffinity () const
 Returns both thread id and associated loop atomically. More...
 
std::weak_ptr< void > lifetimeToken () const
 Returns a weak token used to drop queued callbacks after destruction. More...
 
void moveToThread (std::thread::id tId, EventLoop *loop=nullptr)
 Moves the object's affinity to tId and optional loop. More...
 

Public Attributes

RADCore::Event< void() > changed
 Raised when progress changes. More...
 

Detailed Description

Progress state model.

Member Function Documentation

◆ busy()

bool RADUi::ProgressModel::busy ( ) const

Returns true when busy.

◆ maximum()

double RADUi::ProgressModel::maximum ( ) const

Returns maximum.

◆ minimum()

double RADUi::ProgressModel::minimum ( ) const

Returns minimum.

◆ normalized()

double RADUi::ProgressModel::normalized ( ) const

Returns normalized 0..1 progress.

◆ setBusy()

void RADUi::ProgressModel::setBusy ( bool  busy)

Sets busy/indeterminate state.

◆ setRange()

void RADUi::ProgressModel::setRange ( double  minimum,
double  maximum 
)

Sets range.

◆ setValue()

void RADUi::ProgressModel::setValue ( double  value)

Sets current value.

◆ value()

double RADUi::ProgressModel::value ( ) const

Returns value.

Member Data Documentation

◆ changed

RADCore::Event<void () > RADUi::ProgressModel::changed

Raised when progress changes.


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