|
virtual bool | validate (Core::ActionContextHandle &context) |
|
virtual bool | run (Core::ActionContextHandle &context, Core::ActionResultHandle &result) |
|
virtual ActionInfoHandle | get_action_info () const =0 |
|
std::string | get_definition () const |
| Get the definition of the action (in XML format)
|
|
std::string | get_type () const |
| Get the type of the action.
|
|
std::string | get_usage () const |
| Get a usage description.
|
|
std::string | get_key (size_t index) const |
| Get the name of the key with a certain index.
|
|
std::string | get_default_key_value (size_t index) const |
| Get the name of the key with a certain index.
|
|
int | get_key_index (const std::string &name) const |
| Get the index of a certain key.
|
|
bool | is_undoable () const |
| Check whether the action is undoable.
|
|
virtual bool | changes_project_data () |
|
virtual bool | translate (ActionContextHandle &context) |
|
virtual void | clear_cache () |
|
std::string | export_to_string () const |
|
bool | import_from_string (const std::string &action, std::string &error) |
|
bool | import_from_string (const std::string &action) |
| Same as function above, but without the error report.
|
|
bool Seg3D::ActionReportScriptStatus::run |
( |
Core::ActionContextHandle & |
context, |
|
|
Core::ActionResultHandle & |
result |
|
) |
| |
|
virtual |
Each action needs to have this piece implemented. It spells out how the action is run. It returns whether the action was successful or not. NOTE: In case of an asynchronous action, the return value is ignored and the program relies on report_done() from the context to be triggered when the asynchronous part has finished. In any other case the ActionDispatcher will issue the report_done() when run returns.
Implements Core::Action.
bool Seg3D::ActionReportScriptStatus::validate |
( |
Core::ActionContextHandle & |
context | ) |
|
|
virtual |
Each action needs to be validated just before it is posted. This way we enforce that every action that hits the main post_action signal will be a valid action to execute. NOTE: This function is not const and may alter the values of the parameters and correct faulty input. Run on the other hand is not allowed to change anything in the action, as it is posted to any observers after the action is validated.
Implements Core::Action.
The documentation for this class was generated from the following files: