Csound.Typed.Gui.Widget

Panels

panel :: Gui -> SE ()

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

keyPanel :: Gui -> SE ()

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

tabs :: [(Text, Gui)] -> SE ()

Renders the GUI elements with tabs. Rectangles are calculated automatically.

keyTabs :: [(Text, Gui)] -> SE ()

Renders the GUI elements with tabs. Rectangles are calculated automatically.

panels :: [Gui] -> SE ()

Renders a list of panels.

keyPanels :: [Gui] -> SE ()

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

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

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

keyPanelBy :: Text -> 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.

tabsBy :: Text -> Maybe Rect -> [(Text, Maybe Rect, Gui)] -> SE ()

Renders the GUI elements with tabs. We can specify the window title and rectangles for all tabs and for the main window.

keyTabsBy :: Text -> Maybe Rect -> [(Text, Maybe Rect, Gui)] -> SE ()

Renders the GUI elements with tabs. We can specify the window title and rectangles for all tabs and for the main window. Tabs are sensitive to keyboard events.

Types

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.

noInput :: Input ()

A value for widgets that produce nothing.

noOutput :: Output ()

A value for widgets that consume nothing.

noInner :: Inner

A value for stateless widgets.

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).

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

A widget constructor.

type Source a = SE (Gui, Input a)

A producer of the values.

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

A producer constructor.

type Sink a = SE (Gui, Output a)

A consumer of the values.

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

A consumer constructor.

type Display = SE Gui

A static element. We can only look at it.

display :: SE Gui -> Display

A display constructor.

type SinkSource a = SE (Gui, Output a, Input a)

sinkSource :: SE (Gui, Output a, Input a) -> SinkSource a

sourceSlice :: SinkSource a -> Source a

sinkSlice :: SinkSource a -> Sink a

mapSource :: (a -> b) -> Source a -> Source b

A handy function for transforming the value of producers.

mapGuiSource :: (Gui -> Gui) -> Source a -> Source a

A handy function for transforming the GUIs of producers.

mhor :: Monoid a => [Source a] -> Source a

Horizontal grouping of widgets that can produce monoidal values.

mver :: Monoid a => [Source a] -> Source a

Vertical grouping of widgets that can produce monoidal values.

msca :: Double -> Source a -> Source a

Scaling of widgets that can produce values.

Widgets

count :: ValDiap -> ValStep -> Maybe ValStep -> Double -> Source (Evt D)

Allows the user to increase/decrease a value with mouse clicks on a corresponding arrow button. Output is an event stream that contains values when counter changes.

count diapason fineValStep maybeCoarseValStep initValue

doc: http://www.csounds.com/manual/html/FLcount.html

countSig :: ValDiap -> ValStep -> Maybe ValStep -> Double -> Source Sig

A variance on the function count, but it produces a signal of piecewise constant function.

joy :: ValSpan -> ValSpan -> (Double, Double) -> Source (Sig, Sig)

It is a squared area that allows the user to modify two output values at the same time. It acts like a joystick.

joy valueSpanX valueSpanY (initX, initY)

doc: http://www.csounds.com/manual/html/FLjoy.html

knob :: Text -> ValSpan -> Double -> Source Sig

A FLTK widget opcode that creates a knob.

knob valueSpan initValue

doc: http://www.csounds.com/manual/html/FLknob.html

roller :: Text -> ValSpan -> ValStep -> Double -> Source Sig

FLroller is a sort of knob, but put transversally.

roller valueSpan step initVal

doc: http://www.csounds.com/manual/html/FLroller.html

slider :: Text -> ValSpan -> Double -> Source Sig

FLslider puts a slider into the corresponding container.

slider valueSpan initVal

doc: http://www.csounds.com/manual/html/FLslider.html

sliderBank :: Text -> [Double] -> Source [Sig]

Constructs a list of linear unit sliders (ranges in [0, 1]). It takes a list of init values.

numeric :: Text -> ValDiap -> ValStep -> Double -> Source Sig

