siPPGControlType String Constant


Variables
const wchar_t *  siControlBitmap
const wchar_t *  siControlBoolean
const wchar_t *  siControlButton
const wchar_t *  siControlCheck
const wchar_t *  siControlCombo
const wchar_t *  siControlEdit
const wchar_t *  siControlFCurve
const wchar_t *  siControlFilePath
const wchar_t *  siControlFolder
const wchar_t *  siControlGrid
const wchar_t *  siControlIconList
const wchar_t *  siControlListBox
const wchar_t *  siControlNumber
const wchar_t *  siControlRadio
const wchar_t *  siControlRGB
const wchar_t *  siControlRGBA
const wchar_t *  siControlStatic
const wchar_t *  siControlString
const wchar_t *  siControlSynoptic
const wchar_t *  siControlTextEditor

Detailed Description

Specifies the different types of controls (i.e. widgets) supported on a Softimage Property Page. Controls on a Property Page usually display and control the value of a Parameter on an inspected object.
See also:
PPGItem::Type, PPGLayout::AddEnumControl, PPGLayout::AddItem, PPGItem::GetType, PPGItem::PutType, PPGLayout::AddEnumControl, PPGLayout::AddItem

PPGLayout, siPPGItemAttribute, Property Page Controls, Setting Control Attributes

Variable Documentation

const wchar_t* siControlBitmap

["BitmapWidget"] A static bitmap control. The control needs to be associated with a real parameter on the inspected object, but the value is neither read nor changed. This control is often used for displaying a logo. The path is specified using siPPGItemAttribute::siUIFilePath . For more information, see the Bitmap Widget topic.

const wchar_t* siControlBoolean

["Boolean"] A simple check box. This is the default control for Boolean parameters. For more information, see the Check Box topic.

const wchar_t* siControlButton

["commandbutton"] A button is a special kind of control which is not associated with any parameter of the inspected object. See PPGLayout::AddButton .

Supported attributes are siPPGItemAttribute::siUICX and siPPGItemAttribute::siUICY . For more information, see the Command Button topic.

const wchar_t* siControlCheck

["Check"] Bitfield control, showing separate check boxes for each item in the PPGItem::UIItems list. The value of the parameter will be equal to the sum of all the checked items. This control is useful for packing many flags into a single integer while still having a convenient user interface to set or view which flags have been set. For more information, see the Bitfield topic.

const wchar_t* siControlCombo

["Combo"] A read-only edit control, with a drop down menu showing items out of the PPGItem::UIItems list.

Supported attributes are siPPGItemAttribute::siUICX and siPPGItemAttribute::siUICY . For more information, see the Combo/Drop-Down Box topic.

const wchar_t* siControlEdit

["Edit"] An edit box control. It is similar to siPPGControlType::siControlString , however it supports the siPPGItemAttribute::siUICX , siPPGItemAttribute::siUICY and siPPGItemAttribute::siUIStyle attributes and is used as a multi-line string edit box. For more information, see the Multi-line Text topic.

const wchar_t* siControlFCurve

["FCurveWidget"] A control for displaying an FCurve (see PPGLayout::AddFCurve ).

Supported optional attributes are siPPGItemAttribute::siUICX , siPPGItemAttribute::siUICY , siPPGItemAttribute::siUIFCurveLabelX , siPPGItemAttribute::siUIFCurveLabelY , siPPGItemAttribute::siUIFCurveViewMinX , siPPGItemAttribute::siUIFCurveViewMaxX , siPPGItemAttribute::siUIFCurveViewMinY , siPPGItemAttribute::siUIFCurveViewMaxY , siPPGItemAttribute::siUIFCurveGridSpaceX , siPPGItemAttribute::siUIFCurveGridSpaceY , siPPGItemAttribute::siUIFCurveNoGrid , siPPGItemAttribute::siUIFCurveNoRulerX , and siPPGItemAttribute::siUIFCurveNoRulerY . For more information, see the FCurve Widget topic.

const wchar_t* siControlFilePath

["FilePath"] A control for driving a string Parameter containing a file name. The control provides an edit box and a button that launches a file browser (similar to XSIUIToolkit::FileBrowser ).

Supported attributes are siPPGItemAttribute::siUIFileFilter , siPPGItemAttribute::siUIInitialDir , siPPGItemAttribute::siUISubFolder , siPPGItemAttribute::siUIAudioFile , siPPGItemAttribute::siUIImageFile , siPPGItemAttribute::siUIOpenFile , siPPGItemAttribute::siUIFileMustExist , siPPGItemAttribute::siUIStyle . For more information, see the File Browser Widget topic.

const wchar_t* siControlFolder

["Folder"] A control for driving a string Parameter with an edit box and a button that launches a directory picker.

Supported attributes are siPPGItemAttribute::siUIInitialDir and siPPGItemAttribute::siUISubFolder . For more information, see the Folder Widget topic.

