The DeclarativeItem class is the base class for all items that use the declarative API for visualizations. More...
Inheritance diagram for Visualization::DeclarativeItem< VisualizationType >:
Public Types | |
| using | I = VisualizationType |
 Public Types inherited from Visualization::DeclarativeItemBase | |
| typedef DeclarativeItemBaseStyle | StyleType |
Public Member Functions | |
| DeclarativeItem (Item *parent, const StyleType *style=itemStyles().get()) | |
| virtual | ~DeclarativeItem () |
| virtual QList< FormElement * > & | forms () const override |
| Returns the list of forms available for this declarative item type. More... | |
| virtual QList< QList< FormElement * > > & | shapeElements () const override |
| Returns the a list of shape elements per form for this declarative item type. More... | |
| Public Member Functions inherited from Visualization::DeclarativeItemBase | |
| DeclarativeItemBase (Item *parent, const StyleType *style=itemStyles().get()) | |
| virtual | ~DeclarativeItemBase () |
| virtual QList< Visualization::VisualizationAddOn * > | addOns () override |
| FormElement * | currentForm () const |
| Returns the form at the index from the cached result of determineForm. More... | |
| int | currentFormIndex () const |
| Returns the index of the current form. More... | |
| QList< FormElement * > | currentShapeElements () const |
| Returns the list of shape elements belonging to the current form (the same index as returned by determineForm). More... | |
| virtual void | determineChildren () override |
| virtual int | determineForm () |
| Returns the index of the form to use for the current state of the declarative item. More... | |
| virtual Visualization::InteractionHandler * | handler () const override |
| virtual bool | isEmpty () const override |
| virtual QList< ItemRegion > | regions () override |
| virtual void | setStyle (const Visualization::ItemStyle *itemStyle) override |
| virtual bool | sizeDependsOnParent () const override |
| const StyleType * | style () const |
| virtual void | updateGeometry (int availableWidth, int availableHeight) override |
Static Protected Member Functions | |
| template<typename ElementType > | |
| static ElementType * | addForm (ElementType *element) |
| Add element to the list of forms. More... | |
| static QList< FormElement * > & | formsStatic () |
| Static vertion of the method forms, returning the list of forms for this declarative item type. More... | |
| template<typename ChildItemVisualizationType > | |
| static VisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType, true > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage) |
| A factory method to get an item wrapper element with a visualization only, it takes a pointer to member, where the visualization itemStorage should be stored, and a method to get the style (styleGetter) with which the itemStorage should be created. More... | |
| template<typename ChildItemVisualizationType , typename ParentStyleType , typename ParentNodeType , typename ParentNodeSubType > | |
| static NodeWithVisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage, ParentNodeSubType *(ParentNodeType::*nodePointer)(), Style::Property< typename ChildItemVisualizationType::StyleType > ParentStyleType::*stylePointer) |
| template<typename ChildItemVisualizationType > | |
| static VisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType, false > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage, std::function< const typename ChildItemVisualizationType::StyleType *(VisualizationType *v)> styleGetter) |
| template<typename ChildItemVisualizationType > | |
| static NodeWithVisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage, std::function< typename ChildItemVisualizationType::NodeType *(VisualizationType *v)> nodeGetter, std::function< const typename ChildItemVisualizationType::StyleType *(VisualizationType *v)> styleGetter) |
| A factory method to get an item wrapper element with a node and a visualization, it takes a pointer to member, where the visualization itemStorage should be stored, a method to get the style (styleGetter), and a method to get the node (nodeGetter). More... | |
| template<typename ChildItemVisualizationType , typename ParentStyleType > | |
| static NodeWithVisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage, std::function< typename ChildItemVisualizationType::NodeType *(VisualizationType *v)> nodeGetter, Style::Property< typename ChildItemVisualizationType::StyleType > ParentStyleType::*stylePointer) |
| template<typename ChildItemVisualizationType , typename ParentStyleType > | |
| static VisualizationItemWrapperFormElement< VisualizationType, ChildItemVisualizationType, false > * | item (ChildItemVisualizationType *VisualizationType::*itemStorage, Style::Property< typename ChildItemVisualizationType::StyleType > ParentStyleType::*stylePointer) |
| static NodeItemWrapperFormElement< VisualizationType > * | item (Item *VisualizationType::*itemStorage, std::function< Model::Node *(VisualizationType *v)> nodeGetter) |
| A factory method to get an item wrapper element with a node only, it takes a pointer to member, where the visualization itemStorage should be stored, and a method to get the node (nodeGetter) with which the itemStorage should be associated. More... | |
| static QList< QList< FormElement * > > & | shapeElementsStatic () |
| Static version of the method shapeElements, returning the list of shape element lists for each form. More... | |
| Static Protected Member Functions inherited from Visualization::DeclarativeItemBase | |
| static GridLayoutFormElement * | grid (QList< QList< Merge >> elements) |
| Creates a grid layout. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Visualization::DeclarativeItemBase | |
| static void | addAddOn (Visualization::VisualizationAddOn *addOn) |
| static Visualization::InteractionHandler * | defaultClassHandler () |
| static Visualization::StyleSet< DeclarativeItemBase > & | itemStyles () |
| static bool | removeAddOn (Visualization::VisualizationAddOn *addOn) |
| static void | setDefaultClassHandler (Visualization::InteractionHandler *handler) |
| Protected Types inherited from Core::Reflect< Base > | |
| using | Super = Reflect< Base > |
Detailed Description
template<typename VisualizationType>
class Visualization::DeclarativeItem< VisualizationType >
The DeclarativeItem class is the base class for all items that use the declarative API for visualizations.
It is a template class, such that every descendant visualization type has its own static list of available forms.
To use the declarative API, one needs to inherit from DeclarativeItem, and implement a static method initializeForms in which the list of forms and their properties is set up.
Member Typedef Documentation
◆ I
template<typename VisualizationType >
| using Visualization::DeclarativeItem< VisualizationType >::I = VisualizationType |
Constructor & Destructor Documentation
◆ DeclarativeItem()
template<typename VisualizationType >
| Visualization::DeclarativeItem< VisualizationType >::DeclarativeItem | ( | Item * | parent, |
| const StyleType * | style = itemStyles().get() |
||
| ) |
◆ ~DeclarativeItem()
template<typename VisualizationType >
|
virtual |
Member Function Documentation
◆ addForm()
template<typename VisualizationType >
template<typename ElementType >
|
staticprotected |
Add element to the list of forms.
All the forms should be added via this method inside the static method initializeForms.
If element is already a form root element or has a parent, then it is cloned and its clone is added to the list.
Returns a pointer to the added element.
◆ forms()
template<typename VisualizationType >
|
overridevirtual |
Returns the list of forms available for this declarative item type.
Implements Visualization::DeclarativeItemBase.
◆ formsStatic()
template<typename VisualizationType >
|
staticprotected |
Static vertion of the method forms, returning the list of forms for this declarative item type.
◆ item() [1/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType >
|
staticprotected |
A factory method to get an item wrapper element with a visualization only, it takes a pointer to member, where the visualization itemStorage should be stored, and a method to get the style (styleGetter) with which the itemStorage should be created.
To call it, one has to supply the visualization type and the parent type (which is always 'I') as the template arguments.
◆ item() [2/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType , typename ParentStyleType , typename ParentNodeType , typename ParentNodeSubType >
|
staticprotected |
◆ item() [3/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType >
|
staticprotected |
◆ item() [4/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType >
|
staticprotected |
A factory method to get an item wrapper element with a node and a visualization, it takes a pointer to member, where the visualization itemStorage should be stored, a method to get the style (styleGetter), and a method to get the node (nodeGetter).
The node then gets visualized using the given visualization and style. To call it, one has to supply the visualization type and the parent type (which is always 'I') as template arguments.
◆ item() [5/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType , typename ParentStyleType >
|
staticprotected |
◆ item() [6/7]
template<typename VisualizationType >
template<typename ChildItemVisualizationType , typename ParentStyleType >
|
staticprotected |
◆ item() [7/7]
template<typename VisualizationType >
|
staticprotected |
A factory method to get an item wrapper element with a node only, it takes a pointer to member, where the visualization itemStorage should be stored, and a method to get the node (nodeGetter) with which the itemStorage should be associated.
The node gets visualized with its default style.
NOTE: Introducing the ChildItemVisualizationType template argument will require ChildItemVisualizationType::NodeType, which Item does not have, and thus Item cannot be the default!
◆ shapeElements()
template<typename VisualizationType >
|
overridevirtual |
Returns the a list of shape elements per form for this declarative item type.
Those lists are determined from the list of forms.
Implements Visualization::DeclarativeItemBase.
◆ shapeElementsStatic()
template<typename VisualizationType >
|
staticprotected |
Static version of the method shapeElements, returning the list of shape element lists for each form.
