GLOW API version 1.0 reference

Back to Table of contents

class GlowTextFieldWindowParams

General information

type: struct
inherits: (none)
module: glowTextFieldWindow

GlowTextFieldWindowParams encloses parameters for construction of a GlowTextFieldWindow.

GLOW programs that use text field windows will need to use GlowTextFieldWindowParams.

Data

Parameter data

const char* windowTitle

Title for the window. Initial default is "Enter text".

int x

X location of the upper left of the window, in pixel coordinates of the screen. Initial default is GlowWindow::autoPosition.

int y

Y location of the upper left of the window, in pixel coordinates of the screen. Initial default is GlowWindow::autoPosition.

int fieldWidth

Width of the text field in pixels. Initial default is 100.

int fieldHideCharacter

Character to use to hide the field's true input, or 0 for no hiding. Initial default is 0.

const char* labelText

The text field label. Include newline characters to specify a multi-line message. Initial default is the empty string "".

const char* fieldText

Initial text field value. Initial default is the empty string "".

GlowFont labelFont

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

GlowFont fieldFont

Font for the text field. Initial default is GlowFont::helvetica12.

GlowFont buttonFont

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

const char* buttonLabels

Labels for the buttons, tab-delimited. Initial default is "OK" (denoting a single button with that label).

int windowSpacing

Spacing between elements in the window. Initial default is 20.

int enterButton

Button number to map the enter key to. Remember that buttons are numbered starting with 0. Use a negative number for no mapping. Initial default is 0.

int escapeButton

Button number to map the escape key to. Remember that buttons are numbered starting with 0. Use a negative number for no mapping. Initial default is 1.

GlowTextFieldWindowReceiver* receiver

Receiver to receive events for this window, or the null pointer for no event reporting. You can still add or remove receivers later. Initial default is null.

Color data

GlowColor backColor
GlowColor labelColor
GlowColor fieldBackColor
GlowColor fieldHiliteBackColor
GlowColor fieldTextColor
GlowColor fieldHiliteTextColor
GlowColor fieldCaretColor

Static Data

Defaults

static GlowTextFieldWindowParams defaults

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

Methods

Constructor

GlowTextFieldWindowParams(void)

Constructs a new parameter block, copying defaults

Back to Table of contents