MT Showcase SDK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Showcase::RootInstance Class Reference

This class contains the implementation for the root component of Showcase. More...

#include <RootComponent.hpp>

Inheritance diagram for Showcase::RootInstance:
Showcase::UIComponentInstance Showcase::ComponentInstance

Public Member Functions

 RootInstance (ComponentPtr component)
 
virtual void componentAddedToSlot (const QByteArray &slotName, std::shared_ptr< Component > comp) override
 Called when another component is added to a slot of this component. More...
 
- Public Member Functions inherited from Showcase::UIComponentInstance
 UIComponentInstance (std::shared_ptr< Component > component)
 Create a new instance from the given component. More...
 
virtual void setContent (const QByteArray &slotName, std::shared_ptr< ContentNode > content)
 Set a new content set for this instance. More...
 
virtual void removeContent (const QByteArray &slotName, std::shared_ptr< ContentNode > content)
 Remove content set from this instance. More...
 
virtual void contentNodeFound (std::shared_ptr< ContentNode > node, std::shared_ptr< ContentNode > parent=nullptr)
 Called when a new content node is found in a content graph. More...
 
virtual void contentNodeLost (std::shared_ptr< ContentNode > node, std::shared_ptr< ContentNode > parent=nullptr)
 Called when a content node is lost. More...
 
virtual void contentNodeLostProperty (std::shared_ptr< ContentNode > contentNode, const Property &prop)
 Called when a content node has lost a property. More...
 
virtual void contentNodeReceivedProperty (std::shared_ptr< ContentNode > contentNode, const Property &prop)
 Called when a content node has found a property. More...
 
virtual void componentRemovedFromSlot (const QByteArray &slotName, std::shared_ptr< Component > comp)
 Called when another component is removed from a slot of this component. More...
 
- Public Member Functions inherited from Showcase::ComponentInstance
 ComponentInstance (std::shared_ptr< Component > component)
 Create a new instance from the given component. More...
 
virtual ~ComponentInstance ()
 Each subclass needs to do needed clean up in their own destructors (should be enough to call removeInstance) More...
 
virtual MultiWidgets::WidgetPtr widgetInstance ()
 After first call of this, user of the component is required to keep track of the widget. More...
 
virtual MultiWidgets::OperatorPtr operatorInstance (MultiWidgets::Widget &host, bool immediate=false)
 Assigns the operator to the given widget. More...
 
std::shared_ptr< Componentcreator () const
 An instance is always tied to a component and can't exist without the component that created it. More...
 
virtual void propertyReceived (const PropertyKey &key, const PropertyValue &value)
 Called for each property found for the creator component This function may be called same time from multiple threads. More...
 
virtual void propertyLost (const PropertyKey &key, const PropertyValue &value)
 Called when a property is unset for the component This function may be called same time from multiple threads. More...
 

Protected Member Functions

virtual void removeInstance () override
 Allows removing component instance when the component is removed. More...
 

Detailed Description

This class contains the implementation for the root component of Showcase.

Root component only assigns components into its slots (background, overlay, menu, main and content-viewer)

Constructor & Destructor Documentation

Showcase::RootInstance::RootInstance ( ComponentPtr  component)

Member Function Documentation

void Showcase::RootInstance::componentAddedToSlot ( const QByteArray &  slotName,
std::shared_ptr< Component comp 
)
overridevirtual

Called when another component is added to a slot of this component.

This is meant for overriding, default implementation does nothing

Parameters
slotNamename of the slot
compthe added component

Reimplemented from Showcase::UIComponentInstance.

void Showcase::RootInstance::removeInstance ( )
overrideprotectedvirtual

Allows removing component instance when the component is removed.

Implementations must not call instanceDestroyed of the associated component

Reimplemented from Showcase::UIComponentInstance.