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

#include <IRegPolyPrefs.h>

Inheritance diagram for IRegPolyPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IREGPOLYPREFERENCES }
 

Public Member Functions

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

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

See Also
IRegPolyPrefsCmdData

Member Function Documentation

virtual int32 IRegPolyPrefs::GetNumSides ()
pure virtual

Retrieves the number of sides to use for regular polygons.

Returns
The number of sides
virtual int32 IRegPolyPrefs::GetStarInset ()
pure virtual

Retrieves the star inset to use for regular polygons.

Returns
The star inset
virtual void IRegPolyPrefs::SetNumSides (const int32 & numSides)
pure virtual

Sets the number of sides to use for regular polygons.

Parameters
numSidesIN The default number of sides
virtual void IRegPolyPrefs::SetStarInset (const int32 & starInset)
pure virtual

Sets the star inset to use for regular polygons.

Parameters
numSidesIN The default star inset