numeric (originally FLtext in the Csound) allows the user to modify a parameter value by directly typing it into a text field.

numeric diapason step initValue

doc: http://www.csounds.com/manual/html/FLtext.html

meter :: Text -> ValSpan -> Double -> Sink Sig

A slider that serves as indicator. It consumes values instead of producing.

meter valueSpan initValue

box :: Text -> Display

A FLTK widget that displays text inside of a box. If the text is longer than 255 characters the text is split on several parts (Csound limitations).

box text

doc: http://www.csounds.com/manual/html/FLbox.html

button :: Text -> Source (Evt Unit)

A FLTK widget opcode that creates a button.

button text

doc: http://www.csounds.com/manual/html/FLbutton.html

butBank :: Text -> Int -> Int -> (Int, Int) -> Source (Evt (D, D))

A FLTK widget opcode that creates a bank of buttons. Result is (x, y) coordinate of the triggered button.

butBank xNumOfButtons yNumOfButtons

doc: http://www.csounds.com/manual/html/FLbutBank.html

butBankSig :: Text -> Int -> Int -> (Int, Int) -> Source (Sig, Sig)

A variance on the function butBank, but it produces a signal of piecewise constant function. Result is (x, y) coordinate of the triggered button.

butBank1 :: Text -> Int -> Int -> (Int, Int) -> Source (Evt D)

A FLTK widget opcode that creates a bank of buttons.

butBank xNumOfButtons yNumOfButtons

doc: http://www.csounds.com/manual/html/FLbutBank.html

butBankSig1 :: Text -> Int -> Int -> (Int, Int) -> Source Sig

toggle :: Text -> Bool -> Source (Evt D)

A FLTK widget opcode that creates a toggle button.

button text

doc: http://www.csounds.com/manual/html/FLbutton.html

toggleSig :: Text -> Bool -> Source Sig

A variance on the function toggle, but it produces a signal of piecewise constant function.

setNumeric :: Text -> ValDiap -> ValStep -> Double -> Sink Sig

FLtext that is sink shows current the value of a valuator in a text field.

setToggle :: Text -> Bool -> SinkSource (Evt D)

setToggleSig :: Text -> Bool -> SinkSource Sig

setKnob :: Text -> ValSpan -> Double -> SinkSource Sig

setSlider :: Text -> ValSpan -> Double -> SinkSource Sig

Transformers

setTitle :: Text -> Gui -> SE Gui

Appends a title to a group of widgets.

Keyboard

data KeyEvt

Keyboard events.

Constructors

Press Key

Release Key

Instances

Show KeyEvt

Defined in Csound.Typed.GlobalState.GE

Methods

showsPrec :: Int -> KeyEvt -> ShowS

show :: KeyEvt -> String

showList :: [KeyEvt] -> ShowS

Eq KeyEvt

Defined in Csound.Typed.GlobalState.GE

Methods

(==) :: KeyEvt -> KeyEvt -> Bool

(/=) :: KeyEvt -> KeyEvt -> Bool

data Key

Keys.

Constructors

CharKey Char

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

Scroll

CapsLook

LeftShift

RightShift

LeftCtrl

RightCtrl

Enter

LeftAlt

RightAlt

LeftWinKey

RightWinKey

Backspace

ArrowUp

ArrowLeft

ArrowRight

ArrowDown

Insert

Home

PgUp

Delete

End

PgDown

NumLock

NumDiv

NumMul

NumSub

NumHome

NumArrowUp

NumPgUp

NumArrowLeft

NumSpace

NumArrowRight

NumEnd

NumArrowDown

NumPgDown

NumIns

NumDel

NumEnter

NumPlus

Num7

Num8

Num9

Num4

Num5

Num6

Num1

Num2

Num3

Num0

NumDot

Instances

Show Key

Defined in Csound.Typed.GlobalState.GE

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Eq Key

Defined in Csound.Typed.GlobalState.GE

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

keyIn :: KeyEvt -> Evt Unit

The stream of keyboard press/release events.