ISetSpreadCommandData Class Reference

#include <ISetSpreadCommandData.h>

Inheritance diagram for ISetSpreadCommandData:

Public Types
enum	{ kDefaultIID = IID_ISETSPREADCOMMANDDATA }
enum	MessageFlags {   kActiveSpread_InitializationType = 0x0000, kActiveSpread_SpreadToSpreadType = 0x0001, kActiveSpread_MasterToMasterType = 0x0002, kActiveSpread_MasterToSpreadType = 0x0004,   kActiveSpread_SpreadToMasterType = 0x0004, kActiveSpread_SetPageType = 0x0008 }

Public Member Functions
virtual void	Set (bool16 bDeselect, bool16 bWithinSetPageCmd=kFalse)=0
virtual bool16	GetDeselect (void) const =0
virtual bool16	GetWithinSetPageCmd (void) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Command data interface for the kSetSpreadCmdBoss. The command data controls whether to deselect all items when executing this command. All items that are selected in the layout suite (ILayoutSelectionSuite) will be deselected.

See Also

kSetSpreadCmdBoss

Member Enumeration Documentation

enum ISetSpreadCommandData::MessageFlags

Further defines the IID_IACTIVESPREAD submessage broadcast in an int32 lazy cookie on IID_IACTIVESPREAD protocol. May be retrieved in a LazyUpdate method for observers of the IID_IACTIVESPREAD protocol (Layout window subject). For example, taken from a LazyUpdate observer method: case IID_IACTIVESPREAD: { int32 spreadChangedMessage = ISetSpreadCommandData::kActiveSpread_SpreadToSpreadType; const ListLazyNotificationData<int32>* pListCookie = static_cast<const ListLazyNotificationData<int32>* > (data); if (pListCookie) { K2Vector<int32> itemsChanged; pListCookie->BreakoutChanges (nil, nil, &itemsChanged); for (int32 n = 0; n < itemsChanged.size (); n++) spreadChangedMessage |= itemsChanged[n]; } } This replaces the now obsolete IChangedSpreadKindData.h interface, which has been removed for CS3.

Enumerator
kActiveSpread_InitializationType	Specifies active spread changed during initialization, no previous spread.
kActiveSpread_SpreadToSpreadType	Specifies active spread changed from spread to spread.
kActiveSpread_MasterToMasterType	Specifies active spread changed from master to master spread.
kActiveSpread_MasterToSpreadType	Specifies active spread changed from master to spread or spread to master.
kActiveSpread_SpreadToMasterType	Same as above, just a synonym.
kActiveSpread_SetPageType	Specifies active spread from within a set page command. Can appear with other flag values.

Member Function Documentation

virtual bool16 ISetSpreadCommandData::GetDeselect ( void  ) const

pure virtual

Deselect - returns the value of the command data bDeselect parameter.

Returns

bool16 - kTrue to deselect, kFalse to leave selection alone.

virtual bool16 ISetSpreadCommandData::GetWithinSetPageCmd ( void  ) const

pure virtual

SetPage - returns the value of the command data bWithinSetPage parameter.

Returns

bool16 - kTrue if the SetSpreadCmd has been processed within (or by) a SetPageCmd, kFalse if SetSpreadCmd is executing by itself.

virtual void ISetSpreadCommandData::Set ( bool16  bDeselect, bool16  bWithinSetPageCmd = kFalse  )

pure virtual

Set - Sets the value of the command data. All items that are selected in the layout suite (ILayoutSelectionSuite) will be deselected when set to kTrue.

Parameters

bool16	- kTrue (kDeselect) to deselect, kFalse (kDontDeselect) to leave selection alone.
bool16	- kTrue if the SetSpreadCmd has been processed within (or by) a SetPageCmd, kFalse if SetSpreadCmd is executing by itself.