Set the auto-positioning starting point to the position of a certain ui-element.

Means, autpositioning will place the next ui-element either underneath(when using reagirl.NextLine()) or next to the right of ui-element with element_id.

Note: when passing tabs as parameter, the next ui-element will be placed underneath it(as if you had used reagirl.NextLine())

Starts a new line, when autopositioning ui-elements using the _add-functions.

Gets/Sets the color of the background.

Note: if the user chose a color-theme for ReaGirl-guis, this color will be overridden by the theme-colors!

Adds a burgermenu to a gui.

You can autoposition the burgermenu by setting x and/or y to nil, which will position the new burgermenu after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The run-function gets as parameter:
- string element_id - the element_id as string of the pressed burgermenu that uses this run-function
- integer selected_menu_id - the index of the selected menu-entry. Note: will skip the top-entry of a submenu and grayed out menus!
- string selected_menu_name - the name of the selected menu-entry
- boolean menu_selection_checked - true, if the menu-selection-entry is checked; false, if not

Sets the menu of a burgermenu

Sets the menu of a burgermenu

Adds a button to a gui.

You can autoposition the button by setting x and/or y to nil, which will position the new button after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The run-function gets as parameter:
- string element_id - the element_id as string of the pressed button that uses this run-function

Gets a button's disabled(non clickable)-state.

Gets, if the individual edges of a button are rounded or square.

Gets a button's radius.

Sets a button as disabled(non clickable).

Sets, if the individual edges of a button are rounded or square.

Sets the radius of a button.

Adds a checkbox to a gui.

You can autoposition the checkbox by setting x and/or y to nil, which will position the new checkbox after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The run-function will get two parameters:
- string element_id - the element_id of the toggled checkbox
- boolean checkstate - the new checkstate of the checkbox

Note: to align multiple lines of checkboxes under each other, check out Checkbox_SetWidth.

Gets a checkbox's current checked-state.

Gets a checkbox's disabled(non clickable)-state.

Links a checkbox to a configvar-bit.

All changes to the configvar-bit will be immediately visible for this checkbox.
Clicking the checkbox also updates the configvar-bit immediately.

Note: this will only allow bitfield-integer config-vars. All others could cause malfunction of Reaper!

Read the Reaper Internals-docs for all available config-variables(run the action ultraschall_Help_Reaper_ConfigVars_Documentation.lua for more details)

If the checkbox was already linked to extstate or ini-file, the linked-state will be replaced by this new one.
Use reagirl.Checkbox_Unlink() to unlink the checkbox from extstate/ini-file/config var.

Links a checkbox to an extstate.

All changes to the extstate will be immediately visible for this checkbox.
Clicking the checkbox also updates the extstate immediately.

If the checkbox was already linked to a config-var or ini-file, the linked-state will be replaced by this new one.
Use reagirl.Checkbox_Unlink() to unlink the checkbox from extstate/ini-file/config var.

Links a checkbox to an ini-value.

All changes to the ini-value will be immediately visible for this checkbox.
Clicking the checkbox also updates the inivalue immediately.

If the checkbox was already linked to extstate or config-variable, the linked-state will be replaced by this new one.
Use reagirl.Checkbox_Unlink() to unlink the checkbox from extstate/ini-file/config var.

Links a checkbox to a toggle-command-state of an action.

All changes to the toggle-state will be immediately visible for this checkbox.
Clicking the checkbox also updates the toggle-state immediately, which also updates existing toolbar-button-states.
You can set run_command=true, which will run the action everytime the checkstate is toggled.
This might be important to use, if the action behind the toggle-state needs to be run to change states in Reaper AND toggle the toggle-state as well.
Keep it at run_command=false, if you only want to change the toggle-state of the action without running it.

Note: some actions only change toggle-action, when they are run(like "Transport: Toggle repeat"). In these cases, the action will be run as well.
This shouldn't affect regular actions.

If the checkbox was already linked to a config-var or ini-file, the linked-state will be replaced by this new one.
Use reagirl.Checkbox_Unlink() to unlink the checkbox from extstate/ini-file/config var.

Sets a checkbox's state of the checkbox.

Sets a checkbox as disabled(non clickable).

Unlinks a checkbox from extstate/ini-file/configvar.

Adds a color-rectangle to a gui.

When color_selector_when_clicked is set to true and a run-function is passed, the run-function will be run after the color-rectangle got closed.

You can autoposition the color-rectangle by setting x and/or y to nil, which will position the new color_rectangle after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

If you want to choose a color by name, use reagirl.Color_EnumerateNames() to get all possible color-names(all html-colornames as defined by the W3C are supported plus more).
Convert the name to the color-values using Color_GetColorValuesByName.
Colors who have a name are better for screen reader users, since the color name will be reported accordingly.

See this page for more details and color-names: https://www.w3.org/wiki/CSS/Properties/color/keywords

The run-function gets as parameter:
- string element_id - the element_id as string of the clicked color-rectangle that uses this run-function
- integer red - the red color-value
- integer green - the green color-value
- integer blue - the blue color-value

Note: if you want a decorative, non-clickable color-rectangle, use reagirl.DecorRectangle_Add()

Gets a color-rectangle's color.

Get, if the individual corners of a decorative rectangle are square or round.

Gets a color-rectangle's radius.

Sets the color of a color-rectangle.

Set, if the individual corners of a color-rectangle are square or round.

Sets the radius of a color-rectangle.

Enumerates all possible color-names. These names can be used with reagirl.Color_GetColorValuesByName to get the corresponding color-value.

Supports all standard html-names as defined by the W3C:

AliceBlue - 240, 248, 255
AntiqueWhite - 250, 235, 215
Aquamarine - 127, 255, 212
Azure - 240, 255, 255
Beige - 245, 245, 220
Bisque - 255, 228, 196
Black - 0, 0, 0
BlanchedAlmond - 255, 235, 205
Blue - 0, 0, 255
BlueViolet - 138, 43, 226
Brown - 165, 42, 42
BurlyWood - 222, 184, 135
CadetBlue - 95, 158, 160
Chartreuse - 127, 255, 0
Chocolate - 210, 105, 30
Coral - 255, 127, 80
CornflowerBlue - 100, 149, 237
Cornsilk - 255, 248, 220
Crimson - 220, 20, 60
Cyan - 0, 255, 255
DarkBlue - 0, 0, 139
DarkCyan - 0, 139, 139
DarkGoldenRod - 184, 134, 11
DarkGray - 169, 169, 169
DarkGreen - 0, 100, 0
DarkKhaki - 189, 183, 107
DarkMagenta - 139, 0, 139
DarkOliveGreen - 85, 107, 47
DarkOrange - 255, 140, 0
DarkOrchid - 153, 50, 204
DarkRed - 139, 0, 0
DarkSalmon - 233, 150, 122
DarkSeaGreen - 143, 188, 143
DarkSlateBlue - 72, 61, 139
DarkSlateGray - 37, 56, 60
DarkTurquoise - 0, 206, 209
DarkViolet - 148, 0, 211
DeepPink - 255, 20, 147
DeepSkyBlue - 0, 191, 255
DimGray - 105, 105, 105
DodgerBlue - 30, 144, 255
FireBrick - 178, 34, 34
FloralWhite - 255, 250, 240
ForestGreen - 34, 139, 34
Gainsboro - 220, 220, 220
GhostWhite - 248, 248, 255
Gold - 255, 215, 0
GoldenRod - 218, 165, 32
Gray - 128, 128, 128
Green - 0, 128, 0
GreenYellow - 173, 255, 47
HoneyDew - 240, 255, 240
HotPink - 255, 105, 180
IndianRed - 205, 92, 92
Indigo - 75, 0, 130
Ivory - 255, 255, 240
Khaki - 240, 230, 140
Lavender - 230, 230, 250
LavenderBlush - 255, 240, 245
LawnGreen - 124, 252, 0
LemonChiffon - 255, 250, 205
LightBlue - 173, 216, 230
LightCoral - 240, 128, 128
LightCyan - 224, 255, 255
LightGoldenRodYellow - 250, 250, 210
LightGray - 211, 211, 211
LightGreen - 144, 238, 144
LightPink - 255, 182, 193
LightSalmon - 255, 160, 122
LightSeaGreen - 32, 178, 170
LightSkyBlue - 135, 206, 250
LightSlateGray - 119, 136, 153
LightSteelBlue - 176, 207, 222
LightYellow - 255, 255, 224
Lime - 0, 255, 0
LimeGreen - 50, 205, 50
Linen - 250, 240, 230
Magenta - 255, 0, 255
Maroon - 128, 0, 0
MediumAquaMarine - 102, 205, 170
MediumBlue - 0, 0, 205
MediumOrchid - 186, 85, 211
MediumPurple - 147, 112, 219
MediumSeaGreen - 60, 179, 113
MediumSlateBlue - 123, 104, 238
MediumSpringGreen - 0, 250, 154
MediumTurquoise - 72, 209, 204
MediumVioletRed - 199, 21, 133
MidnightBlue - 25, 25, 112
MintCream - 245, 255, 250
MistyRose - 255, 228, 225
Moccasin - 255, 228, 181
NavajoWhite - 255, 222, 173
Navy - 0, 0, 128
OldLace - 254, 240, 227
Olive - 128, 128, 0
OliveDrab - 107, 142, 35
Orange - 255, 165, 0
OrangeRed - 255, 69, 0
Orchid - 218, 112, 214
PaleGoldenRod - 238, 232, 170
PaleGreen - 152, 251, 152
PaleTurquoise - 175, 238, 238
PaleVioletRed - 219, 112, 147
PapayaWhip - 255, 239, 213
PeachPuff - 255, 218, 185
Peru - 205, 133, 63
Pink - 255, 192, 203
Plum - 221, 160, 221
PowderBlue - 176, 224, 230
Purple - 128, 0, 128
RebeccaPurple - 102, 51, 153
Red - 255, 0, 0
RosyBrown - 188, 143, 143
RoyalBlue - 65, 105, 225
SaddleBrown - 139, 69, 19
Salmon - 250, 128, 114
SandyBrown - 244, 164, 96
SeaGreen - 46, 139, 87
SeaShell - 255, 245, 238
Sienna - 160, 82, 45
Silver - 192, 192, 192
SkyBlue - 135, 206, 235
SlateBlue - 106, 90, 205
SlateGray - 112, 128, 144
Snow - 255, 250, 250
SpringGreen - 0, 255, 127
SteelBlue - 70, 130, 180
Tan - 210, 180, 140
Teal - 0, 128, 128
Thistle - 216, 191, 216
Tomato - 255, 99, 71
Turquoise - 64, 224, 208
Violet - 238, 130, 238
Wheat - 245, 222, 179
WhiteSmoke - 245, 245, 245
Yellow - 255, 255, 0
YellowGreen - 154, 205, 50

Gets the color values by a color name.

Supports all standard html-names as defined by the W3C and more(use reagirl.Color_EnumerateNames to get all names):

AliceBlue - 240, 248, 255
AntiqueWhite - 250, 235, 215
Aquamarine - 127, 255, 212
Azure - 240, 255, 255
Beige - 245, 245, 220
Bisque - 255, 228, 196
Black - 0, 0, 0
BlanchedAlmond - 255, 235, 205
Blue - 0, 0, 255
BlueViolet - 138, 43, 226
Brown - 165, 42, 42
BurlyWood - 222, 184, 135
CadetBlue - 95, 158, 160
Chartreuse - 127, 255, 0
Chocolate - 210, 105, 30
Coral - 255, 127, 80
CornflowerBlue - 100, 149, 237
Cornsilk - 255, 248, 220
Crimson - 220, 20, 60
Cyan - 0, 255, 255
DarkBlue - 0, 0, 139
DarkCyan - 0, 139, 139
DarkGoldenRod - 184, 134, 11
DarkGray - 169, 169, 169
DarkGreen - 0, 100, 0
DarkKhaki - 189, 183, 107
DarkMagenta - 139, 0, 139
DarkOliveGreen - 85, 107, 47
DarkOrange - 255, 140, 0
DarkOrchid - 153, 50, 204
DarkRed - 139, 0, 0
DarkSalmon - 233, 150, 122
DarkSeaGreen - 143, 188, 143
DarkSlateBlue - 72, 61, 139
DarkSlateGray - 37, 56, 60
DarkTurquoise - 0, 206, 209
DarkViolet - 148, 0, 211
DeepPink - 255, 20, 147
DeepSkyBlue - 0, 191, 255
DimGray - 105, 105, 105
DodgerBlue - 30, 144, 255
FireBrick - 178, 34, 34
FloralWhite - 255, 250, 240
ForestGreen - 34, 139, 34
Gainsboro - 220, 220, 220
GhostWhite - 248, 248, 255
Gold - 255, 215, 0
GoldenRod - 218, 165, 32
Gray - 128, 128, 128
Green - 0, 128, 0
GreenYellow - 173, 255, 47
HoneyDew - 240, 255, 240
HotPink - 255, 105, 180
IndianRed - 205, 92, 92
Indigo - 75, 0, 130
Ivory - 255, 255, 240
Khaki - 240, 230, 140
Lavender - 230, 230, 250
LavenderBlush - 255, 240, 245
LawnGreen - 124, 252, 0
LemonChiffon - 255, 250, 205
LightBlue - 173, 216, 230
LightCoral - 240, 128, 128
LightCyan - 224, 255, 255
LightGoldenRodYellow - 250, 250, 210
LightGray - 211, 211, 211
LightGreen - 144, 238, 144
LightPink - 255, 182, 193
LightSalmon - 255, 160, 122
LightSeaGreen - 32, 178, 170
LightSkyBlue - 135, 206, 250
LightSlateGray - 119, 136, 153
LightSteelBlue - 176, 207, 222
LightYellow - 255, 255, 224
Lime - 0, 255, 0
LimeGreen - 50, 205, 50
Linen - 250, 240, 230
Magenta - 255, 0, 255
Maroon - 128, 0, 0
MediumAquaMarine - 102, 205, 170
MediumBlue - 0, 0, 205
MediumOrchid - 186, 85, 211
MediumPurple - 147, 112, 219
MediumSeaGreen - 60, 179, 113
MediumSlateBlue - 123, 104, 238
MediumSpringGreen - 0, 250, 154
MediumTurquoise - 72, 209, 204
MediumVioletRed - 199, 21, 133
MidnightBlue - 25, 25, 112
MintCream - 245, 255, 250
MistyRose - 255, 228, 225
Moccasin - 255, 228, 181
NavajoWhite - 255, 222, 173
Navy - 0, 0, 128
OldLace - 254, 240, 227
Olive - 128, 128, 0
OliveDrab - 107, 142, 35
Orange - 255, 165, 0
OrangeRed - 255, 69, 0
Orchid - 218, 112, 214
PaleGoldenRod - 238, 232, 170
PaleGreen - 152, 251, 152
PaleTurquoise - 175, 238, 238
PaleVioletRed - 219, 112, 147
PapayaWhip - 255, 239, 213
PeachPuff - 255, 218, 185
Peru - 205, 133, 63
Pink - 255, 192, 203
Plum - 221, 160, 221
PowderBlue - 176, 224, 230
Purple - 128, 0, 128
RebeccaPurple - 102, 51, 153
Red - 255, 0, 0
RosyBrown - 188, 143, 143
RoyalBlue - 65, 105, 225
SaddleBrown - 139, 69, 19
Salmon - 250, 128, 114
SandyBrown - 244, 164, 96
SeaGreen - 46, 139, 87
SeaShell - 255, 245, 238
Sienna - 160, 82, 45
Silver - 192, 192, 192
SkyBlue - 135, 206, 235
SlateBlue - 106, 90, 205
SlateGray - 112, 128, 144
Snow - 255, 250, 250
SpringGreen - 0, 255, 127
SteelBlue - 70, 130, 180
Tan - 210, 180, 140
Teal - 0, 128, 128
Thistle - 216, 191, 216
Tomato - 255, 99, 71
Turquoise - 64, 224, 208
Violet - 238, 130, 238
Wheat - 245, 222, 179
WhiteSmoke - 245, 245, 245
Yellow - 255, 255, 0
YellowGreen - 154, 205, 50

Gets the name of a color by its values.
These names can be used with reagirl.Color_GetColorValuesByName to get the corresponding color-value.

If a specific color-value has no standard-name, it will return "".

Supports all standard html-names as defined by the W3C:

AliceBlue - 240, 248, 255
AntiqueWhite - 250, 235, 215
Aquamarine - 127, 255, 212
Azure - 240, 255, 255
Beige - 245, 245, 220
Bisque - 255, 228, 196
Black - 0, 0, 0
BlanchedAlmond - 255, 235, 205
Blue - 0, 0, 255
BlueViolet - 138, 43, 226
Brown - 165, 42, 42
BurlyWood - 222, 184, 135
CadetBlue - 95, 158, 160
Chartreuse - 127, 255, 0
Chocolate - 210, 105, 30
Coral - 255, 127, 80
CornflowerBlue - 100, 149, 237
Cornsilk - 255, 248, 220
Crimson - 220, 20, 60
Cyan - 0, 255, 255
DarkBlue - 0, 0, 139
DarkCyan - 0, 139, 139
DarkGoldenRod - 184, 134, 11
DarkGray - 169, 169, 169
DarkGreen - 0, 100, 0
DarkKhaki - 189, 183, 107
DarkMagenta - 139, 0, 139
DarkOliveGreen - 85, 107, 47
DarkOrange - 255, 140, 0
DarkOrchid - 153, 50, 204
DarkRed - 139, 0, 0
DarkSalmon - 233, 150, 122
DarkSeaGreen - 143, 188, 143
DarkSlateBlue - 72, 61, 139
DarkSlateGray - 37, 56, 60
DarkTurquoise - 0, 206, 209
DarkViolet - 148, 0, 211
DeepPink - 255, 20, 147
DeepSkyBlue - 0, 191, 255
DimGray - 105, 105, 105
DodgerBlue - 30, 144, 255
FireBrick - 178, 34, 34
FloralWhite - 255, 250, 240
ForestGreen - 34, 139, 34
Gainsboro - 220, 220, 220
GhostWhite - 248, 248, 255
Gold - 255, 215, 0
GoldenRod - 218, 165, 32
Gray - 128, 128, 128
Green - 0, 128, 0
GreenYellow - 173, 255, 47
HoneyDew - 240, 255, 240
HotPink - 255, 105, 180
IndianRed - 205, 92, 92
Indigo - 75, 0, 130
Ivory - 255, 255, 240
Khaki - 240, 230, 140
Lavender - 230, 230, 250
LavenderBlush - 255, 240, 245
LawnGreen - 124, 252, 0
LemonChiffon - 255, 250, 205
LightBlue - 173, 216, 230
LightCoral - 240, 128, 128
LightCyan - 224, 255, 255
LightGoldenRodYellow - 250, 250, 210
LightGray - 211, 211, 211
LightGreen - 144, 238, 144
LightPink - 255, 182, 193
LightSalmon - 255, 160, 122
LightSeaGreen - 32, 178, 170
LightSkyBlue - 135, 206, 250
LightSlateGray - 119, 136, 153
LightSteelBlue - 176, 207, 222
LightYellow - 255, 255, 224
Lime - 0, 255, 0
LimeGreen - 50, 205, 50
Linen - 250, 240, 230
Magenta - 255, 0, 255
Maroon - 128, 0, 0
MediumAquaMarine - 102, 205, 170
MediumBlue - 0, 0, 205
MediumOrchid - 186, 85, 211
MediumPurple - 147, 112, 219
MediumSeaGreen - 60, 179, 113
MediumSlateBlue - 123, 104, 238
MediumSpringGreen - 0, 250, 154
MediumTurquoise - 72, 209, 204
MediumVioletRed - 199, 21, 133
MidnightBlue - 25, 25, 112
MintCream - 245, 255, 250
MistyRose - 255, 228, 225
Moccasin - 255, 228, 181
NavajoWhite - 255, 222, 173
Navy - 0, 0, 128
OldLace - 254, 240, 227
Olive - 128, 128, 0
OliveDrab - 107, 142, 35
Orange - 255, 165, 0
OrangeRed - 255, 69, 0
Orchid - 218, 112, 214
PaleGoldenRod - 238, 232, 170
PaleGreen - 152, 251, 152
PaleTurquoise - 175, 238, 238
PaleVioletRed - 219, 112, 147
PapayaWhip - 255, 239, 213
PeachPuff - 255, 218, 185
Peru - 205, 133, 63
Pink - 255, 192, 203
Plum - 221, 160, 221
PowderBlue - 176, 224, 230
Purple - 128, 0, 128
RebeccaPurple - 102, 51, 153
Red - 255, 0, 0
RosyBrown - 188, 143, 143
RoyalBlue - 65, 105, 225
SaddleBrown - 139, 69, 19
Salmon - 250, 128, 114
SandyBrown - 244, 164, 96
SeaGreen - 46, 139, 87
SeaShell - 255, 245, 238
Sienna - 160, 82, 45
Silver - 192, 192, 192
SkyBlue - 135, 206, 235
SlateBlue - 106, 90, 205
SlateGray - 112, 128, 144
Snow - 255, 250, 250
SpringGreen - 0, 255, 127
SteelBlue - 70, 130, 180
Tan - 210, 180, 140
Teal - 0, 128, 128
Thistle - 216, 191, 216
Tomato - 255, 99, 71
Turquoise - 64, 224, 208
Violet - 238, 130, 238
Wheat - 245, 222, 179
WhiteSmoke - 245, 245, 245
Yellow - 255, 255, 0
YellowGreen - 154, 205, 50

Get/set a new color-value for areas of the ui-elements. It will have an immediate effect on all ui-elements sharing that color.
Setting colors will affect only this ReaGirl-gui-instance.

Note: if the user has chosen a theme in the settings, then the theme settings will be used instead of the ones you try to set.

