gui: Control functions

The control functions are used to create and handle controls.

Common control functions

Functions that can be used on different types of controls.

	•guiControlSetText	Sets the text of a control that supports it.
	•guiControlRemove	Removes a control from a form.

The label is a simple control for showing text.

Creates a label to show text

The button can be clicked by the user to trigger events.

	•guiButtonCreate	Creates a button.
	•guiButtonClickEvent	Handles a click on the button.

The check box can be used both to show the status of something, and for user input.

	•guiCheckBoxCreate	Creates a new check box
	•guiCheckBoxChangeEvent	Handles the event when the check box changes status.
	•guiCheckBoxSetChecked	Sets if the check box is checked
	•guiCheckBoxIsChecked	Determines if the check box is checked.

The numeric spinner is used for entering numeric values.

	•guiSpinnerCreate	Creates a new spinner
	•guiSpinnerGetValue	Retrieves the value of the spinner
	•guiSpinnerSetValue	Sets the value of the spinner

The text box is used for entering text. Clicking the text box will show a dialog to change the value of the text box.

	•guiTextBoxCreate	Creates a text box.
	•guiTextBoxGetText	Retrieves the text.

The radio button is used for selecting between multiple choices.

	•guiRadioButtonCreate	Creates a radio button.
	•guiRadioButtonIsSelected	Checks if the radio button is selected.
	•guiRadioButtonSetSelected	Selects the radio button.

Progress bar

The progress bar is used for showing a process is progressing.

	•guiProgressBarCreate	Creates a progress bar.
	•guiProgressBarSetValue	Updates the value of the progress bar.

The list control can be used both for showing e.g. output from an ongoing process and for allowing the user to select between multiple choices.

	•guiListCreate	Creates a list control.
	•guiListSetItem	Set the value of a specific item.
	•guiListAppendText	Appends an item to the end of the list, dropping the first item if the list is full.
	•guiListGetSelected	Retrieves the index of the selected item.
	•guiListSetSelected	Selects an item.

The graph control can be used for visualizing data.

	•guiGraphCreate	Creates a new graph.
	•guiGraphSetBar	Set the value of a bar in the bar graph.
	•guiGraphSetLinePoint	Set the value of a point on a line graph.
	•guiGraphScrollNext	Append the entries to the graph.
	•guiGraphSetMarker	Adds a horizontal marker to the graph.