const wchar_t* siControlGrid

["GridWidget"] A control of type GridWidget which displays the data from a GridData object. It shows a multi-column list control, similar to a spreadsheet. See CustomProperty::AddGridParameter .

Supported optional attributes are siPPGItemAttribute::siUICX , siPPGItemAttribute::siUICY , siPPGItemAttribute::siUIGridColumnWidths , siPPGItemAttribute::siUIGridLockColumnHeader , siPPGItemAttribute::siUIGridLockRowHeader , siPPGItemAttribute::siUIGridHideColumnHeader , siPPGItemAttribute::siUIGridReadOnlyColumns , siPPGItemAttribute::siUIGridHideRowHeader and siPPGItemAttribute::siUIGridSelectionMode . For more information, see the GridData Widget topic.

Note: This control has no relationship to thegeometric shape called a "Grid".

const wchar_t* siControlIconList

["IconList"] Similar to a siPPGControlType::siControlRadio , except each item is represented by a bitmap on the screen rather than by a text label. Only .bmp files are supported, and the filenames of these files are specified in the PPGItem::UIItems list.

Supported attributes are siPPGItemAttribute::siUIColumnCnt , siPPGItemAttribute::siUILineCnt , siPPGItemAttribute::siUIColumnGap , siPPGItemAttribute::siUILineGap , siPPGItemAttribute::siUISelectionColor , and siPPGItemAttribute::siUIUseSelectionIcon . For more information, see the Icon Buttons topic.

const wchar_t* siControlListBox

["ListBox"] This control is functionally similar to siPPGControlType::siControlRadio and siPPGControlType::siControlCombo in that it shows a list of possible items. However, unlike those other controls, you have the option to use the ListBox in a multi-selection mode by using the attribute siPPGItemAttribute::siUIMultiSelectionListBox .

The siPPGItemAttribute::siUICX and siPPGItemAttribute::siUICY attributes can be set to change the size. If no siPPGItemAttribute::siUIStyle attribute is assigned and the list is too large to fit, the ListBox will display a vertical scroll bar. For more information, see the List Box topic.

const wchar_t* siControlNumber

["Number"] A numeric control, normally with both an edit control and a slider. This is the default control for all numeric parameters.

Supported attributes are siPPGItemAttribute::siUICX , siPPGItemAttribute::siUICY , siPPGItemAttribute::siUISyncSlider , siPPGItemAttribute::siUILogarithmic , siPPGItemAttribute::siUIDecimals , siPPGItemAttribute::siUINoSlider , siPPGItemAttribute::siUITreadmill and siPPGItemAttribute::siUIThumbWheel . For more information, see the Numeric Edit Box with Slider topic.

const wchar_t* siControlRadio

["Radio"] Radio control, allowing you to select a single item out of the PPGItem::UIItems list. This is the same behavior as the siPPGControlType::siControlCombo control, except that all the options are displayed on the screen. Hence a Combo box is best suited for large lists of items. For more information, see the Radio Buttons topic.

const wchar_t* siControlRGB

["RBG"] A Color control with no "Alpha" channel. This control is associated with three parameters in the underlying object. See PPGLayout::AddColor . For more information, see the RGB Color Control topic.

const wchar_t* siControlRGBA

["RBGA"] A Color control that includes the "Alpha" channel. This control is associated with four parameters in the underlying object. See PPGLayout::AddColor . For more information, see the RGBA Color Control topic.

const wchar_t* siControlStatic

["Static"] Static text on the property page, see PPGLayout::AddStaticText . If the PPGItem::Name of the associated item is "Static" the PPGItem::Label will be displayed as the static text. Otherwise the name is assumed to refer to an actual string Parameter and its value is shown.

Tip: To break the text onto multiple lines, include line return characters in the text (vbCrLf in vbscript and "\n" in JScript).

Supported attributes are siPPGItemAttribute::siUICX and siPPGItemAttribute::siUICY . For more information, see the Static Text topic.

const wchar_t* siControlString

["String"] A single line edit box for displaying text. This is the default control for String parameters.

Supported attributes are siPPGItemAttribute::siUICX and siPPGItemAttribute::siUICY . For multi-line strings use the siPPGControlType::siControlEdit instead. For more information, see the Single-line Text topic.

const wchar_t* siControlSynoptic

["SynopticWidget"] A control that shows a synoptic view. You use this control with a string parameter whose value is the full path to the synoptic file. The size of the synoptic view determines the size of the control. For an example of the synoptic control, see the PPGDemos example. For more information, see the Synoptic Widget topic.

const wchar_t* siControlTextEditor

["TextEditorWidget"] A control that shows a full-featured text editor. You use this control with a string parameter whose value will be set to the text in the editor. For more information, see the Text Editor Widget topic.