InformationDockElementStrategy Class Reference

A base class for strategies for the InformationDock to show information about a TimedElement. More...

#include <InformationDockElementStrategy.hpp>

Inheritance diagram for InformationDockElementStrategy:

Public Member Functions
virtual void	setup (QFormLayout *)
	Sets up the QFormLayout. More...
virtual bool	update (QFormLayout *, TimedElement *)
	Updates the view to show details about a newly selected element. More...
virtual std::string	title ()
	Returns the title the information dock should show. More...

Detailed Description

A base class for strategies for the InformationDock to show information about a TimedElement.

Definition at line 28 of file InformationDockElementStrategy.hpp.

Member Function Documentation

setup()

virtual void InformationDockElementStrategy::setup ( QFormLayout *  )

inlinevirtual

Sets up the QFormLayout.

In derived classes this function should be overwritten and fields and rows should be added to the form layout.

Parameters

layout

The layout of the detailed window pane

Reimplemented in InformationDockCollectiveCommunicationStrategy, InformationDockCommunicationStrategy, InformationDockElementBaseStrategy< T >, InformationDockElementBaseStrategy< CollectiveCommunicationEvent >, InformationDockElementBaseStrategy< Communication >, InformationDockElementBaseStrategy< Slot >, InformationDockElementBaseStrategy< Trace >, and InformationDockSlotStrategy.

Definition at line 37 of file InformationDockElementStrategy.hpp.

title()

virtual std::string InformationDockElementStrategy::title ( )

inlinevirtual

Returns the title the information dock should show.

Returns

The title for the information dock should show

Reimplemented in InformationDockCollectiveCommunicationStrategy, InformationDockCommunicationStrategy, InformationDockElementBaseStrategy< T >, InformationDockElementBaseStrategy< CollectiveCommunicationEvent >, InformationDockElementBaseStrategy< Communication >, InformationDockElementBaseStrategy< Slot >, InformationDockElementBaseStrategy< Trace >, InformationDockSlotStrategy, and InformationDockTraceStrategy.

Definition at line 57 of file InformationDockElementStrategy.hpp.

update()

virtual bool InformationDockElementStrategy::update ( QFormLayout *  , TimedElement *    )

inlinevirtual

Updates the view to show details about a newly selected element.

In derived classes this function should be overwritten and update the fields initialized in the setup call. If the strategy cannot handle the newly selected element it should reject the update by returning false. If it does so it should not change the form layout or the selected element.

Parameters

layout	The layout of the detailed window pane
element	The newly selected element

Returns

Whether the strategy can handle the selected item and has performed an update.

Reimplemented in InformationDockElementBaseStrategy< T >, InformationDockElementBaseStrategy< CollectiveCommunicationEvent >, InformationDockElementBaseStrategy< Communication >, InformationDockElementBaseStrategy< Slot >, and InformationDockElementBaseStrategy< Trace >.

Definition at line 51 of file InformationDockElementStrategy.hpp.

---

The documentation for this class was generated from the following file:

• src/ui/widgets/infostrategies/InformationDockElementStrategy.hpp