Medical Imaging Interaction Toolkit  2021.10.99-ca5e1261
Medical Imaging Interaction Toolkit
berry::IPresentationSerializer Struct Referenceabstract

#include <berryIPresentationSerializer.h>

Public Member Functions

virtual QString GetId (IPresentablePart::Pointer part)=0
 
virtual IPresentablePart::Pointer GetPart (const QString &id)=0
 
virtual ~IPresentationSerializer ()
 

Detailed Description

This interface is given to a StackPresentation when it is loading or saving its state.

Not intended to be implemented by clients

Since
3.0
Note
This interface is not intended to be implemented by clients.

Definition at line 32 of file berryIPresentationSerializer.h.

Constructor & Destructor Documentation

◆ ~IPresentationSerializer()

virtual berry::IPresentationSerializer::~IPresentationSerializer ( )
virtual

Member Function Documentation

◆ GetId()

virtual QString berry::IPresentationSerializer::GetId ( IPresentablePart::Pointer  part)
pure virtual

Returns a unique identifier for the given part. The identifier can later be used to restore the original part by calling getPart(...). This identifier is guaranteed to be unique within a particular StackPresentation. However, the same part may be assigned a different ID each time the presentation is saved.

Parameters
parta part to be identified (not null)
Returns
a unique identifier for the part (not null)

◆ GetPart()

virtual IPresentablePart::Pointer berry::IPresentationSerializer::GetPart ( const QString &  id)
pure virtual

Returns a presentable part, given an id that was generated when the presentation was saved.

Parameters
idan ID that was generated by getId(IPresentablePart) when the presentation was saved
Returns
the presentable part associated with the given id, or null if none. Note that even if the ID was valid when the presentation was saved, it may not be valid when the presentation is restored. Callers must be prepared to handle a null result.

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