| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Copyright (C) 2014 Frederik Heber. All rights reserved.
|
|---|
| 6 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 7 | */
|
|---|
| 8 |
|
|---|
| 9 | /**
|
|---|
| 10 | * \file actions.dox
|
|---|
| 11 | *
|
|---|
| 12 | * Created on: Oct 28, 2011
|
|---|
| 13 | * Author: heber
|
|---|
| 14 | */
|
|---|
| 15 |
|
|---|
| 16 | /** \page actions Actions
|
|---|
| 17 | *
|
|---|
| 18 | * \link MoleCuilder::Action Actions \endlink are Command patterns
|
|---|
| 19 | * (http://en.wikipedia.org/wiki/Command_pattern)
|
|---|
| 20 | * to allow for undoing and redoing. Each specific Action derives from this
|
|---|
| 21 | * class to implement a certain functionality. There is a lot of preprocessor
|
|---|
| 22 | * magic implemented for making this as easy as possible. In effect you only
|
|---|
| 23 | * have to create three files of which only one actually contains more than a
|
|---|
| 24 | * few lines, namely the code of the Action itself.
|
|---|
| 25 | * Each Action also derives a specific ActionState and ActionParameters for
|
|---|
| 26 | * containing the undo/redo state information and the parameters steering what
|
|---|
| 27 | * the Action does.
|
|---|
| 28 | *
|
|---|
| 29 | * Each Action has thus three types of functionality: do, undo, and redo. And
|
|---|
| 30 | * each action has a unique \a token: a name without white space that is
|
|---|
| 31 | * descriptive.
|
|---|
| 32 | *
|
|---|
| 33 | * The ActionRegistry contains a prototype of each Action under its token.
|
|---|
| 34 | * If an Action is requested via its known token from the ActionQueue
|
|---|
| 35 | * (that contains the ActionRegistry), this prototype is cloned and added to the
|
|---|
| 36 | * queue.
|
|---|
| 37 | *
|
|---|
| 38 | * Each Action can contain multiple \ref parameters in its specific
|
|---|
| 39 | * ActionParameters structure that represent the options. Executing call() first
|
|---|
| 40 | * fills a dialog with \ref queries, one for each option. The UI then tries to
|
|---|
| 41 | * obtain the values from the user. Depending on the type of the UI in use that
|
|---|
| 42 | * could mean parsing stored command line parameters or displaying a real dialog
|
|---|
| 43 | * box with widgets.
|
|---|
| 44 | *
|
|---|
| 45 | * Also there is a regression test (\ref regression-test) for each Action to
|
|---|
| 46 | * check that it always behaves the same no matter how much the code
|
|---|
| 47 | * implementing actually has changed. In most cases also for testing undo and
|
|---|
| 48 | * redo.
|
|---|
| 49 | *
|
|---|
| 50 | * \section actions-add To add a new action ...
|
|---|
| 51 | *
|
|---|
| 52 | * The following steps have to be done for adding a new action:
|
|---|
| 53 | * -# Create three new files .cpp, .def, and .hpp
|
|---|
| 54 | * -# Add the files to \b src/Actions/Makefile.am.
|
|---|
| 55 | * -# Add the name of the Action to \b src/Actions/GlobalListOfActions.hpp
|
|---|
| 56 | * such that the ActionRegistry knows about it and can instantiate a
|
|---|
| 57 | * prototype.
|
|---|
| 58 | *
|
|---|
| 59 | * \section actions-undo-redo Undoing and Redoing actions ...
|
|---|
| 60 | *
|
|---|
| 61 | * The central points of Actions is that they can be undone and redone. This
|
|---|
| 62 | * has to be implemented in two more functions beside the "do" in performCall().
|
|---|
| 63 | *
|
|---|
| 64 | * Note that undoing means to get everything back to its original state and by whatever
|
|---|
| 65 | * means seem appropriate, e.g. remvoing all just inserted atoms.
|
|---|
| 66 | * To make this more elaborate it is usually very useful to store extra information
|
|---|
| 67 | * in the Action's state such that undo and redo can be accomplished more quickly.
|
|---|
| 68 | * E.g. if your Action creates some new atoms, store their info as \ref AtomicInfo.
|
|---|
| 69 | * Then, undo can simply delete the newly created atoms and redo can quickly re-
|
|---|
| 70 | * create them in the state they have been before. Types required for storage are
|
|---|
| 71 | * contained in the Action's state and are filled during performCall(). Undo and
|
|---|
| 72 | * redo both get access to this state and may use the information as described.
|
|---|
| 73 | *
|
|---|
| 74 | * Have a look at \ref UndoRedoHelpers.hpp for some helper functions on this.
|
|---|
| 75 | *
|
|---|
| 76 | * \section actions-further Further information
|
|---|
| 77 | *
|
|---|
| 78 | * If you want know:
|
|---|
| 79 | * -# how the code knows about the valid tokens for actions and options and how
|
|---|
| 80 | * they are constructed, see \ref MoleCuilder::Action .
|
|---|
| 81 | *
|
|---|
| 82 | *
|
|---|
| 83 | * \date 2014-03-10
|
|---|
| 84 | *
|
|---|
| 85 | */
|
|---|
