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

#include <INewStateCmdData.h>

Inheritance diagram for INewStateCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_INEWSTATECMDDATA }
 
enum  NamePolicy { kUseDefaultName, kUseDuplicateName, kBaseNameOnString, kDoNotName }
 

Public Member Functions

virtual void SetNamePolicy (NamePolicy inNamePolicy)=0
 
virtual NamePolicy GetNamePolicy () const =0
 
virtual void SetNameString (const PMString &inString)=0
 
virtual PMString GetNameString () const =0
 
virtual void SetPosition (int32 inPosition)=0
 
virtual int32 GetPosition () 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

Command parameters for the NewStateCmd command

Member Function Documentation

virtual NamePolicy INewStateCmdData::GetNamePolicy () const
pure virtual

Get the policy for naming the new state.

Returns
the policy for naming the new state
virtual PMString INewStateCmdData::GetNameString () const
pure virtual

Set the string to base the new state's name on.

Returns
the string that the new state's name will be based on.
virtual int32 INewStateCmdData::GetPosition () const
pure virtual

Get the position that the state will be inserted in the state-order.

Returns
the position
virtual void INewStateCmdData::SetNamePolicy (NamePolicy inNamePolicy)
pure virtual

Set the policy for naming the new state.

Parameters
inNamePolicythe policy to use when determining the state name.
virtual void INewStateCmdData::SetNameString (const PMStringinString)
pure virtual

Set the string to base the new state's name on. This string will be made unique within the apperarnce list of the object that we are adding a state to. This string is only used if the name policy is kBaseNameOnString.

Parameters
inStringthe string to use as the name of the state
virtual void INewStateCmdData::SetPosition (int32 inPosition)
pure virtual

Set where in the state-order the state should be created.

Parameters
inPositionthe position to insert the state at (IAppearanceList::kLastInOrder is acceptable.)