Workspace 6.21.5
Public Member Functions | List of all members
OperationLabelChangeEvent Class Reference

Event raised when an operation's label is changed. More...

#include <Workspace/DataExecution/Operations/operationevents.h>

Inheritance diagram for OperationLabelChangeEvent:
[legend]

Public Member Functions

 OperationLabelChangeEvent (Operation &op, const QString &oldLabel)
 
const QString & getNewLabel () const
 
const QString & getOldLabel () const
 
OperationgetOperation () const
 
- Public Member Functions inherited from ObservableEventType< OperationLabelChangeEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > & eventID ()
 
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > & eventID ()
 
const EventIDSingleton< OperationLabelChangeEvent > & getEventID () const override
 
- Public Member Functions inherited from ObservableEvent
virtual ~ObservableEvent ()=default
 
virtual const EventIDgetEventID () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from ObservableEventType< OperationLabelChangeEvent >
static const EventIDSingleton< OperationLabelChangeEvent > & eventID ()
 
- Protected Member Functions inherited from ObservableEventType< OperationLabelChangeEvent >
 ObservableEventType ()=default
 

Detailed Description

The new label is available via the getNewLabel() function. It will be identical to calling getOperation().getLabel() and is provided for convenience only.

Constructor & Destructor Documentation

◆ OperationLabelChangeEvent()

OperationLabelChangeEvent ( Operation op,
const QString &  oldLabel 
)
inline

Member Function Documentation

◆ getNewLabel()

const QString & getNewLabel ( ) const
Returns
The new label for the operation.

This function is entirely equivalent to calling getOperation().getLabel(). It is provided merely as a convenience.

◆ getOldLabel()

const QString & getOldLabel ( ) const
inline
Returns
The previous label for the operation before the change.

◆ getOperation()

Operation & getOperation ( ) const
inline
Returns
The Operation whose label was changed.