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

#include <IGroupCmdData.h>

Inheritance diagram for IGroupCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGROUPCMDDATA }
 

Public Member Functions

virtual void Set (UIDList *children)=0
 
virtual const UIDListGetChildren ()=0
 
virtual void SortChildren ()=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

This interface is used to cache the data for kGroupCmdBoss.

The command data includes UIDList of items to group together.

Member Enumeration Documentation

anonymous enum

Define the default IID for IGroupCmdData.

Member Function Documentation

virtual const UIDList* IGroupCmdData::GetChildren ()
pure virtual

Get UIDList of items to group together.

Returns
UIDList items to group together.
virtual void IGroupCmdData::Set (UIDListchildren)
pure virtual

Set the UIDList of items to group together. This data interface owns the item list and will delete it in its destructor. The UIDList passed to Set should be heap-allocated (with new).

Parameters
UIDListrefers to children to group together.
Returns
void
virtual void IGroupCmdData::SortChildren ()
pure virtual

Sort the list of children into Z-order. Used internally by the group command.

Returns
void