#include <INewStateCmdData.h>
|
| enum | { kDefaultIID = IID_INEWSTATECMDDATA } |
| |
| enum | NamePolicy { kUseDefaultName, kUseDuplicateName, kBaseNameOnString, kDoNotName } |
| |
Command parameters for the NewStateCmd command
| 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
| inNamePolicy | the policy to use when determining the state name. |
| virtual void INewStateCmdData::SetNameString | ( | const PMString & | inString | ) | |
| 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
| inString | the 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
| inPosition | the position to insert the state at (IAppearanceList::kLastInOrder is acceptable.) |