Skip to content
Snippets Groups Projects
Commit fedac2d8 authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

compact class comment

parent f0291f3a
No related branches found
No related tags found
1 merge request!2364rename SelectionProperty -> PolyItem
......@@ -17,27 +17,8 @@
#include "GUI/Support/XML/UtilXML.h"
//! Class for representing a selection, its attributes and its accessors.
//!
//! A "selection" in this context is a class instance out of a range of possible class instances.
//!
//! Example:
//! A distribution can be represented by DistributionGateItem, DistributionLorentzItem and more. The
//! common base class is DistributionItem. To store the currently distribution, you may use a member
//! of DistributionItem* which holds an instance of the currently selected distribution (e.g.
//! DistributionGateItem*). To select between distributions, you need a combo box filled with the
//! distribution names, a label for the combo box, and so on.
//!
//! This class provides many of these attributes and functionalities:
//! * A pointer to the common base class (given as the template argument T). The lifetime of this
//! pointer is handled in here.
//! * label: a label of e.g. a spin box
//! * tooltip: tooltip for e.g. a spin box
//! * a list of available options (e.g. the names of the distributions)
//! * setters and getters
//!
//! The initialization of a PolyItem is done using a catalog.
//!
//! Holds a polymorphous item. Possible types of the item are specified by a Catalog.
template <typename Catalog> class PolyItem {
public:
using CatalogedType = typename Catalog::CatalogedType;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment