Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@redtide
redtide committed Oct 25, 2023
1 parent 237020a commit 23d030e
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/bank_instrument.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ so it can be used in SFZ files set from [AriaProgram]\(s\), e.g.:
| Name | Type | Description / Value(s)
| --- | --- | ---
| name | string | the name of the define, e.g.: "$sample_dir"
| value | string | the value of the define, e.g.: "./some/path"
| value | string | the value of the define, e.g.: "./some/path", numeric or other define name

## AriaGUI

Expand Down
151 changes: 106 additions & 45 deletions docs/widgets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,57 @@ A button to run some command like open some webpage URL
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| command | string | a command, edit / launch_url TODO
| command | string | a command, see table below
| data0 | string | command parameter e.g.: "http://www.someplace.com/"
| image | string | the name of the image file (2 vertical frames button)
| inverted | bool | TODO
| inverted | int | 1 or not set (0?): inverted on off image frames

| Command name | Description / Value(s)
| --- | ---
| edit |
| launch_url | value in `data0``
| license | or `license_NNNN`

## GUIContainer

An abstract class / layout to contain GUI pages,
used in [TabView](#tabview) Panes

| Name | Type | Description / Value(s)
| --- | --- | ---
| eslot | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| path | string | xml filename of the contained GUI or define macro ID
| xoffset | int | TODO: might be border / margin / padding value
| yoffset | int | TODO: might be border / margin / padding value
| Name | Type | Description / Value(s)
| --- | --- | ---
| eslot | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| param_offset | int | TODO
| path | string | xml filename of the contained GUI or define macro *ID
| slot | int | TODO
| xoffset | int | TODO: might be border / margin / padding value
| yoffset | int | TODO: might be border / margin / padding value

## Keyboard

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| offsetN | int | with N = 0 to 5, 6 in total TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| start_key | int | first note key, e.g.: 0
| end_key | int | last note key, e.g.: 108
| offsetN | int | with N = 0 to 5, 6 in total TODO
| image | string | filename for the enabled white keys when pressed and unpressed
| image2 | string | filename for the enabled black keys when pressed and unpressed
| image3 | string | TODO
| image4 | string | TODO

## Knob

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y | int | coordinates
| eslot | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| image | string | the name of the image file (vertical frame images)
| frames | int | number of image frames
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y | int | coordinates
| eslot | int | TODO
| frames | int | number of image frames
| image | string | the name of the image file (vertical frame images)
| inverse | int | 1 or not set (0?): inverted on off image frames
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| vdefault | int | TODO

## Label

Expand All @@ -57,21 +67,51 @@ associated with the same `param`.
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| alignment | enum | left / center / right, the text alignment inside the rect
| color_text | RGBA | text color
| factor | int | TODO
| format | string | printf format string / FORMAT_LINEAR2DB / FORMAT_STEREOPAN
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| transparent | int | 1 or 0
| vdefault | int | TODO

## DragLabel

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| alignment | enum | left / center / right, the text alignment inside the rect
| color_text | RGBA | text color
| factor | int | TODO
| format | string | printf format string / FORMAT_LINEAR2DB / FORMAT_STEREOPAN
| transparent | bool | 1 or 0
| offset | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| transparent | int | 1 or 0
| vdefault | int | TODO

## OnOffButton

Vertical, 2 image frames button.

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| image | string | the name of the image file
| inverse | int | 1 or not set (0?): inverted on off image frames
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| image | string | the name of the image file (2 vertical frames button)

## NumericTextBox

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| alignment | enum | left / center / right, the text alignment inside the rect
| color_text | RGBA | text color
| factor | int | TODO
| format | string | printf format string / FORMAT_LINEAR2DB / FORMAT_STEREOPAN
| offset | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| transparent | int | 1 or 0

## OptionMenu

Expand All @@ -80,11 +120,12 @@ A LMB / RMB clickable label area to display a menu
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| alignment | enum | left / center / right, the text alignment inside the rect
| color_text | RGBA | e.g.: "#D7DAE0FF"
| font_size | enum | verysmall / small / normal / big / verybig
| transparent | bool | 1 or 0
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| transparent | int | 1 or 0
| vdefault | int | TODO

### OptionItem

Expand All @@ -95,28 +136,29 @@ OptionMenu item
| name | string | the menuitem label
| value | float | the value associated e.g.: 0.5678

## \<PrefixName\>Menu
## <PrefixName>Menu

A combobox controlled by a spinner.
The control name prefix is custom, e.g. "FileMenu"
The control name prefix is custom, e.g. "FileMenu", "KSMenu", "OutputMenu", "Preset"

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| eslot | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| target | URL | TODO: some effect URL, e.g.: "com.Vendor.Effectname"
| type | URL | TODO: same as target
| alignment | enum | left / center / right, the text alignment inside the rect
| color_text | RGBA | text color
| entry_empty | | TODO: might be bool like transparent
| entry_import | | TODO: might be bool like transparent
| entry_reload | | TODO: might be bool like transparent
| entry_empty | | TODO: might be int like transparent
| entry_import | | TODO: might be int like transparent
| entry_reload | | TODO: might be int like transparent
| entry_saveasdefault | int | TODO: might be int like transparent
| eslot | int | TODO
| font_size | enum | verysmall / small / normal / big / verybig
| image_next | string | arrow image filename
| image_previous | string | arrow image filename
| image_vertical_align | | TODO: might be bool like transparent
| transparent | bool | 1 or 0
| image_vertical_align | | TODO: might be int like transparent
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| target | URL | TODO: some effect URL, e.g.: "com.Vendor.Effectname"
| transparent | int | 1 or 0
| type | URL | TODO: same as target

## PopupOverlay

Expand All @@ -125,7 +167,7 @@ Overlay widget, might be the one displayed when registering an instrument
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| color_back | RGBA | semitransparent background color (e.g.: #00000060)
| color_back | RGBA | background color (e.g.: #00000060)

## ProgressBar

Expand All @@ -135,7 +177,6 @@ Overlay widget, might be the one displayed when registering an instrument
| image | string | image filename for a 2 frames progress bar
| | | TODO: empty and full? Verify this


## Rect

A drawn rectangle
Expand Down Expand Up @@ -165,21 +206,21 @@ when keeping pressed the LMB and moving the mouse left or right
| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| alignment | enum | left / center / right, the text alignment inside the rect
| base | int | TODO
| digit_max | int | maximum value, e.g."100" TODO: what's the difference with vmax?
| digit_min | int | minimum value, e.g."-100" TODO: what's the difference with vmin?
| image | string | the name of the image used for the numeric values
| minus_image | string | the name of the image used to add a minus for negative values
| plus_image | string | the name of the image used to add a plus for positive values
| numbers | int | value size, e.g. 2 for 0-99 or 3 for 0-100
| nbh | int | the number image height
| nbw | int | the number image width
| vmin | int | minimum value, e.g."-100"
| vmax | int | maximum value, e.g."100"
| digit_min | int | minimum value, e.g."-100" TODO: what's the difference with vmin?
| digit_max | int | maximum value, e.g."100" TODO: what's the difference with vmax?
| base | int | TODO
| granularity | int | TODO
| show_leading_zeros | int | TODO, possible bool like transparent
| numbers | int | value size, e.g. 2 for 0-99 or 3 for 0-100
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| show_leading_zeros | int | TODO, might be int like transparent
| vmax | int | maximum value, e.g."100"
| vmin | int | minimum value, e.g."-100"

## Splash

Expand All @@ -189,14 +230,15 @@ TODO: might be a splashscreen window
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| image | string | the filename of the background image
| url | string | URL TODO: probably open in browser on image click

## StaticImage

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| image | string | the name of the image file
| transparent | bool | 1 or 0
| transparent | int | 1 or 0

## StaticText

Expand All @@ -211,7 +253,27 @@ Non variable [Label](#label) like control
| color_text | RGBA | text color
| font_size | enum | verysmall / small / normal / big / verybig
| text | string | label displayed text
| transparent | bool | 1 or 0
| transparent | int | 1 or 0

## StepEditor

| Name | Type | Description / Value(s)
| --- | --- | ---
| x / y / w / h | int | coordinates and size
| border_color | RGBA |
| image | string | the name of the image file
| editor_border_color | RGBA |
| fill_color | RGBA |
| zero_color | RGBA |
| hoffset | int | TODO: might be border / margin / padding value
| voffset | int | TODO: might be border / margin / padding value
| nbstep | int | TODO
| param | int | numeric or macro defined id e.g.: 10 or ID_SOMETHING
| step_increment | int | step increment
| target | URL | TODO: some effect URL, e.g.: "com.Vendor.Effectname"
| transparent | int | 1 or 0
| vmax | int | maximum value, e.g."15"
| vmin | int | minimum value, e.g."0"

## TabView

Expand All @@ -235,4 +297,3 @@ TabView' page pane.
| --- | --- | ---
| image | image | filename of the pane background, optional
| imageb | image | filename of the button background (2 frames: clicked and released)

0 comments on commit 23d030e

Please sign in to comment.