InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISelectionSnapshotSuite Class Referenceabstract

#include <ISelectionSnapshotSuite.h>

Inheritance diagram for ISelectionSnapshotSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISELECTIONSNAPSHOTSUITE }
 

Public Member Functions

virtual SelectionSnapshotDataCreateSnapshot ()=0
 
virtual void CreateSnapshot (IPMUnknown *targetingBoss)=0
 
virtual void RestoreSelection (SelectionSnapshotData *theSS, IControlView *, bool16 bDrawSel, bool16 autoScroll=kTrue)=0
 
virtual bool16 SelectionIsEmpty (SelectionSnapshotData *theSS)=0
 
virtual bool16 SelectionIsValid (SelectionSnapshotData *theSS, UIDRef activeSpreadRef)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Defines the interface for a selection snapshot to be used for restoring the selection, typically after Undo.

See Also
SelectionSnapshotData

Member Function Documentation

virtual SelectionSnapshotData* ISelectionSnapshotSuite::CreateSnapshot ()
pure virtual

Create the appropriate snapshot and return a pointer to it.

Returns
pointer to the SelectionSnapshotData item created.
virtual void ISelectionSnapshotSuite::CreateSnapshot (IPMUnknowntargetingBoss)
pure virtual

Copy selection data from this to another selection target boss.

Parameters
targetingBossIN an interface pointer on the boss to receive this target's selection data.
virtual void ISelectionSnapshotSuite::RestoreSelection (SelectionSnapshotDatatheSS,
IControlView,
bool16 bDrawSel,
bool16 autoScroll = kTrue 
)
pure virtual

Reset the selection to what it was when this snapshot was created.

Parameters
theSSIN pointer to selection snapshot to use (created in CreateSnapshot)
pViewIN pointer to the view where the selection is to be displayed
bDrawSelIN whether to draw the selection
autoScrollIN whether to scroll the view to make the selection visible
virtual bool16 ISelectionSnapshotSuite::SelectionIsEmpty (SelectionSnapshotDatatheSS)
pure virtual

Tell whether the selection is empty.

Parameters
theSSIN pointer to the selection snapshot data
Returns
kTrue if the selection is empty, kFalse otherwise
virtual bool16 ISelectionSnapshotSuite::SelectionIsValid (SelectionSnapshotDatatheSS,
UIDRef activeSpreadRef 
)
pure virtual

Tell whether the selection can be restored.

Parameters
theSSIN pointer to the selection snapshot data
activeSpreadRefIN reference to the active spread
Returns
kTrue if the items to be selected still exist; kFalse otherwise