Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleClick here to show Table of Contents
Table of Contents

Inherits

windowcontrol

Inherited By

buttonfield

Context

windowinstance

Button controls create buttons that respond to simple click events.

...

Code Block
languagexml
<buttoncontrol >
  <allowdoubleclick />
  <color > ... </color>
  <font > ... </font>
  <hover > ... </hover>
  <icon >
    <normal > ... </normal>
    <pressed > ... </pressed>
    <hover > ... </hover>
  </icon>
  <pressed > ... </pressed>
  <state >
    <color > ... </color>
    <font > ... </font>
    <frame > ... </frame>
    <frameoffset > ... </frameoffset>
    <icon > ... </icon>
    <offset > ... </offset>
    <text > ... </text>
    <textres > ... </textres>
    <tooltip > ... </tooltip>
    <tooltipres > ... </tooltipres>
  </state>
  <text > ... </text>
  <textres > ... </textres>
</buttoncontrol>

<buttoncontrol >

<allowdoubleclick />

If defined, then double clicks will trigger script onDoubleClick events; otherwise, double clicks will be treated as two separate single click events.

<color > ... </color>

Override color to be used when displaying text or icons (either single state or multi-state)

<font > ... </font>

Font resource for displaying text (either single state or multi-state)

<hover > ... </hover>

Defines appearance of button when mouse hovering over at the current state (for multi-state buttons) This tag supports the same subtags as the state tag.

<icon >

Icon resources to display on control (for single state buttons) (ignored if any state tags defined)

<normal > ... </normal>

The icon for the normal state

<pressed > ... </pressed>

The icon for the pressed state

<hover > ... </hover>

The icon for the hover state

</icon>

<pressed > ... </pressed>

Defines appearance of button when pressed at the current state (for multi-state buttons). This tag supports the same subtags as the state tag.

<state >

Defines appearance of button at the current state (for multi-state buttons)

<color > ... </color>

Override color for text/icon display. Supercedes main color tag.

<font > ... </font>

Font resource for displaying text. Supercedes main font tag.

<frame > ... </frame>

Frame resource to be displayed as background.

<frameoffset > ... </frameoffset>

Comma separated list of four numbers specifying the pixel margins applied to the frame. (left, top, right, bottom)

<icon > ... </icon>

Icon resource to be displayed.

<offset > ... </offset>

Comma separated list of two numbers specifying the offset applied to the display any resources displayed. (X offset, Y offset)

<text > ... </text>

Text to be displayed.

<textres > ... </textres>

String resource to be displayed.

<tooltip > ... </tooltip>

Text to be displayed when hovering over button.

<tooltipres > ... </tooltipres>

String resource to be displayed when hovering over button.

</state>

<text > ... </text>

Text to display on control (either single state or multi-state)

<textres > ... </textres>

String resource to display on control (either single state or multi-state)

</buttoncontrol>


Interface

getValue

Code Block
languagelua
function getValue()

...