Button (Information button)
Infobuttons can be used to open html files in the system's default web browser. When clicked, the file passed to the file() identifier will be opened. The file can be a local file, or a full URL such as file("http://cabbageaudio.com")
.
This widget can be useful for providing help files, or any other additional information about your instruments.
infobutton file("file name"), active(val), alpha(val), bounds(x, y, width, height), colour:0("colour"), colour:1("colour"), fontColour:0("colour"), fontColour:1("colour"), identChannel("channel"), popup(val), imgFile("type", "file"), text("name"), visible(val), toFront(), widgetArray("chan", number),
Specific Identifiers
file("file name")
Sets the file that will be opened when a user clicks on the button. For convenience, the file passed to the file() identifier should reside in the same directory as the current .csd file. If not you will need to provide a full path to the requested file. You can also set a remote URL.git commit -m "updating docs"
Common Identifiers
active(val)
Will deactivate a control if 0 is passed. Controls which are deactivate can still be updated from Csound.
alpha(val)
A value between 0 and 1 will set the alpha blend value for the entire component. Can be useful if you need to fade widgets in and out.
bounds(x, y, width, height)
integer values that set position and size on screen(in pixels).
colour:0("colour")
This sets the colour of the button when it's value is 0. Any CSS or HTML colour string can be passed to this identifier. The colour identifier can also be passed an RBG, or RGBA value. All channel values must be between 0 and 255. For instance colour(0, 0, 255) will create a blue, while colour(0, 255, 0, 255) will create a green with an alpha channel set to full.
colour:1("colour")
This sets the colour of the button when it's value is 1. See above for details on valid colours.
You can create an invisible button by setting the colour to something with an alpha value of 0. Images can then be placed under the button to create an image button.
fontColour:0("colour")
Sets the colour of the text that appears on the button when it's in its off state. See above for details on valid colours.
fontColour:1("colour")
Sets the colour of the text that appears on the button when it's in its on state. See above for details on valid colours.
identChannel("channel") [!!! DEPRECATED !!!]
Although identifier channels still work, they are no longer supported. Please use the new guiMode("queue")
system and the cabbageSet opcodes instead. They are far more efficient then identifiers channel.
popup(val)
This identifier, used with an image or groupbox will convert the plant into a popup plant. The plant will not be shown on the instrument's main interface, but will instead appear when the user sets visible
to 1. < DAWs treat popup dialogue windows in different ways. As a result, you may notice inconsistent behaviour when running your instruments as plugins across a variety of different hosts.
imgFile("type", "file")
Use this identifier to set a unique .svg or .png file to be used instead of the default look and feel. "type" should be one of the following:
- "on" : sets the button image when it is on
- "off" : sets the button image when it is off
For more information see Using SVGs and PNGs
text("name")
"name" will be the text that appears on the widget.
visible(val)
A value of 0 will cause the widget to become invisible. Widgets have their visibility set to 1 by default.
toFront()
Brings a widget to the front of the z order. This identifier takses no arguments and is only intended for use with identifier channels.
widgetArray("chan", number) [!!! DEPRECATED !!!]
Deprecated. Please see the section on Managing large numbers of widgets
Example
<Cabbage>
form caption("Info Button Example") size(380, 300), guiMode("queue"), , colour(2, 145, 209) pluginId("def1")
infobutton bounds(16, 12, 340, 36) file("https://cabbageaudio.com/docs/introduction/") text("Load Cababge Documentation"), corners(5)
texteditor bounds(16, 68, 341, 72) channel("infoText"), readOnly(1), wrap(1), scrollbars(1)
</Cabbage>
<CsoundSynthesizer>
<CsOptions>
-n -d -+rtmidi=NULL -M0 -m0d
</CsOptions>e
<CsInstruments>
; Initialize the global variables.
ksmps = 32
nchnls = 2
0dbfs = 1
; Rory Walsh 2021
;
; License: CC0 1.0 Universal
; You can copy, modify, and distribute this file,
; even for commercial purposes, all without asking permission.
instr 1
SText = "An infobutton can be used to load a html file, or a hyperlink. It doesn't receive any information from Csound, but you can still update its appearance and position by sending identifier data to its channel"
cabbageSet "infoText", "text", SText
endin
</CsInstruments>
<CsScore>
;causes Csound to run for about 7000 years...
f0 z
;starts instrument 1 and runs it for a week
i1 0 z
</CsScore>
</CsoundSynthesizer>