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

#include <IClusterController.h>

Inheritance diagram for IClusterController:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICLUSTERCONTROLLER }
 

Public Member Functions

virtual IEventHandler * QuerySelectedClusterWidgetEH () const =0
 
virtual IEventHandler * SelectAndQueryNextClusterWidget (bool16 next=kTrue)=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

Interface used to control a "cluster" of related widgets, for example, a radio button group. This interface is found ong the kClusterPanelWidgetBoss object.

Member Function Documentation

virtual IEventHandler* IClusterController::QuerySelectedClusterWidgetEH () const
pure virtual

Query for the event handler of the currently selected widget in the cluster.

virtual IEventHandler* IClusterController::SelectAndQueryNextClusterWidget (bool16 next = kTrue)
pure virtual

Query for the event handler of the "next" widget in the cluster and "select" it. In other words, the currently turned on widget is turned off and the next one in the list is turned on. The event handler of the new widget is returned.

Parameters
nextIN if true then select the next widget in the cluster, if false then select the previous one.