< Previous | Contents | Next >

Description

The ComboControl presents a drop down menu, which returns a Number value. To add a ComboControl, set the INPID_InputControl attribute of the AddInput function to the string "ComboControl".

The return value will be a number representing the position of the selected entry in the ComboControl. The first item in the list will return 0, the second item will return 1, and so on.

Attributes

Name

Type : Description

CC_LabelPosition

string : This attribute determines where the label for the ComboControl is drawn. Should be set to either "Vertical" or "Horizontal".

The default value is "Horizontal"

CCS_AddString

string : Each time this attribute is entered a new string is added to the ComboControl. As a result, there should be multiple entries of CCS_ AddString, each within its own unnamed table index (see example below).


Example


The following is an example AddInput function that duplicates the Operator control on a Merge tool.

InOperation = self:AddInput("Operator", "Operator", { LINKID_DataType = "Number", INPID_InputControl = "ComboControl", INP_Default = 0.0,

INP_Integer = true, ICD_Width = 0.5,

{ CCS_AddString = "Over", },

{ CCS_AddString = "In", },

{ CCS_AddString = "Held Out", },

{ CCS_AddString = "Atop", },

{ CCS_AddString = "XOr", }, CC_LabelPosition = "Vertical",

})


ComboIDControl