Commit f1731c39 authored by Emmanuel Promayon's avatar Emmanuel Promayon

FIXED Viewer class documentation

parent 502eeead
......@@ -57,11 +57,15 @@ class ViewerDockStyle;
* - the embedded viewer (their widgets are inside a given layout), this is the default type
* - the docked viewer (their widgets are inside a dock widget).
*
* A viewer can embed other viewers.
* Example of viewer are: Explorer, PropertyExplorer, MedicalImageViewer.
* The type of a viewer can be changed at any time using setType(..).
* To define where is the viewer embedded or docked use setEmbedder(..) or setDockWidget(..)
*
* A viewer can be added to MainWindow, MainWindow will include its menu in the "View" menu and its toolbar in
* the application toolbar.
* A viewer can embed other viewers in its own widget.
* Example of viewer are: Explorer, PropertyExplorer, MedicalImageViewer (which embed the default InteractiveGeometryViewer
* and default InteractiveSliceViewers).
*
* A viewer can be added to MainWindow either in the dock or the central viewer (depending on its type).
* MainWindow will include its menu in the "View" menu and its toolbar in the application toolbar.
*
* The default viewed component are set so that the viewer is updated every time the current component selection
* is modified.
......@@ -71,9 +75,26 @@ class ViewerDockStyle;
* An empty list means that this viewer is going to be also notified/refreshed every time the
* current selected action is changed (i.e., anytime an action is triggered)
*
* In the application, a viewer can be
* - registered (in this case it can be used to display components and is going to be refreshed automatically)
* - unregistered (in this case it is managed separately and is not connected to the automatic refresh chain)
* In the scope of an Application, a viewer should be registered if you want to use it to display component facets.
* Registered viewers are going to be refreshed automatically when Application::refresh() is called or when a new
* top level component is opened/closed.
*
* The viewer's icon is displayed inside the dock window.
*
* Unregistered viewers are managed independently of the CamiTK Application logic. In this case it should managed separately
* and it is not connected to the automatic refresh chain. This is a special (rare) use case. If you think this is what you
* need, then you will have to programmatically/specifically manage the content of the viewer and its refresh logic.
*
* The viewer's property object can be used to manage the properties of the viewer (for instance background colors or other
* display options). (camitk-imp for instance presents the viewer properties in the setting dialog)
*
* The viewer's menu should present the properties in a QMenu to enable the user to easily modify the viewer properties
* (camitk-imp for instance shows the viewer menus in the application "View" menu)
*
* A viewer toolbar is meant to be displayed in the main window toolbar area when the viewer's widget is visible (in a Dock
* or as the central widget). The viewer toolbar is visible by default.
* If you don't want to show the viewer toolbar in your main window, even if the viewer's widget is visible,
* set its visibility to false.
*/
class CAMITK_API Viewer : public QObject {
Q_OBJECT
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment