iberbox  2.1.1
iberbox::BlockingActionListener Class Reference

The Blocking Action Listener class. More...

Inheritance diagram for iberbox::BlockingActionListener:
Collaboration diagram for iberbox::BlockingActionListener:

Public Member Functions

 BlockingActionListener ()
 Constructs a new Blocking Action Listener object. More...
 
Action getResult ()
 Gets the finished action. More...
 
virtual void onActionFinish (Action action) override
 The method that will be executed when the action finishes. More...
 
virtual void onActionProgress (Action action) override
 The method that will be executed when the action's progress changes. More...
 
virtual void setOwnership (bool external_or_cpp) override
 Sets the Ownership object. More...
 
virtual ~BlockingActionListener () override
 Destroys the Blocking Action Listener object. More...
 
- Public Member Functions inherited from iberbox::ActionListener
 ActionListener ()
 Constructs a new Action Listener object. More...
 
 ActionListener (std::function< void(Action)> finishCallback)
 Constructs a new Action Listener object. More...
 
 ActionListener (std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
 ActionListener (std::function< void(Action)> errorCallback, std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
 ActionListener (std::function< void(Action)> startCallback, std::function< void(Action)> errorCallback, std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
virtual void onActionError (Action action)
 The method that will be executed when an error occurs within the action. More...
 
virtual void onActionProcessed (Action action)
 The method that will be executed when the action has been processed. More...
 
virtual void onActionStart (Action action)
 The method that will be executed when the action starts. More...
 
void setErrorCallback (std::function< void(Action)> errorCallback)
 
void setFinishCallback (std::function< void(Action)> finishCallback)
 
void setProgressCallback (std::function< void(Action)> progressCallback)
 
void setStartCallback (std::function< void(Action)> startCallback)
 
virtual ~ActionListener ()
 

Detailed Description

The Blocking Action Listener class.

Constructor & Destructor Documentation

◆ BlockingActionListener()

iberbox::BlockingActionListener::BlockingActionListener ( )

Constructs a new Blocking Action Listener object.

◆ ~BlockingActionListener()

virtual iberbox::BlockingActionListener::~BlockingActionListener ( )
overridevirtual

Destroys the Blocking Action Listener object.

Member Function Documentation

◆ getResult()

Action iberbox::BlockingActionListener::getResult ( )

Gets the finished action.

Returns
The finished action.

◆ onActionFinish()

virtual void iberbox::BlockingActionListener::onActionFinish ( Action  action)
overridevirtual

The method that will be executed when the action finishes.

Parameters
actionThe finished action.

Reimplemented from iberbox::ActionListener.

◆ onActionProgress()

virtual void iberbox::BlockingActionListener::onActionProgress ( Action  action)
overridevirtual

The method that will be executed when the action's progress changes.

Parameters
actionThe action whose progress has changed.

Reimplemented from iberbox::ActionListener.

◆ setOwnership()

virtual void iberbox::BlockingActionListener::setOwnership ( bool  external_or_cpp)
overridevirtual

Sets the Ownership object.

Parameters
external_or_cpp

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