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

#include <IRegPolyPrefsCmdData.h>

Inheritance diagram for IRegPolyPrefsCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const int32 &numSides, const int32 &starInset)=0
 
virtual const int32 & GetNumSides () const =0
 
virtual const int32 & GetStarInset () const =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

Simple data interface for regular polygon preferences commands.

Regular polygon preferences include the number of sides and the star inset.

See Also
IRegPolyPrefs

Member Function Documentation

virtual const int32& IRegPolyPrefsCmdData::GetNumSides () const
pure virtual

Retrieves the number of sides to use for regular polygons.

Returns
The number of sides
virtual const int32& IRegPolyPrefsCmdData::GetStarInset () const
pure virtual

Retrieves the star inset to use for regular polygons.

Returns
The star inset
virtual void IRegPolyPrefsCmdData::Set (const int32 & numSides,
const int32 & starInset 
)
pure virtual

Sets the preferences to use for regular polygons.

Parameters
numSidesIN The number of sides for the polygon
starInsetIN The star inset for the polygon