#include <ISnipRunDialogData.h>
|
| enum | { kDefaultIID = IID_ISNIPRUNDIALOGDATA } |
| |
| enum | SnipRunDialogMode {
kSnipRunStringMode, kSnipRunIntMode, kSnipRunHexMode, kSnipRunRealMode,
kSnipRunChoiceMode
} |
| |
From SDK sample; data interface to exchange information between parameter dialog (kSnipRunDialogBoss) and client code that uses it.
- See Also
- ISnipRunDialogData
- kSnipRunDialogBoss
- SnipRunDialogController
Mode indicating type of data (PMString, int32 etc.) the dialog is to gather and return to the caller.
| virtual void ISnipRunDialogData::EnableTranslation | ( | const bool16 | enable | ) | |
| pure virtual |
Allows the client to indicate whether PMString's passed through this interface to the dialog are translatable or not.
- Parameters
| enable | kTrue(default) if strings passing are translatable, kFalse otherwise. |
Implemented in SnipRunDialogData.
| virtual const int32& ISnipRunDialogData::GetChoiceIndex | ( | | ) | const |
| pure virtual |
| virtual const int32& ISnipRunDialogData::GetInt32 | ( | | ) | const |
| pure virtual |
| virtual const PMReal& ISnipRunDialogData::GetLowerLimit | ( | | ) | const |
| pure virtual |
| virtual const PMReal& ISnipRunDialogData::GetPMReal | ( | | ) | const |
| pure virtual |
| virtual const PMString& ISnipRunDialogData::GetPMString | ( | | ) | const |
| pure virtual |
| virtual const PMString& ISnipRunDialogData::GetPrompt | ( | | ) | const |
| pure virtual |
| virtual const PMString& ISnipRunDialogData::GetTypeInfo | ( | | ) | const |
| pure virtual |
| virtual const PMReal& ISnipRunDialogData::GetUpperLimit | ( | | ) | const |
| pure virtual |
| virtual const bool16& ISnipRunDialogData::GetWasCancelled | ( | | ) | const |
| pure virtual |
- Returns
- kTrue if dialog was cancelled, kFalse otherwise.
Implemented in SnipRunDialogData.
| virtual void ISnipRunDialogData::SetChoiceIndex | ( | const int32 | value | ) | |
| pure virtual |
| virtual void ISnipRunDialogData::SetChoices | ( | const K2Vector< PMString > & | choices | ) | |
| pure virtual |
| virtual void ISnipRunDialogData::SetInt32 | ( | const int32 | value | ) | |
| pure virtual |
| virtual void ISnipRunDialogData::SetLowerLimit | ( | const PMReal & | lowerLimit | ) | |
| pure virtual |
Set lower limit for range checked data value.
- Parameters
Implemented in SnipRunDialogData.
Set the type of data the dialog is to gather.
- Parameters
Implemented in SnipRunDialogData.
| virtual void ISnipRunDialogData::SetPMReal | ( | const PMReal & | value | ) | |
| pure virtual |
| virtual void ISnipRunDialogData::SetPMString | ( | const PMString & | value | ) | |
| pure virtual |
| virtual void ISnipRunDialogData::SetPrompt | ( | const PMString & | value | ) | |
| pure virtual |
Set the prompt that describes what the data the user is being requested to enter is (displayed at the top of the dialog).
- Parameters
Implemented in SnipRunDialogData.
| virtual void ISnipRunDialogData::SetTypeInfo | ( | const PMString & | value | ) | |
| pure virtual |
Set the TypeInfo that describes the data type and its range (for example "int32 1:10" displayed at the bottom of the dialog).
- Parameters
Implemented in SnipRunDialogData.
| virtual void ISnipRunDialogData::SetUpperLimit | ( | const PMReal & | upperLimit | ) | |
| pure virtual |
Set upper limit for range checked data value.
- Parameters
Implemented in SnipRunDialogData.
| virtual void ISnipRunDialogData::SetWasCancelled | ( | const bool16 | value | ) | |
| pure virtual |
Set flag that indicates the user cancelled the dialog.
- Parameters
| value | kTrue if dialog was cancelled, kFalse otherwise. |
Implemented in SnipRunDialogData.
Public Member Functions inherited from IPMUnknown
1.8.3.1 