Also note: it will not check, if the colors are properly readable, so check twice, if readability is present by having huge contrasts between colors.
Also make a screenshot of your gui, put it into an image-program and turn it into grayscale. If everything is still readable, you are good to go. If not, then make some of the hard to read colors darker or brighter.
That way you can be sure, that color-blind people or people who need high contrast can read and use your gui.
(This is the reason, why a user-theme overrides your colors, as the user might want to choose a different color-layout for better readability for all ReaGirl-guis.)

The following colors can be set:

Gui_Background_Color - the background-color of the gui
Burgermenu_Area - the click-area of the burger-menu
Burgermenu_Stripes - the stripes of the burger-menu
Buttons_Area - the click-area of the button
Buttons_TextBG - the background of the button-text
Buttons_TextFG - the foreground of the button-text
Buttons_TextFG_disabled - the foreground-color of the button-text when the button is disabled
Checkbox_CheckArea - the area that's visible, when the checkbox is checked
Checkbox_CheckArea_disabled - the area that's visible, when the checkbox is checked and disabled
Checkbox_CaptionBG - the dropshadow of the caption
Checkbox_CaptionFG - the foreground-color of the caption
Checkbox_CaptionFG_disabled - the foreground-color of the caption when checkbos is disabled
Checkbox_background - the background of the checkbox(behind the checked-symbol
DropDownMenu_Area - the click-area of the dropdownmenu
DropDownMenu_AreaTextBG - the background of the text in the click-area of the dropdownmenu
DropDownMenu_AreaTextFG - the foreground of the text in the click-area of the dropdownmenu
DropDownMenu_AreaTextFGdisabled - the foreground of the text in the click-area when dropdownmenu is disabled
DropDownMenu_CaptionBG - the dropshadow of the caption of the dropdownmenu
DropDownMenu_CaptionFG - the foreground of the caption of the dropdownmenu
DropDownMenu_CaptionFGdisabled - the foreground of the caption of the dropdownmenu when it's disabled
DropDownMenu_Circle - the circle of the drop-down-area
DropDownMenu_Circle_disabled - the circle of the drop-down-area when disabled
Inputbox_Area - the typing-area of the inputbox
Inputbox_Cursor - the cursor of the inputbox
InputBox_CaptionBG - the dropshadow of the caption of the inputbox
Inputbox_CaptionFG - the foreground of the caption of the inputbox
Inputbox_CaptionFGdisabled - the foreground of the caption of the inputbox when it's disabled
InputBox_TextBGTyped - the background of the typed text of the inputbox
InputBox_TextFGTyped - the foreground of the typed text of the inputbox
InputBox_TextFGTypeddisabled - the foreground of the typed text of the inputbox when it's disabled
Inputbox_DropdownArea - the dropdown-area
Inputbox_DropdownArea_Circle - the circle of the drop-down-area
Inputbox_DropdownArea_Circle_disabled - the circle of the drop-down-area when disabled
Label_TextBG - the background of the label
Label_TextFG - the foreground of the label
Label_TextFGclickable - the foreground of the clickable label
Label_BackDrop - the backdrop of labels
Scrollbar_Background - the background of the scroll-bar
Scrollbar_Foreground - the foreground of the scroll-bar
Slider_Border - the border of the slider-area
Slider_Center - the center of the slider-area
Slider_Center_disabled - the center of the slider-area when slider is disabled
Slider_Circle_center - the center of the slider-knob
Slider_Circle_center_disabled - the center of the slider-knob, when slider is disabled
Slider_DefaultLine - the color of the default-line of the slider-area
Slider_CaptionBG - the drop-shadow of the slider-caption
Slider_CaptionFG - the foreground of the slider-caption
Slider_CaptionFG_disabled - the foreground of the slider-caption when slider is disabled
Tabs_Inner_Background - the background of the tab-area under the tabs(should be the same as Tabs_Inner_Tabs_Selected)
Tabs_Inner_Tabs_Selected - the color of the selected tab
Tabs_Inner_Tabs_Unselected - the color of the unselected tab
Tabs_CaptionBG - the drop-shadow of the tab-caption-texts
Tabs_CaptionFG - the foreground of the tab-caption-texts
Toolbar_Area - the click-area of the toolbar-button
Toolbar_CaptionBG - the drop-shadow of the caption
Toolbar_CaptionFG - the foreground of the caption
Toolbar_TextBG - the drop-shadow of the text-button
Toolbar_TextFG - the foreground-color of the text-button

Adds a decorative color-rectangle to a gui.

A decorative rectangle is only there for gui-design and has no functionality. You can't tab it or click it.

If you want to choose a color by name, use reagirl.Color_EnumerateNames() to get all possible color-names(all html-colornames as defined by the W3C are supported plus more).
Convert the name to the color-values using Color_GetColorValuesByName.
Colors who have a name are better for screen reader users, since the color name will be reported accordingly.

See this page for more details and color-names: https://www.w3.org/wiki/CSS/Properties/color/keywords

Note: if you want a clickable color-rectangle, use reagirl.ColorRectangle_Add()

Sets the color of a decorative-rectangle.

Get, if the individual corners of a decorative rectangle are square or round.

Gets the current radius of the edges of a decorative rectangle.

Sets the color of a decorative-rectangle.

Set, if the individual corners of a decorative rectangle are square or round.

Sets the radius of the edges of a decorative rectangle.

Adds a dropdown-menu to a gui.

You can autoposition the dropdown-menu by setting x and/or y to nil, which will position the new dropdown-menu after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The run-function gets as parameters:
- string element_id - the element_id
- integer selected_menu_entry - the selected menu entry number
- string selected_menu_entry_name - the name of the selected menu entry

Gets the width of a drop down menu.

Gets a dropdown-menu's disabled(non clickable)-state.

Gets a dropdown-menu's menu-items and the index of the currently selected menu-item.

Gets the selected menu item of a drop down menu.

Links a drop down menu to an extstate.

All changes to the extstate will be immediately visible for this drop down menu.

If the drop down menu was already linked to an ini-file, the linked-state will be replaced by this new one.
Use reagirl.DropDownMenu_UnLink() to unlink the drop down menu from extstate/ini-file/config var.

Links a drop down menu to an ini-file-entry.

All changes to the ini-file-entry will be immediately visible for this drop down menu.
Entering text into the inputbox also updates the ini-file-entry immediately.

If the drop down menu was already linked to an ini-file, the linked-state will be replaced by this new one.
Use reagirl.Inputbox_UnLink() to unlink the inputbox from extstate/ini-file/config var.

Sets the width of a dropdownmenu.

Sets a drop down menu as disabled(non clickable)-state.

Sets a dropdown-menu's menuitems and the index of the currently selected menu-item.

Sets the selected menu-item.

Unlinks a drop down menu from extstate/ini-file/configvar.

Returns, if any ReaGirl-window is currently hovered by the mouse.

Sends a message to a ui-element in a ReaGirl-gui.

To get the values needed for your target gui, go into ReaGirl-settings into the development-tab.
Choose the option to show gui/ui-element-name in the ReaScript console.

Then open the gui in question. Use Tab/Shift+Tab to select the ui-element you want to have. The ReaScript-console-window will show the name of the gui-window and the name of the currently focused ReaGirl-ui-element.
These you can use with this function by copying the names from within the quotes.

Note: events can also be sent to hidden ui-elements!

Also note: if multiple ui-elements have the same name, they will all be set with the same value(if they are the correct ui-element-type).

The run-functions of ui-elements that received events will be run as well.

The sent event will be executed in the next defer-cycle. If you send the same event multiple times to a ui-element within one defer-cycle, it will only be executed once.

Sends a message to a ui-element in a ReaGirl-gui.

To get the values needed for your target gui, go into ReaGirl-settings into the development-tab.
Choose the option to show gui/ui-element-name in the ReaScript console.

Then open the gui in question. Use Tab/Shift+Tab to select the ui-element you want to have. The ReaScript-console-window will show the name of the gui-window and the name of the currently focused ReaGirl-ui-element as well as its ID(if given).
These you can use with this function by copying the gui-name and the ui-element-id from within the quotes.

Note: events can also be sent to hidden ui-elements!

Also note: if multiple ui-elements have the same id, they will all be set with the same value(if they are the correct ui-element-type).

The run-functions of ui-elements that received events will be run as well.

The sent event will be executed in the next defer-cycle. If you send the same event multiple times to a ui-element within one defer-cycle, it will only be executed once.

Focuses a specific tab of a ReaGirl-gui-window.

Parameter gui_name is the same as the name set in the first parameter of Gui_Open.

You can set a focused tab even if the window isn't opened yet. It will be focused the next time the specified gui-window is opened.
It also works for opened gui-windows.

Returns the ReaGirl-UI-element the mouse is currently hovering above, including the window name and its unique identifier.
This returns it for any opened ReaGirl-gui-instance, not just the ones from the current gui.

If you just want to have the hovered ui-element of the current script, use reagirl.UI_Element_GetHovered().

Returns "" if the mouse is not hovered above any ui-element

Closes an opened ReaGirl-gui-window from the outside.

Parameter gui_name is the same as the name set in the first parameter of Gui_Open.

Returns false, if no window with the window name is currently opened.

Focuses an opened ReaGirl-gui-window.

Parameter gui_name is the same as the name set in the first parameter of Gui_Open.

Returns false, if no window with the window name is currently opened.

Returns the currently opened ReaGirl-window-instances.

The window_instances retval is of the following format:
  window_instance[index][1]="window name" - the name of the window-instance, as given in reagirl.Gui_Open()
  window_instance[index][2]="Guid" - a unique identifier for this ReaGirl-gui-instance
  
Only opened windows will be shown here!

Returns, how much processing time a ReaGirl-instance uses for its gui-management/drawing operations.

Gives you a hint, whether you have too many gui-elements in your gui that could cause lagging of the gui or Reaper.

Gets the current width, height, position and dockstate of a ReaGirl-gui-window.

Returns nil if no such window exists/was ever opened.

Returns, if a specific gui-window is open.

Resets a ReaGirl-gui-window to it's default window dimensions and dockstate.

Sets a new width, height, position and dockstate of a ReaGirl-gui-window.

To keep a parameter to its current state, set it to nil.

Adds a function that shall be run when someone hits Enter while the gui is opened.

Adds a function that shall be run when the gui is closed with reagirl.Gui_Close()

Good to do clean up or committing of settings.

Closes the gui-window.

Forces a refresh of the gui.

Returns the current boundaries of the ui-elements. Means, from 0 to the the farthest ui-element-width/height at right/bottom edge of the gui-window.
These boundaries are where the scrolling happens. If the boundaries are smaller/equal window size, all ui-elements are visible in the window and therefore no scrolling happens.

The first four retvals return the boundaries of all visible ui-elements, the last four return the boundaries of all ui-elements, including invisible.
Sticky ui-elements will be ignored.

Returns the current gui-name(as given by reagirl.Gui_Open()) and the current gui-instance-identifier.

Note: gui_name might be "" when Gui_Open has not been used yet!

gui_instance_identifier stays the same until the script stops, no matter how often you close and reopen the gui-window with reagirl.Gui_Open()

gets/sets the y-offset of the ui-element, when tabbing through it.

With this, you can prevent ui-elements getting stuck behind sticky elements when tabbing/scrolling through it.

Rule of thumb for y_offset_top:
Put the first ui-element right under the sticky element and use the same y-position as value for y_offset_top. That way, it looks seamless.

Checks, whether the gui-window is open.

Manages the gui-window.

Put this function in a defer-loop. It will manage, draw, show the gui.

Note: if you set the parameter keep_running to true, you don't need to add a defer-loop in your script.

Creates a new gui by removing all currently(if available) ui-elements.

Opens a gui-window. If x and/or y are not given, it will be opened centered.

ReaGirl stores in the background the position, size and dockstate of the window. Set restore_old_window_state=true to automatically reopen the window with the position, size and dockstate of the window when it was closed the last time.

Note for Mac-users: y=0 is at the top of the screen, not the bottom! So if you want to place a window at the top, use y=0!

Prevents the closing of the gui via esc-key for one defer-cycle.

Prevents the user from hitting the enter-key for one cycle, so the run-function for the enter-key is not run in this cycle.

Prevents the scrolling of the gui via keyboard/mousewheel/swiping for this defer-cycle.

Adds an image to the gui. This image can run a function when clicked on it.

Very important: write into meaningOfUI_Element a small description of what the image shows. This will help blind people know, what the image means and what to do with it.
If you can't know what the image shows(an image viewer for instance) explain what's the purpose of the image like "cover image for the project" or something.
Keep in mind: blind people can't see the image so any kind of description will help them understand your script.

You can have different images for different scaling-ratios. You put them into the same folder and name them like:
image-filename.png - 1x-scaling
image-filename-2x.png - 2x-scaling
image-filename-3x.png - 3x-scaling
image-filename-4x.png - 4x-scaling
image-filename-5x.png - 5x-scaling
image-filename-6x.png - 6x-scaling
image-filename-7x.png - 7x-scaling
image-filename-8x.png - 8x-scaling

If a filename doesn't exist, it reverts to the default one for 1x-scaling.

ReaGirl will obey transparency set in png-images.
  
Images can be set to draggable. See Image_GetDraggable and Image_SetDraggable for enabling
dragging of the image to a destination ui-element.

The run_function will get three parameters:
- string element_id - the guid of the image
- string filename - the filename of the image
- optional string dropped_element_id - the element_id of the destination, where the image has been
dragged to
  
You can autoposition the image by setting x and/or y to nil, which will position the new image after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

If you want to force the image to be displayed with correct aspect ratio, see Image_KeepAspectRatio.

Clears the image with a set r-g-b-color. It also clears the previously loaded image-filename.

Gets, if auto-update has been enabled for an image.

Auto-update means, that the image is reloaded automatically when the file is changed. Will only check for the unscaled, original image-file,
so if you want to auto-update scaled images, you need to update the unscaled image last.

Used for things like "Cover images" where the user can update the cover-image in another app, so it instantly gets reloaded when the user has finished saving the file.

The updating happens three seconds after the image-file has finished saving.

Gets the width and height of an image.

Gets the current draggable state of an image.

When draggable==true: if the user drags the image onto a different ui-element, the run_function of
the image will get a third parameter, holding the element_id of the destination-ui-element of the dragging.
Otherwise this third parameter will be nil.

Add a note in the meaningOfUI_element and the name of the image/caption of the ui-element, which clarifies, which ui-element is a source
and which is a target for dragging operations, so blind users know, which image can be dragged and whereto.
Otherwise, blind users will not know what to do!

Gets, if the image is drawn with a drop-shadow. This is helpful for images, that might not be correctly visible in either light or dark-theme or if conflicting colors are chosen by the user or the script.

Returns the filename of the currently loaded image.

Set if the image shall keep its aspect ratio when shown.

Loads a new image-file of an existing image in the gui.

You can have different images for different scaling-ratios. You put them into the same folder and name them like:
image-filename.png - 1x-scaling
image-filename-2x.png - 2x-scaling
image-filename-3x.png - 3x-scaling
image-filename-4x.png - 4x-scaling
image-filename-5x.png - 5x-scaling
image-filename-6x.png - 6x-scaling
image-filename-7x.png - 7x-scaling
image-filename-8x.png - 8x-scaling

If a scaled-filename doesn't exist, the function reverts to the default one for 1x-scaling.

Realoads an image.

Sets auto-update-state for an image.

Auto-update means, that the image is reloaded automatically when the file is changed. Will only check for the unscaled, original image-file,
so if you want to auto-update scaled images, you need to update the unscaled image last.

Used for things like "Cover images" where the user can update the cover-image in another app, so it instantly gets reloaded when the user has finished saving the file.

The updating happens three seconds after the image-file has finished saving.

Sets the width and height of an image.

Sets the current draggable state of an image.

When draggable==true: if the user drags the image onto a different ui-element, the run_function of
the image will get a third parameter, holding the element_id of the destination-ui-element of the dragging.
Otherwise this third parameter will be nil.

Add a note in the meaningOfUI_element and the name of the image/caption of the ui-element, which clarifies, which ui-element is a source
and which is a target for dragging operations, so blind users know, which image can be dragged and whereto.
Otherwise, blind users will not know what to do!

Sets, if the image shall be drawn with a drop-shadow. This is helpful for images, that might not be correctly visible in either light or dark-theme or if conflicting colors are chosen by the user or the script.

Adds an inputbox to a gui.

You can autoposition the inputbox by setting x and/or y to nil, which will position the new inputbox after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The caption will be shown before the inputbox.    

Unlike other ui-elements, this one has the option for two run_functions, one for when the user hits enter in the inputbox and one for when the user types anything into the inputbox.

Important:
Screen reader users get an additional dialog shown when entering text, that will NOT run the run-function for typed text. This is due some limitations in Reaper's API and can't be circumvented.
So you can't rely only on the run_function_type but also need to add a run_function_enter, when you want to use the value immediately when typed in your script(like setting as a setting into an ini-file).
Otherwise blind users would be able to enter text but it will be ignored at hitting enter by your code, which would be unfortunate.

The run-functions get as parameters:
- string element_id - the element_id as string
- string text - the currently entered text

Gets an inputbox's current cursor offset.

Gets an inputbox's disabled(non clickable)-state.

gets an inputbox to show * instead of the text(for password entry, etc)

Gets an inputbox's currently selected text.

Gets an inputbox's current text.

Gets the currently available text-suggestions of an inputbox, that can be chosen by the user via a drop-down-menu in the inputbox.

Text suggestions are not available for screen reader users, due to API-limitations.

Links an inputbox to a configvar.

All changes to the configvar will be immediately visible for this inputbox.
Entering text also updates the configvar-bit immediately.

Note: this will only allow string config-variables. All others could cause malfunction of Reaper!

Read the Reaper Internals-docs for all available config-variables(run the action ultraschall_Help_Reaper_ConfigVars_Documentation.lua for more details)

If the inputbox was already linked to extstate or ini-file, the linked-state will be replaced by this new one.
Use reagirl.Inputbox_Unlink() to unlink the inputbox from extstate/ini-file/config var.

Links an inputbox to an extstate.

All changes to the extstate will be immediately visible for this inputbox.

If the inputbox was already linked to a config-var or ini-file, the linked-state will be replaced by this new one.
Use reagirl.Inputbox_UnLink() to unlink the inputbox from extstate/ini-file/config var.

Links an inputbox to an ini-file-entry.

All changes to the ini-file-entry will be immediately visible for this inputbox.
Entering text into the inputbox also updates the ini-file-entry immediately.

If the inputbox was already linked to a config-var or extstate, the linked-state will be replaced by this new one.
Use reagirl.Inputbox_UnLink() to unlink the inputbox from extstate/ini-file/config var.

Sets an inputbox as disabled(non clickable).

Sets an inputbox's shown text when nothing has been input.

Sets an inputbox to show * instead of the text(for password entry, etc)

Sets a new text of an inputbox.

Will remove newlines from it.

Sets text-suggestions, that can be chosen by the user via a drop-down-menu in the inputbox.

Text suggestions are not available for screen reader users, due to API-limitations.

Unlinks an inputbox from extstate/ini-file/configvar.

Adds a label to the gui.

You can autoposition the label by setting x and/or y to nil, which will position the new label after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

It is possible to make labels draggable. See Label_SetDraggable and Label_GetDraggable for how to do it.

The run-function will get as parameters:
- string element_id - the element_id of the clicked label
- optional string dropped_element_id - the element_id of the ui-element, onto which the label was dragged

Sets a backdrop from label to underneath a specific ui-element defined by dest_element_id.
It will be autosized. The width will be determined from all ui-elements currently visible, the height will be determined by the position and height of dest_element_id.

To use it: determine, which ui-element shall be the lowest inside the rectangle(like one directly above the bottom line of the backdrop.)
Any ui-element in the same line does the trick. However, you should choose the highest ui-element in the lowest line or the backdrop might be drawn through it.

Gets the alignment of a label.

Sets a background-rectangle in line-style for this label. You can use this to "include" different ui-elements of a common context underneath this label.
That way, you can structure your guis a little better.

Set height to 1 to just have a line before and after the first line of the label-text.

Gets the current draggable state of a label.

When draggable==true: if the user drags the label onto a different ui-element, the run_function of
the label will get a second parameter, holding the element_id of the destination-ui-element of the dragging.
Otherwise this second parameter will be nil.

Add a note in the meaningOfUI_element of the label of the ui-element, which clarifies, which ui-element is a source
and which is a target for dragging operations, so blind users know, which label can be dragged and whereto.
Otherwise, blind users will not know what to do!

Gets the font-size of a label.

Gets the text of a label.

Gets the style of a label.

Sets the font-size of a label.

Sets a background-rectangle in line-style for this label. You can use this to "include" different ui-elements of a common context underneath this label.
That way, you can structure your guis a little better.

Set height to 1 to just have a line before and after the first line of the label-text.

Sets the current draggable state of a label.

When draggable==true: if the user drags the label onto a different ui-element, the run_function of
the label will get a second parameter, holding the element_id of the destination-ui-element of the dragging.
Otherwise this second parameter will be nil.

Add a note in the meaningOfUI_element of the ui-element, which clarifies, which ui-element is a source
and which is a target for dragging operations, so blind users know, which label can be dragged and whereto.
Otherwise, blind users will not know what to do!

Sets the font-size of a label.

Sets a new label text to an already existing label.

Sets the style of a label.

You can combine different styles with each other in style1 through style3.

Adds a meter to a gui.

You can autoposition the meter by setting x and/or y to nil, which will position the new meter after the last ui-element.
To autoposition into the next line, use reagirl.NextLine()

The run-function will get two parameters:
- string element_id - the element_id of the meter
- number db_value - the current db_value

Note: the run-function will be run in every single defer-cycle! Helpful when linked to hardware inputs or track-level.

Gets, to which a meter is currently linked.