libzypp 17.34.1
zyppng::ProgressObserver Class Reference

#include <zypp-core/zyppng/ui/progressobserver.h>

Inheritance diagram for zyppng::ProgressObserver:

Public Member Functions

 ZYPP_DECL_PRIVATE_CONSTR_ARGS (ProgressObserver, const std::string &label=std::string(), int steps=100)
 
void setBaseSteps (int steps)
 
int baseSteps () const
 
int steps () const
 
void reset ()
 
void setCurrent (double curr)
 
void setFinished ()
 
void inc (double inc=1.0, const std::optional< std::string > &newLabel={})
 
double progress () const
 
double current () const
 
const std::vector< zyppng::ProgressObserverRef > & children ()
 
void setLabel (const std::string &label)
 
const std::string & label () const
 
void registerSubTask (const ProgressObserverRef &child, float weight=1.0)
 
zypp::ProgressData::ReceiverFnc makeProgressDataReceiver ()
 
SignalProxy< void(ProgressObserver &sender, const std::string &str)> sigLabelChanged ()
 
SignalProxy< void(ProgressObserver &sender, double steps)> sigStepsChanged ()
 
SignalProxy< void(ProgressObserver &sender, double current) > sigValueChanged ()
 
SignalProxy< void(ProgressObserver &sender, double progress)> sigProgressChanged ()
 
SignalProxy< void(ProgressObserver &sender)> sigFinished ()
 
SignalProxy< void(ProgressObserver &sender, ProgressObserverRef child)> sigNewSubprogress ()
 
- Public Member Functions inherited from zyppng::Base
 Base ()
 
virtual ~Base ()
 
WeakPtr parent () const
 
void addChild (const Base::Ptr &child)
 
void removeChild (const Ptr &child)
 
const std::unordered_set< Ptr > & children () const
 
std::thread::id threadId () const
 
template<typename T >
std::vector< std::weak_ptr< T > > findChildren () const
 
template<typename T >
std::shared_ptr< T > shared_this () const
 
template<typename T >
std::shared_ptr< T > shared_this ()
 
template<typename T >
std::weak_ptr< T > weak_this () const
 
template<typename T >
std::weak_ptr< T > weak_this ()
 
template<typename SenderFunc , typename ReceiverFunc >
auto connect (SenderFunc &&sFun, typename internal::MemberFunction< ReceiverFunc >::ClassType &recv, ReceiverFunc &&rFunc)
 
template<typename SenderFunc , typename ReceiverFunc , typename ... Tracker>
std::enable_if_t< std::is_member_function_pointer_v< SenderFunc >, connectionconnectFunc (SenderFunc &&sFun, ReceiverFunc &&rFunc, const Tracker &...trackers)
 

Additional Inherited Members

- Public Types inherited from zyppng::Base
using Ptr = std::shared_ptr<Base>
 
using WeakPtr = std::weak_ptr<Base>
 
- Static Public Member Functions inherited from zyppng::Base
template<typename Obj , typename Functor >
static decltype(auto) make_base_slot (Obj *o, Functor &&f)
 
template<typename SenderFunc , typename ReceiverFunc >
static auto connect (typename internal::MemberFunction< SenderFunc >::ClassType &s, SenderFunc &&sFun, typename internal::MemberFunction< ReceiverFunc >::ClassType &recv, ReceiverFunc &&rFunc)
 
template<typename SenderFunc , typename ReceiverFunc , typename ... Tracker>
static auto connectFunc (typename internal::MemberFunction< SenderFunc >::ClassType &s, SenderFunc &&sFun, ReceiverFunc &&rFunc, const Tracker &...trackers)
 
- Protected Member Functions inherited from zyppng::Base
 Base (BasePrivate &dd)
 
- Protected Attributes inherited from zyppng::Base
std::unique_ptr< BasePrivated_ptr
 

Detailed Description

