426a09ca4a
This is a bundle of changes to the "new" GML documentation that I just noticed two hours ago. - Fix a bunch of typos, wording and style - Rework layout object documentation (they're not widgets!) - Document most of the common properties - Finish (as for now) GML syntax documentation - Extend GML usage explanation - Add symlink "GML" so that man gml works - Add a categorized GML page list to the introduction man page - Cross-link much more Much of the editing of existing docs is clearing up incorrect or imprecise statements. Note that because of massive changes in some places, git won't recognize renames as such.
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
## Name
|
|
|
|
## Description
|
|
|
|
Defines a GUI Button widget.
|
|
|
|
## Synopsis
|
|
|
|
`@GUI::Button`
|
|
|
|
## Examples
|
|
|
|
```gml
|
|
@GUI::Button {
|
|
name: "normal_button"
|
|
text: "Button"
|
|
}
|
|
|
|
@GUI::Button {
|
|
name: "disabled_normal_button"
|
|
text: "Disabled"
|
|
enabled: false
|
|
}
|
|
```
|
|
|
|
## Registered Properties
|
|
|
|
| Property | Type | Possible values | Description |
|
|
| ------------ | ------ | --------------- | ----------------------------------------------------------------------------------------------------- |
|
|
| button_style | enum | Normal, Coolbar | Sets the style of the button |
|
|
| text | string | Any string | Sets the label text |
|
|
| checked | bool | true or false | Whether the button is checked; this only applies to checkable subclasses |
|
|
| checkable | bool | true or false | Whether the button can be checked; this only applies to checkable subclasses |
|
|
| exclusive | bool | true or false | Whether the button's check state is exclusive to its group; this only applies to checkable subclasses |
|