IlsMvComponent::RepresentationListener

Category

Dynamic view-related, nested enumerated type (component and server)

Description

This nested class is the interface of a representation listener that can be registered to the component. A representation listener allows you to be notified when a representation is created (that is, when a dynamic view has been opened on the server) without subclassing IlsMvComponent. Refer to the documentation of the corresponding methods of IlsMvComponent and IlsRepresentation for more information on when these events occur and on the arguments that must be passed.

This class should be derived and its methods overridden.

Use the virtual member functions IlsMvComponent::addRepresentationListener and IlsMvComponent::removeRepresentationListener to add or remove your own listeners.

Libraries

Header File

#include <ilserver/mvcomp.h>

Synopsis

class RepresentationListener {

virtual void onCreateRepresentation

(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

virtual void onRepresentationCreated

(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

virtual void onCloseRepresentation

(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc)

virtual void onDeleteRepresentation

(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

};

Member Functions

[virtual] void onCreateRepresentation(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

This virtual member function is called while the member function IlsRepresentation::onCreation is executed.

[virtual] void onRepresentationCreated(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

This virtual member function is called at the end of the initial notification transaction when all the IlsRpObject instances have been created.

[virtual] void onCloseRepresentation(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc);

This virtual member function is called when the user has called IlsRepresentation::close on the representation.

[virtual] void onDeleteRepresentation(IlsRepresentation& repres,

const IlsMvValue* ackArgv,

IlsCbArgNb ackArgc)

This virtual member function is called when the representation is being deleted.