ISelectionMessage Class Reference

#include <ISelectionMessages.h>

Public Types
enum	SelectionMessageType { kSelectionChanged, kSelectionAttributeChanged, kSelectionChanged_Frequent }

Public Member Functions
virtual SelectionMessageType	GetMessageType (void) const =0
virtual bool16	WasSuiteAffected (const PMIID &) const =0
virtual SelectionSuiteData *	GetSuiteBroadcastData (const PMIID &) const =0
virtual SuiteBroadcastData *	GetSuiteBroadcastDataList (void)=0

Detailed Description

This is the void* for kClientMessage. It is used when the selection or a selection attribute has changed. The suite on the CSB broadcasts the change and the ASB responds by broadcasting to the client code.

Member Function Documentation

virtual SelectionMessageType ISelectionMessage::GetMessageType ( void  ) const

pure virtual

Return the message type of this message.

virtual SelectionSuiteData* ISelectionMessage::GetSuiteBroadcastData ( const PMIID &  ) const

pure virtual

Return the Suite data associated with this broadcast.

Used by the kSelectionAttributeChanged message.

Proprietary suite message (based on SelectionSuiteData)

virtual SuiteBroadcastData* ISelectionMessage::GetSuiteBroadcastDataList ( void  )

pure virtual

    Return the list of SuiteBroadcastData.



    Used by the IInternalSelectionMessage.

        DO NOT access the SuiteBroadcastData* directly.

List of suite IID and Proprietary suite message pairs

virtual bool16 ISelectionMessage::WasSuiteAffected ( const PMIID &  ) const

pure virtual

Was the suite affected by the change that caused this broadcast?



Used by the kSelectionAttributeChanged message.

kTrue / kFalse