Scroom::Utils::ProgressStateInterface Class Reference

#include <progressinterfacehelpers.hh>

Inheritance diagram for Scroom::Utils::ProgressStateInterface:

Collaboration diagram for Scroom::Utils::ProgressStateInterface:

Public Types
enum	State { IDLE , WAITING , WORKING , FINISHED }
using	Ptr = std::shared_ptr< ProgressStateInterface >
using	WeakPtr = std::weak_ptr< ProgressStateInterface >

Public Member Functions
virtual void	setProgress (State s, double progress=0.0)=0

Additional Inherited Members
Private Member Functions inherited from Interface
	Interface ()=default
	Interface (const Interface &)=delete
Interface &	operator= (const Interface &)=delete
	Interface (Interface &&)=delete
Interface &	operator= (Interface &&)=delete
virtual	~Interface ()=default

Detailed Description

Alternative interface used for reporting progress information

Member Typedef Documentation

Ptr

using Scroom::Utils::ProgressStateInterface::Ptr = std::shared_ptr<ProgressStateInterface>

WeakPtr

using Scroom::Utils::ProgressStateInterface::WeakPtr = std::weak_ptr<ProgressStateInterface>

Member Enumeration Documentation

State

enum Scroom::Utils::ProgressStateInterface::State

Enumerator
IDLE
WAITING
WORKING
FINISHED

    {
      IDLE,
      WAITING,
      WORKING,
      FINISHED
    };

Member Function Documentation

setProgress()

virtual void Scroom::Utils::ProgressStateInterface::setProgress ( State  s, double  progress = 0.0  )

pure virtual

Implemented in ProgressStateInterfaceStub, Scroom::Utils::ProgressInterfaceFromProgressStateInterfaceForwarder, Scroom::Utils::ProgressStateInterfaceFromProgressInterface, Scroom::Utils::Detail::ProgressStore, Scroom::Utils::ProgressInterfaceMultiplexer::ChildData, and Scroom::Utils::ProgressInterfaceMultiplexer::Child.

Referenced by Scroom::Utils::ProgressInterfaceFromProgressStateInterface::setFinished(), Scroom::Utils::ProgressInterfaceFromProgressStateInterface::setIdle(), Scroom::Utils::ProgressInterfaceFromProgressStateInterface::setWaiting(), and Scroom::Utils::ProgressInterfaceFromProgressStateInterface::setWorking().

Here is the caller graph for this function:

---

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

• libs/util/inc/scroom/progressinterfacehelpers.hh