dataFlow.docu 1.72 KB
Newer Older
Mike Kremer's avatar
Mike Kremer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/** \page dataFlow Dataflow
 * 
 * \section quickref Quick references:
 * - \ref startup
 * - \ref loadSettings
 * - \ref saveSettings
 * - \ref updateObjects
 * - \ref updateView
 *
 * \section startup Startup process
 * 
 * Starting OpenFlipper invokes the following processes: <br><br>
 * \subsection ref1 References:
 * \ref BaseInterface::initializePlugin(),<br>\ref BaseInterface::pluginsInitialized(),<br>\ref INIInterface::loadIniFileOptions()<br>
 *
16
 * \image html OpenFlipperStartup.png
Mike Kremer's avatar
Mike Kremer committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 *
 * \section loadSettings Load settings
 *
 * Also see \ref INIInterface
 *
 * \subsection ref2 References:
 * \ref INIInterface::loadIniFileOptions(),<br>\ref INIInterface::loadIniFile(),<br>\ref INIInterface::loadIniFileOptionsLast()<br>
 *
 * \image html loadSettingsFlow.jpg
 *
 * 
 * \section saveSettings Save settings
 *
 * Also see \ref INIInterface
 *
 * \subsection ref3 References:
 * \ref INIInterface::saveIniFileOptions(),<br>\ref INIInterface::saveIniFile(),<br>
 * \image html saveSettingsFlow.jpg
 *
 *
 * \section updateObjects Update objects
 *
 * Each time an object has been modified by a plugin, the plugin has to emit the
 * signal BaseInterface::updatedObject() in order to initiate the core to inform
 * all other plugins about the changes and redraw the scene.
 *
 * Also see \ref BaseInterface
 *
 * \subsection ref4 References:
 * \ref BaseInterface::updatedObject(),<br>\ref BaseInterface::slotObjectUpdated(),<br>
 * \image html updateObject.jpg
 *
 *
 * \section updateView Update view
 *
 * A plugin can provoke a redraw of the scene by emitting the signal BaseInterface::updateView().
 *
 * Also see \ref BaseInterface
 *
 * \subsection ref5 References:
 * \ref BaseInterface::updateView(),<br>
 * \image html updateView.jpg
 *
 */