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

#include <Workspace/Widgets/showwidgetbuttonconnector.h>

Inheritance diagram for ShowWidgetButtonConnector:
[legend]

Public Types

using TextFunc = std::function< QString(const DataExecution::DataObject &)>
 

Public Member Functions

 ShowWidgetButtonConnector (QWidget &widget, const NamePath &namePath, WidgetFactory &childFactory, TextFunc textFunc)
 
 ~ShowWidgetButtonConnector () override
 
void setWidgetReadOnly (bool b) override
 
- Public Member Functions inherited from QWidgetConnector
void clearAllWidgetPropertyMonitors ()
 
WidgetPropertyMonitorcreateWidgetPropertyMonitor (const QString &propertyName)
 
NamePathgetNamePath ()
 
QUuid getUuid () const
 
QWidget & getWidget ()
 
bool setAdaptorFactory (const DataExecution::TypeAdaptorFactory *adaptorFactory)
 
virtual void setWidgetReadOnly (bool b)
 

Additional Inherited Members

- Public Slots inherited from QWidgetConnector
bool hasOutstandingDataUpdateRequests () const
 
void requestUpdateData ()
 
void requestUpdateWidget ()
 
void synchronizeWithData ()
 
- Signals inherited from QWidgetConnector
void dataUpdated ()
 
- Static Public Member Functions inherited from QWidgetConnector
static QStringList connectWidgetTree (QWidget &widget, DataExecution::Operation &forOperation)
 
static QStringList connectWidgetTree (QWidget &widget, DataExecution::Operation &forOperation, const std::function< bool(QString)> &isIgnoredGlobalName)
 
static QStringList connectWidgetTree (QWidget &widget, DataExecution::Workspace &relativeTo)
 
static QStringList connectWidgetTree (QWidget &widget, DataExecution::Workspace &relativeTo, const std::function< bool(QString)> &isIgnoredGlobalName)
 
- Protected Slots inherited from QWidgetConnector
virtual void checkIfWidgetWantsUpdateTriggers ()
 
virtual void flushChanges (bool widgetWillRemainAlive=true)
 
void madeUncommittedChange ()
 
- Protected Member Functions inherited from QWidgetConnector
 QWidgetConnector (QWidget &widget, const NamePath &namePath, bool directWidgetUpdates=false)
 
 ~QWidgetConnector () override
 
void clearUncommittedChanges ()
 
template<typename T >
void commitData (const T &value)
 
bool haveUncommittedChanges () const
 
void setWantUpdateTriggers (bool b)
 

Member Typedef Documentation

◆ TextFunc

using TextFunc = std::function<QString(const DataExecution::DataObject&)>

Constructor & Destructor Documentation

◆ ShowWidgetButtonConnector()

ShowWidgetButtonConnector ( QWidget &  widget,
const NamePath namePath,
WidgetFactory childFactory,
TextFunc  textFunc 
)

◆ ~ShowWidgetButtonConnector()

Member Function Documentation

◆ setWidgetReadOnly()

void setWidgetReadOnly ( bool  b)
overridevirtual
Parameters
bToggles widget to read only model.

The Workspace editor calls this function to toggle read only behavior where modification of underlying data has no meaningful effect. Consider the scenario where a widget is attached to an Input which is connected to some other Output in a workflow. Any changes through this widget are lost when the Input is brought up to date because the data type is overwritten by data from the connected output.

The default implementation for this virtual method simply disables the entire widget. This method should be overridden for widgets that require some level of interaction in read only mode.

Reimplemented from QWidgetConnector.