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

#include <ISetStripedAttrCmdData.h>

Inheritance diagram for ISetStripedAttrCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETSTRIPEDATTRCMDDATA }
 

Public Member Functions

virtual uint32 GetParamCount () const =0
 
virtual void SetParamCount (uint32 count)=0
 
virtual void GetNthParam (uint32 n, PMReal &start, PMReal &width) const =0
 
virtual void SetNthParam (uint32 n, PMReal const &start, PMReal const &width)=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 defining data to be used by the SetStripedAttribute command.

Stores parameters used by the striped stroker. Each parameter consists of a pair of values: one that specifies the start position as a percentage of the stroke weight, and one that specifies the width (also as a percentage).

Member Function Documentation

virtual void ISetStripedAttrCmdData::GetNthParam (uint32 n,
PMRealstart,
PMRealwidth 
) const
pure virtual

Retrieves the n'th parameter's start and width. If n identifies a valid index in the command data, the start and width out parameters are set to the values of the n'th parameter. Otherwise, start and width are undefined.

Parameters
nIN Index of parameter to retrieve
startOUT Parameter's start value
widthOUT Parameter's width value
virtual uint32 ISetStripedAttrCmdData::GetParamCount () const
pure virtual

Returns the number of parameters stored in command data

Returns
The number of parameters stored
virtual void ISetStripedAttrCmdData::SetNthParam (uint32 n,
PMReal const & start,
PMReal const & width 
)
pure virtual

Sets the n'th parameter's start and width values. If n identifies a valid index in the command data, its start and width are set accordingly. Other- wise, the method silently fails.

Parameters
nIN Index of parameter to set
startIN New start value for parameter
widthIN New width value for parameter
virtual void ISetStripedAttrCmdData::SetParamCount (uint32 count)
pure virtual

Sets the number of parameters to be stored. If count is greater than current length, the additional parameters are defaulted to zeroes. If count is less than current length, existing values are truncated.

Parameters
countIN New count of parameters for command data