Appendix A: Widget Hint Definitions

 

// widget hints for all parameter types
#define WIDGET_DEFAULT                  0  // let DashBoard decide
#define WIDGET_TEXT_DISPLAY             1  // display as text, read only
#define WIDGET_HIDDEN                   2  // do not display

// widget hints for numeric types with NULL_CONSTRAINT or RANGE_CONSTRAINT
#define WIDGET_SLIDER_HORIZONTAL        3  // slider (RANGE only)
#define WIDGET_SLIDER_VERTICAL          4  // slider (RANGE only)
#define WIDGET_SPINNER                  5  // spinner
#define WIDGET_TEXTBOX                  6  // numeric entry field
#define WIDGET_PROGRESS_BAR            17  // progress bar (RANGE only)

#define WIDGET_AUDIO_METER             19  // audio meter (RANGE only)

#define WIDGET_MENU_POPUP              20  // popup menu with the ID(INT ONLY)

#define WIDGET_TIMER                   21  // countdown/up timer (RANGE only)

#define WIDGET_SLIDER_H_NO_LABEL       24  // unlabeled slider (RANGE only)

#define WIDGET_SLIDER_V_NO_LABEL       25  // unlabeled slider (RANGE only)

#define WIDGET_VERTICAL_FADER          26  // vertical fader bar (RANGE only)

#define WIDGET_TOUCH_WHEEL             27  // touch wheel (RANGE only)

#define WIDGET_HEX_SPINNER             28  // base 16 spinner (RANGE only)

#define WIDGET_ABSOLUTE_POSITIONER     29  // absolute x,y positioner

#define WIDGET_CROSSHAIR              30  // joystick-like x,y positioner

#define WIDGET_JOY_STICK               34  // joystick x,y positioner

// widget hints for integer types with CHOICE_CONSTRAINT
#define WIDGET_COMBO_BOX                7  // combo box - usually the default
#define WIDGET_CHECKBOX                 8  // two choices
#define WIDGET_RADIO_HORIZONTAL         9  // radio buttons
#define WIDGET_RADIO_VERTICAL          10  // radio buttons
#define WIDGET_BUTTON_PROMPT           11  // single choice
#define WIDGET_BUTTON_NO_PROMPT        12  // single choice
#define WIDGET_BUTTON_TOGGLE           13  // two choices

#define WIDGET_FILE_DOWNLOAD           18  // external object OID/filename pairs

#define WIDGET_RADIO_TOGGLE_BUTTONS    22  // display a toggle button for choices

#define WIDGET_TREE                    31  // display a tree with choices

#define WIDGET_TREE_POPUP              32  // display a tree in a combo box


// widget hints for INT32_PARAM
#define WIDGET_IP_ADDRESS              14  // nnn.nnn.nnn.nnn

#define WIDGET_COLOR_CHOOSER           23  // argb color chooser

#define WIDGET_COLOR_CHOOSER_POPUP     33  // argb color chooser in popup

// widget hints for integer arrays
#define WIDGET_ARRAY_HEADER_VERTICAL   15  // array layout specification
#define WIDGET_ARRAY_HEADER_HORIZONTAL 16  // array layout specification

// widget hints for STRING_PARAM
#define WIDGET_TEXT_ENTRY               3  // normal text entry field
#define WIDGET_PASSWORD                 4  // uses password entry field
#define WIDGET_TITLE_LINE               5  // layout hint - read only
#define WIDGET_LINE_ONLY                6  // layout hint - read only
#define WIDGET_TITLE_ONLY               7  // layout hint - read only
#define WIDGET_PAGE_TAB                 8  // layout hint - read only
#define WIDGET_LICENSE                  9  // RossKeys license adapter
#define WIDGET_TITLE_HEADER            10  // layout hint - read only
#define WIDGET_COMBO_ENTRY             11  // combo box plus entry field
#define WIDGET_ICON_DISPLAY            12  // icon plus text display
#define WIDGET_RICH_LABEL              13  // multi-line display (html format)

#define WIDGET_MULTILINE_TEXT_ENTRY    14  // multi-line text entry (non-html)

 

// widget hints for STRING_PARAM (used with special OID 255.1)
#define WIDGET_NAME_OVERRIDE_APPEND     0
#define WIDGET_NAME_OVERRIDE_REPLACE    1

// deprecated names - here for backward compatibility
#define WIDGET_NONE        WIDGET_DEFAULT
#define WIDGET_COMBO       WIDGET_COMBO_BOX
#define WIDGET_RADIO       WIDGET_RADIO_HORIZONTAL
#define WIDGET_HSLIDER     WIDGET_SLIDER_HORIZONTAL
#define WIDGET_VSLIDER     WIDGET_SLIDER_VERTICAL