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

#include <ISplitterControlData.h>

Inheritance diagram for ISplitterControlData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISPLITTERCONTROLDATA }
 

Public Member Functions

virtual int32 GetNumberOfControlledWidgets ()=0
 
virtual WidgetID GetNthControlledWidget (int32 index)=0
 
virtual void SetNthControlledWidget (int32 index, WidgetID id)=0
 
virtual int32 GetNthMinimumSize (int32 index)=0
 
virtual void SetNthMinimumSize (int32 index, int32 minSize)=0
 
virtual int32 GetNthSnapClosedPoint (int32 index)=0
 
virtual void SetNthSnapClosedPoint (int32 index, int32 snapPoint)=0
 
virtual void RemoveNthControlledWidget (int32 index)=0
 
virtual void AddNthControlledWidget (int32 index, WidgetID id, int32 minimumSize, int32 snapClosedSize)=0
 
virtual bool16 IsVertical ()=0
 
virtual PMRect GetOverallBoundingRect ()=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

Interface used in conjunction with the kSplitterWidgetBoss object. This interface keeps track of the various widgets controlled by the splitter.

Member Function Documentation

virtual void ISplitterControlData::AddNthControlledWidget (int32 index,
WidgetID id,
int32 minimumSize,
int32 snapClosedSize 
)
pure virtual

Add the nth widget controlled by this splitter

virtual WidgetID ISplitterControlData::GetNthControlledWidget (int32 index)
pure virtual

Get the nth widget controlled by this splitter

virtual int32 ISplitterControlData::GetNthMinimumSize (int32 index)
pure virtual

Get the minimum size of the nth widget controlled by this splitter

virtual int32 ISplitterControlData::GetNthSnapClosedPoint (int32 index)
pure virtual

Get the snap closed size of the nth widget controlled by this splitter

virtual int32 ISplitterControlData::GetNumberOfControlledWidgets ()
pure virtual

Get the number of widgets controlled by this splitter

virtual PMRect ISplitterControlData::GetOverallBoundingRect ()
pure virtual

Get the rectangle this splitter will be constrained to

virtual bool16 ISplitterControlData::IsVertical ()
pure virtual

Get the orientation of the splitter.

Returns
kTrue if the splitter divides top-to-bottom; kFalse otherwise
virtual void ISplitterControlData::RemoveNthControlledWidget (int32 index)
pure virtual

Remove the nth widget controlled by this splitter

virtual void ISplitterControlData::SetNthControlledWidget (int32 index,
WidgetID id 
)
pure virtual

Set the nth widget controlled by this splitter

virtual void ISplitterControlData::SetNthMinimumSize (int32 index,
int32 minSize 
)
pure virtual

Set the minimum size of the nth widget controlled by this splitter

virtual void ISplitterControlData::SetNthSnapClosedPoint (int32 index,
int32 snapPoint 
)
pure virtual

Set the snap closed size of the nth widget controlled by this splitter