Definition at line 27 of file progressobserver.h.

Member Function Documentation

◆ ZYPP_DECL_PRIVATE_CONSTR_ARGS()

zyppng::ProgressObserver::ZYPP_DECL_PRIVATE_CONSTR_ARGS ( ProgressObserver ,
const std::string & label = std::string(),
int steps = 100 )

◆ setBaseSteps()

void zyppng::ProgressObserver::setBaseSteps ( int steps)

Definition at line 206 of file progressobserver.cc.

◆ baseSteps()

int zyppng::ProgressObserver::baseSteps ( ) const

Definition at line 235 of file progressobserver.cc.

◆ steps()

int zyppng::ProgressObserver::steps ( ) const

Definition at line 140 of file progressobserver.cc.

◆ reset()

void zyppng::ProgressObserver::reset ( )

Definition at line 145 of file progressobserver.cc.

◆ setCurrent()

void zyppng::ProgressObserver::setCurrent ( double curr)

Definition at line 223 of file progressobserver.cc.

◆ setFinished()

void zyppng::ProgressObserver::setFinished ( )

Definition at line 240 of file progressobserver.cc.

◆ inc()

void zyppng::ProgressObserver::inc ( double inc = 1.0,
const std::optional< std::string > & newLabel = {} )

Definition at line 252 of file progressobserver.cc.

◆ progress()

double zyppng::ProgressObserver::progress ( ) const

Definition at line 156 of file progressobserver.cc.

◆ current()

double zyppng::ProgressObserver::current ( ) const

Definition at line 161 of file progressobserver.cc.

◆ children()

const std::vector< ProgressObserverRef > & zyppng::ProgressObserver::children ( )

Definition at line 166 of file progressobserver.cc.

◆ setLabel()

void zyppng::ProgressObserver::setLabel ( const std::string & label)

Definition at line 218 of file progressobserver.cc.

◆ label()

const std::string & zyppng::ProgressObserver::label ( ) const

Definition at line 171 of file progressobserver.cc.

◆ registerSubTask()

void zyppng::ProgressObserver::registerSubTask ( const ProgressObserverRef & child,
float weight = 1.0 )

Definition at line 258 of file progressobserver.cc.

◆ makeProgressDataReceiver()

zypp::ProgressData::ReceiverFnc zyppng::ProgressObserver::makeProgressDataReceiver ( )

Creats a new zypp::ProgressData::ReceiverFnc and links it to the current ProgressObserver, this can be used to interface with zypp code that was not yet migrated to the new ProgressObserver API.

Note
the returned zypp::ProgressData::ReceiverFnc will keep a reference to the ProgressObserver

Definition at line 289 of file progressobserver.cc.

◆ sigLabelChanged()

SignalProxy< void(ProgressObserver &, const std::string &)> zyppng::ProgressObserver::sigLabelChanged ( )

Definition at line 176 of file progressobserver.cc.

◆ sigStepsChanged()

SignalProxy< void(ProgressObserver &, double)> zyppng::ProgressObserver::sigStepsChanged ( )

Definition at line 181 of file progressobserver.cc.

◆ sigValueChanged()

SignalProxy< void(ProgressObserver &, double steps)> zyppng::ProgressObserver::sigValueChanged ( )

Definition at line 186 of file progressobserver.cc.

◆ sigProgressChanged()

SignalProxy< void(ProgressObserver &, double)> zyppng::ProgressObserver::sigProgressChanged ( )

Definition at line 191 of file progressobserver.cc.

◆ sigFinished()

SignalProxy< void(ProgressObserver &sender)> zyppng::ProgressObserver::sigFinished ( )

Definition at line 196 of file progressobserver.cc.

◆ sigNewSubprogress()

SignalProxy< void(ProgressObserver &, ProgressObserverRef)> zyppng::ProgressObserver::sigNewSubprogress ( )

Definition at line 201 of file progressobserver.cc.


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