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

Operation widget for displaying lists of toggle check boxes in a tree view.

#include <Workspace/Widgets/treeselectionwidget.h>

Inheritance diagram for TreeSelectionWidget:
[legend]

Public Slots

void widgetUpdated ()
 
- Public Slots inherited from OperationConnectionWidget
void connectToOperation (CSIRO::DataExecution::Operation *op)
 
bool hasOutstandingDataUpdateRequests () const
 
void requestUpdateData ()
 
void requestUpdateWidget ()
 

Public Member Functions

 TreeSelectionWidget (QWidget *parent=nullptr)
 
 ~TreeSelectionWidget () override
 
void updateData () override
 
void updateWidget () override
 
- Public Member Functions inherited from OperationConnectionWidget
 OperationConnectionWidget (QWidget *parent=nullptr)
 
 ~OperationConnectionWidget () override
 
virtual void updateData ()=0
 
virtual void updateWidget ()=0
 

Additional Inherited Members

- Protected Member Functions inherited from OperationConnectionWidget
virtual void connectedToOperation ()
 
DataExecution::OperationgetOperation ()
 

Constructor & Destructor Documentation

◆ TreeSelectionWidget()

TreeSelectionWidget ( QWidget *  parent = nullptr)
explicit

◆ ~TreeSelectionWidget()

~TreeSelectionWidget ( )
override

Member Function Documentation

◆ updateData()

void updateData ( )
overridevirtual

This function is called whenever the widget requests to update data via the requestUpdateData() function. Its job is to assign data from the widget to the various inputs of the attached Operation.

Note
This is the only function in which updates to the operation can take place. Assigning data to the operation in any other location is unsafe and will result in undefined behaviour. For this reason, never directly call updateData() - instead, call requestUpdateData()

Implements OperationConnectionWidget.

◆ updateWidget()

void updateWidget ( )
overridevirtual

This function is called whenever the widget is requested to be updated via a call to requestUpdateWidget(). Its job is to update the widget when the operation's data has changed. Workspace will make sure to invoke this function as needed.

Note
This is the only function in which operation data should be accessed in order to update the widget. Accessing operation data at other times is not safe and will result in undefined behaviour.

Implements OperationConnectionWidget.

◆ widgetUpdated

void widgetUpdated ( )
slot

Example slot. Connect your UI widgets to a slot like this when you need to update the operation based on changes in the UI.