Difference between revisions of "Submit"

From HSYCO
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{UI Object Header}}[[Category:INCOMPLETE]]
+
{{UI Object Header}}
 +
A button used to submit the contents of a set of fields.
 +
It has several colors (depending on the skin) and three different sizes:
 +
* '''submit''' (standard size)
 +
* '''submitmini''' (medium size)
 +
* '''submitmicro''' (small size)
 +
 
 +
[[File:UI Object submit.png]]
 +
 
 +
For a tutorial on using this object, see [[Working with Forms]].
 +
For a custom image version, see [[SubmitImage]].
 +
 
 +
== Parameters ==
 +
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
 +
*'''color''':  the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
 +
*'''label''': the text label on the button. It can contain HTML tags
 +
 
 +
== Syntax ==
 +
(submit!<id> <pos>; <color>; <label>)
 +
 +
(submitmini!<id> <pos>; <color>; <label>)
 +
 +
(submitmicro!<id> <pos>; <color>; <label>)
 +
 
 +
E.g.
 +
(submit!submit1 x10y20; r; Submit)
 +
 +
(submitmini!submit1 r0c1; glass; Submit)
 +
 +
(submitmicro!submit1 x0y100; gr; Submit)
 +
 
 +
== UI Attributes ==
 +
{{UI Object Attributes (Common)}}
 +
{{UI Object Attributes (Button)}}

Latest revision as of 15:15, 28 January 2014

Note  For a description and a complete list of UI Objects, see UI Objects.

A button used to submit the contents of a set of fields. It has several colors (depending on the skin) and three different sizes:

  • submit (standard size)
  • submitmini (medium size)
  • submitmicro (small size)

UI Object submit.png

For a tutorial on using this object, see Working with Forms. For a custom image version, see SubmitImage.

Parameters

  • position: the object's position. Use the pixels or rows and columns coordinates format
  • color: the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
  • label: the text label on the button. It can contain HTML tags

Syntax

(submit!<id> <pos>; <color>; <label>)

(submitmini!<id> <pos>; <color>; <label>)

(submitmicro!<id> <pos>; <color>; <label>)

E.g.

(submit!submit1 x10y20; r; Submit)

(submitmini!submit1 r0c1; glass; Submit)

(submitmicro!submit1 x0y100; gr; Submit)

UI Attributes

Common attributes

Name Value Description
pos x<x>y<y> Position specified as x/y coordinates. E.g. x-5y10
visible true Default. Show the object
false Hide the object
blink true | slow Blink the object at a slow speed
fast Blink the object at a fast speed
false Stop the blinking
opacity 0.0 ... 1.0 Object opacity from 0 (not visible) to 1 (fully visible)
rotation 0 ... 360 Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner

Button attributes

Name Value Description
style red,green,blue... Set the button's style (color). Styles vary depending on the selected skin
enabled true Default. Enable the button
false Disable the button