InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IGroupItemSuite Class Referenceabstract

#include <IGroupItemSuite.h>

Inheritance diagram for IGroupItemSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGROUPITEMSUITE }
 

Public Member Functions

virtual bool16 CanItemsBeGrouped ()=0
 
virtual bool16 CanItemsBeUngrouped ()=0
 
virtual bool16 HaveBothLockedAndUnLockedItems ()=0
 
virtual bool16 HaveBothOverrideableAndNonOverrideableItems ()=0
 
virtual ErrorCode GroupItems ()=0
 
virtual ErrorCode UngroupItems ()=0
 
virtual ErrorCode GroupLockedItems ()=0
 
virtual ErrorCode LockGroupedItems ()=0
 
virtual ErrorCode GroupOverrideableItems ()=0
 
virtual ErrorCode MakeNonOverrideableGroupedItems ()=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

Defines the interface for a group suite to be used in the selection architecture

Member Enumeration Documentation

anonymous enum

kDefaultIID

Member Function Documentation

virtual bool16 IGroupItemSuite::CanItemsBeGrouped ()
pure virtual

Check if current selected items can be grouped or not.

Returns
bool16 kTrue if can, kFalse otherwise.
virtual bool16 IGroupItemSuite::CanItemsBeUngrouped ()
pure virtual

Check if current selected items can be ungrouped or not.

Returns
bool16 kTrue if can, kFalse otherwise.
virtual ErrorCode IGroupItemSuite::GroupItems ()
pure virtual

Do group the items.

Returns
ErrorCode as the execution result.
virtual ErrorCode IGroupItemSuite::GroupLockedItems ()
pure virtual

Do group locked-items.

Returns
ErrorCode as the execution result.
virtual ErrorCode IGroupItemSuite::GroupOverrideableItems ()
pure virtual

Do group overrideable-items.

Returns
ErrorCode as the execution result.
virtual bool16 IGroupItemSuite::HaveBothLockedAndUnLockedItems ()
pure virtual

Check if current selected item has both locked and unlocked items or not.

Returns
bool16 kTrue if we have both locked and unlocked items, kFalse otherwise.
virtual bool16 IGroupItemSuite::HaveBothOverrideableAndNonOverrideableItems ()
pure virtual

Check if current selected item has both and nonOverrideable items or not.

Returns
bool16 kTrue if we have both overrideable and nonOverrideable items, kFalse otherwise.
virtual ErrorCode IGroupItemSuite::LockGroupedItems ()
pure virtual

Do lock grouped-items.

Returns
ErrorCode as the execution result.
virtual ErrorCode IGroupItemSuite::MakeNonOverrideableGroupedItems ()
pure virtual

Make grouped-items nonOverrideable.

Returns
ErrorCode as the execution result.
virtual ErrorCode IGroupItemSuite::UngroupItems ()
pure virtual

Do ungroup the items.

Returns
ErrorCode as the execution result.