GLOW API version 1.0 reference

Back to Table of contents

class GlowLabeledTextFieldParams

General information

type: struct
inherits: GlowTextFieldParams
module: glowTextFieldWidget

GlowLabeledTextFieldParams encloses parameters for construction of a GlowLabeledTextFieldWidget.

GLOW programs which use labeled text fields may need to use GlowLabeledTextFieldParams to construct a text field widget.

Data

General widget parameter data
These fields are inherited from GlowWidgetParams. Note that their default values may be different from the generic widget parameters.

int width

Width of the widget. Initial default is 100.

int height

Height of the widget. Initial default is 20.

int x

X location of the upper left of the widget, in pixel coordinates of the parent widget. Initial default is 0.

int y

Y location of the upper left of the widget, in pixel coordinates of the parent widget. Initial default is 0.

long refcon

Reference constant for this widget. Initial default 0.

bool clipping

Should the widget clip to its rectangle when drawing children. Initial default is false.

Parameter data specific to text fields
These fields are inherited from GlowTextFieldParams.

GlowTextFieldWidget::Style style

Drawing style for the box. Initial default is GlowTextFieldWidget::loweredStyle.

const char* initialText

Text for the label. Initial default is "".

GlowFont font

Font for the label. Initial default is GlowFont::helvetica12.

int selectionStart

Starting position of the selection. Initial default is 0.

int selectionEnd

Ending position of the selection. Initial default is 0.

int blinkInterval

Interval between caret blinks in milliseconds. Initial default is 500.

int autoScrollInterval

Interval between autoscroll moves in milliseconds. Initial default is 50.

int inset

Pixels to inset the text from the edge of the box. Initial defauilt is 5.

int caretInset

Pixels to inset the clip area for the caret from the edge of the box. Initial defauilt is 2.

Color parameter data
These fields are inherited from GlowTextFieldParams.

GlowColor backColor
GlowColor textColor
GlowColor caretColor
GlowColor focusBackColor
GlowColor focusTextColor
GlowColor focusCaretColor
GlowColor hiliteBackColor
GlowColor hiliteTextColor
GlowColor disableBackColor
GlowColor disableTextColor
GlowColor disableCaretColor
GlowColor disableOutlineColor
GlowColor lightBevelColor
GlowColor darkBevelColor

Parameter data specific to the label

const char* labelText

Text for the label. Initial default is "".

GlowFont labelFont

Font for the label. Initial default is GlowFont::helvetica12.

int labelPosition

Position code for the label. Use the constants given in GlowLabeledTextFieldWidget.

int labelWidth

Width of the label in pixels.

int labelHeight

Height of the label in pixels.

int labelSpacing

Spacing between the label and the popup menu box in pixels.

GlowColor labelColor

Color of the label text.

GlowColor disableLabelColor

Color of the label text when the field is disabled.

Static Data

Defaults

static GlowLabeledTextFieldParams defaults

Default parameters. These are copied every time a new GlowLabeledTextFieldParams is constructed.

Methods

Constructor

GlowLabeledTextFieldParams(void)

Constructs a new parameter block, copying defaults

Back to Table of contents