Build a default widget for a given action using its Qt properties. More...
#include <ActionWidget.h>
Public Member Functions | |
ActionWidget (Action *) | |
create a default action widget for the given action More... | |
void | setAutoUpdateProperty (bool autoUpdate) |
automatically update the action properties whenever there is a change in the GUI More... | |
void | setButtonVisibility (bool) |
if false then the apply/revert buttons are shown More... | |
void | setDescriptionVisibility (bool visible) |
defines whether the description of the widget is visible or not true by default More... | |
void | setNameVisibility (bool visible) |
defines whether the name of the widget is visible or not true by default More... | |
void | update () |
update display (target and property controller) More... | |
~ActionWidget () override | |
Protected Member Functions | |
QString | getTargetLabel () |
return a text with the target component names followed by their class names More... | |
Build a default widget for a given action using its Qt properties.
It should be good enough in most of the case. The default widget contains a description, a reminder of the target component names, and an applyable/revertable ObjectController that allows you to edit/modify properties of the action.
The button frame contains an "Apply" and a "Revert" button. The Apply button updates the action properties using the value entered by the user in the GUI. I.e., its clicked() signal is connected the the action apply() slot. The revert button resets the values in GUI to the initial values (all modification in the GUI are cancelled). You can easily show or hide the button frame using setButtonVisibility()
update() updates the widget using the actual/current properties and target of the action. This method should be called by an action in the overriden getWidget method. A typical getWidget() method of an action should use the lazy instantiation pattern to instantiate ActionWidget the first time it is called, and call the ActionWidget instance update() method for any subsequent calls.
If you cannot wait for the user to click on the apply button (or if this button is hidden) and you want the value of the action's property/parameter to be updated everytime there is a change in the GUI, call setAutoUpdateProperty(true) (default is false);
camitk::ActionWidget::ActionWidget | ( | Action * | action | ) |
create a default action widget for the given action
References camitk::ObjectController::BUTTON, camitk::Action::getDescription(), camitk::Action::getIcon(), camitk::Action::getName(), getTargetLabel(), camitk::ObjectController::setObject(), and camitk::setObjectName().
|
override |
|
protected |
return a text with the target component names followed by their class names
References camitk::Component::getName(), and camitk::Action::getTargets().
Referenced by ActionWidget(), and update().
void camitk::ActionWidget::setAutoUpdateProperty | ( | bool | autoUpdate | ) |
automatically update the action properties whenever there is a change in the GUI
References camitk::ObjectController::setAutoUpdateProperty().
void camitk::ActionWidget::setButtonVisibility | ( | bool | visible | ) |
if false then the apply/revert buttons are shown
Referenced by ActionState::onEntry().
void camitk::ActionWidget::setDescriptionVisibility | ( | bool | visible | ) |
defines whether the description of the widget is visible or not true by default
void camitk::ActionWidget::setNameVisibility | ( | bool | visible | ) |
defines whether the name of the widget is visible or not true by default
void camitk::ActionWidget::update | ( | ) |
update display (target and property controller)
References getTargetLabel(), and camitk::ObjectController::setObject().
Referenced by ConnectedComponents::apply(), and OtsuFilter::apply().