Csound.Control.Gui

GUI (Graphical User Interface) elements are handy to change the parameters of the sound in real time. It includes sliders, knobs, rollers, buttons and other widgets.

A GUI element consists of two parts. They are view (how it looks) and logic (what's going on with it). For example a slider can be horizontal or vertical or green or yellow or small or big. It's the view of the slider. And a slider can produce a continuous signal within the given interval. It's a logic of the slider.

Let's talk about the view. The view is divided on two parts:

• where element is placed or Layout.
• all other properties or just Properties.

The layout is defined with very simple functions. There are vertical and horizontal grouping of the elements. We can scale the element within the group and include an empty space in the group. Everything is aligned (see Csound.Gui.Layout). Other properties include colors, fonts (size and type), borders, specific properties of the widgets (see Csound.Gui.Props).

Let's consider the logic. The logic consists of three parts:

• what is consumed (Output)
• what is produced (Input)
• what's going on inside (Inner)

A widget can react on values, produce values or do something useful. There are special types of widgets:

• Source - they produce values only
• Sink - they consume values only
• Display - something is going on inside them (for example, it can show a hello world message)

Widgets can be simple and compound. Simple widgets are primitive elements (sliders, knobs, rollers, buttons). We have a special constructors that produce simple widgets (see Csound.Gui.Widget). Compound widgets glue together several widgets. That is the view contains several elements and all of them involved in the logic of the widget.

Gui

data Gui

A visual representation of the GUI-element.

type Widget a b = SE (Gui, Output a, Input b, Inner)

A widget consists of visible element (Gui), value consumer (Output) and producer (Input) and an inner state (Inner).

type Input a = a

Widgets that produce something has inputs.

type Output a = a -> SE ()

Widgets that consume something has outputs.

type Inner = SE ()

Widgets that just do something inside them or have an inner state.

type Sink a = SE (Gui, Output a)

A consumer of the values.

type Source a = SE (Gui, Input a)

A producer of the values.

type Display = SE Gui

A static element. We can only look at it.

widget :: SE (Gui, Output a, Input b, Inner) -> Widget a b

A widget constructor.

sink :: SE (Gui, Output a) -> Sink a

A consumer constructor.

source :: SE (Gui, Input a) -> Source a

A producer constructor.

display :: SE Gui -> Display

A display constructor.

Panels

panel :: Gui -> SE ()

Renders the GUI elements on the window. Rectangle is calculated automatically (window doesn't listens for keyboard events).

panels :: [Gui] -> SE ()

Renders a list of panels.

panelBy :: String -> Maybe Rect -> Gui -> SE ()

Renders the GUI elements on the window. We can specify the window title and rectangle of the window.

keyPanel :: Gui -> SE ()

Renders the GUI elements on the window. Rectangle is calculated automatically (window listens for keyboard events).

keyPanels :: [Gui] -> SE ()

Renders a list of panels. Panels are sensitive to keyboard events.

keyPanelBy :: String -> Maybe Rect -> Gui -> SE ()

Renders the GUI elements on the window. We can specify the window title and rectangle of the window. Panesls are sensitive to keyboard events.

Re-exports

module Csound.Control.Gui.Layout

module Csound.Control.Gui.Props

module Csound.Control.Gui.Widget