Csound.Typed.Gui

Documentation

data Panel

Constructors

Single

Fields

• singleContent :: Win
• singleIsKeybdSensitive :: Bool

Tabs

Fields

• tabsTitle :: String
• tabsRect :: Maybe Rect
• tabsContent :: [Win]
• tabsIsKeybdSensitive :: Bool

data Win

Constructors

Win

Fields

• winTitle :: String
• winRect :: Maybe Rect
• winGui :: Gui

data GuiNode

Constructors

GuiNode

Fields

• guiNodeElem :: Gui
• guiNodeHandle :: GuiHandle

newtype GuiHandle

Constructors

GuiHandle

Fields

• unGuiHandle :: Int

newtype Gui

A visual representation of the GUI-element.

Constructors

Gui

Fields

• unGui :: LowGui

data Elem

Constructors

GuiVar GuiHandle

Count ValDiap ValStep (Maybe ValStep)

Joy ValSpan ValSpan

Knob ValSpan

Roller ValSpan ValStep

Slider ValSpan

Text ValDiap ValStep

Box String

ButBank Int Int

Button InstrId

Toggle

Value

Vkeybd

data InitMe

Constructors

InitMe

Fields

• initHandle :: Var
• initValue :: Double

restoreTree :: GuiMap -> Gui -> Gui

guiMap :: [GuiNode] -> GuiMap

mapGuiOnPanel :: (Gui -> Gui) -> Panel -> Panel

fromElem :: ElemOuts -> [InitMe] -> Elem -> Gui

fromGuiHandle :: GuiHandle -> Gui

panelIsKeybdSensitive :: Panel -> Bool

defText :: String -> Gui

guiStmt :: Monad m => ScaleFactor -> [Panel] -> DepT m ()

Layout

hor :: [Gui] -> Gui

Horizontal groupping of the elements. All elements are placed in the stright horizontal line and aligned by Y-coordinate and height.

ver :: [Gui] -> Gui

Vertical groupping of the elements. All elements are placed in the stright vertical line and aligned by X-coordinate and width.

space :: Gui

An empty space.

sca :: Double -> Gui -> Gui

Scales an element within the group. It depends on the type of the alignment (horizontal or vertical) which side of the bounding box is scaled. If it's a horizontal group then the width is scaled and height is scaled otherwise.

Every element in the group has a scaling factor. By default it equals to one. During rendering all scaling factors are summed and divided on the sum of all factors. So that factors become weights or proportions. This process is called normalization. Scaling one element affects not only this element but all other elements in the group!

An example:

One element is twice as large as the other two:

hor [a, b, sca 2 c]

Why is it so? Let's look at the hidden scaling factors:

hor [sca 1 a, sca 1 b, sca 2 c]

During rendering we scale all the scaling fators so that total sum equals to one:

hor [sca 0.25 a, sca 0.25 b, sca 0.5 c]

horSca :: [(Double, Gui)] -> Gui

Weighted horizontal grouping. It takes a list of scaling factors and elements.

verSca :: [(Double, Gui)] -> Gui

Weighted vertical grouping. It takes a list of scaling factors and elements.

padding :: Int -> Gui -> Gui

Sets the padding of the element. How much empty space to reserve outside the element.

margin :: Int -> Gui -> Gui

Sets the margin of the element. How much empty space to reserve between the elements within the group. It affects only compound elements.

type ScaleFactor = (Double, Double)

resizeGui :: ScaleFactor -> Gui -> Gui

Rescales the default sizes for the UI elements.

Props

props :: [Prop] -> Gui -> Gui

Sets the properties for a GUI element.

forceProps :: [Prop] -> Gui -> Gui

Sets the properties for a GUI element on all levels.

data Prop

Properties of the widgets.

Constructors

SetLabel String

SetMaterial Material

SetBoxType BoxType

SetColor1 Color

SetColor2 Color

SetTextColor Color

SetFontSize Int

SetFontType FontType

SetEmphasis Emphasis

SetSliderType SliderType

SetTextType TextType

SetButtonType ButtonType

SetOrient Orient

SetKnobType KnobType

SetLabelType LabelType

data BorderType

Constructors

NoBorder

DownBoxBorder

UpBoxBorder

EngravedBorder

EmbossedBorder

BlackLine

ThinDown

ThinUp

Instances

Enum BorderType

Methods

succ :: BorderType -> BorderType

pred :: BorderType -> BorderType

toEnum :: Int -> BorderType

fromEnum :: BorderType -> Int

enumFrom :: BorderType -> [BorderType]

enumFromThen :: BorderType -> BorderType -> [BorderType]

enumFromTo :: BorderType -> BorderType -> [BorderType]

enumFromThenTo :: BorderType -> BorderType -> BorderType -> [BorderType]

type Color = Colour Double

The Csound colours.

data Rect

A rectangle.

Constructors

Rect

Fields

• px :: Int
• py :: Int
• width :: Int
• height :: Int

Instances

Show Rect

Methods

showsPrec :: Int -> Rect -> ShowS

show :: Rect -> String

showList :: [Rect] -> ShowS

data FontType

Constructors

Helvetica

Courier

Times

Symbol

Screen

Dingbats

Instances

Default FontType

Methods

def :: FontType

data Emphasis

Constructors

NoEmphasis

Italic

Bold

BoldItalic

Instances

Default Emphasis

Methods

def :: Emphasis

data Material

The type of the material of the element. It affects sliders and buttons.

Constructors

NoPlastic

Plastic

Instances

Default Material

Methods

def :: Material

data Orient

The orientation of the widget (slider, roller). This property is never needs to be set in practice. If this property is not set then default orientation is calculated from the bounding box of the widget. If the width is greater than the height then we need to use a horizontal widget otherwise it should be a vertical one.

Constructors

Hor

Ver

data LabelType

Some values are not implemented on the Csound level.

Constructors

NormalLabel

NoLabel

SymbolLabel

ShadowLabel

EngravedLabel

EmbossedLabel

Instances

Default LabelType

Methods

def :: LabelType

Setters

Handy short-cuts for the function props.

setBorder :: BorderType -> Gui -> Gui

setLabel :: String -> Gui -> Gui

setMaterial :: Material -> Gui -> Gui

setLabelType :: LabelType -> Gui -> Gui

setColor1 :: Color -> Gui -> Gui

setColor2 :: Color -> Gui -> Gui

setColors :: Color -> Color -> Gui -> Gui

setTextColor :: Color -> Gui -> Gui

setFontSize :: Int -> Gui -> Gui

setFontType :: FontType -> Gui -> Gui

setEmphasis :: Emphasis -> Gui -> Gui

setOrient :: Orient -> Gui -> Gui

Widgets

data ValDiap

The diapason of the continuous value.

Constructors

ValDiap

Fields

• valDiapMin :: Double
• valDiapMax :: Double

type ValStep = Double

data ValScaleType

Constructors

Linear

Exponential

data ValSpan

A value span is a diapason of the value and a type of the scale (can be linear or exponential).

Constructors

ValSpan

Fields

• valSpanDiap :: ValDiap
• valSpanScale :: ValScaleType

linSpan :: Double -> Double -> ValSpan

Makes a linear ValSpan with specified boundaries.

linSpan minVal maxVal

expSpan :: Double -> Double -> ValSpan

Makes an exponential ValSpan with specified boundaries.

expSpan minVal maxVal

uspan :: ValSpan

Unit span. A special case:

uspan = linSpan 0 1

bspan :: ValSpan

Bipolar unit span. A special case:

uspan = linSpan (-1) 1

uspanExp :: ValSpan

An exponential unit span. A special case:

uspan = expSpan 0 1

data KnobType

Constructors

ThreeD (Maybe Int)

Pie

Clock

Flat

Instances

Default KnobType

Methods

def :: KnobType

setKnobType :: KnobType -> Gui -> Gui

data SliderType

Constructors

Fill

Engraved

Nice

Instances

Default SliderType

Methods

def :: SliderType

setSliderType :: SliderType -> Gui -> Gui

data TextType

Constructors

NormalText

NoDrag

NoEdit

Instances

Default TextType

Methods

def :: TextType

setTextType :: TextType -> Gui -> Gui

data BoxType

The type of the box. Some values are not implemented on the Csound level.

Constructors

FlatBox

UpBox

DownBox

ThinUpBox

ThinDownBox

EngravedBox

EmbossedBox

BorderBox

ShadowBox

Roundedbox

RoundedShadowBox

RoundedFlatBox

RoundedUpBox

RoundedDownBox

DiamondUpBox

DiamondDownBox

OvalBox

OvalShadowBox

OvalFlatBox

Instances

Enum BoxType

Methods

succ :: BoxType -> BoxType

pred :: BoxType -> BoxType

toEnum :: Int -> BoxType

fromEnum :: BoxType -> Int

enumFrom :: BoxType -> [BoxType]

enumFromThen :: BoxType -> BoxType -> [BoxType]

enumFromTo :: BoxType -> BoxType -> [BoxType]

enumFromThenTo :: BoxType -> BoxType -> BoxType -> [BoxType]

Default BoxType

Methods

def :: BoxType

setBoxType :: BoxType -> Gui -> Gui

data ButtonType

The type of the button. It affects toggle buttons and button banks.

In Csound buttons and toggle buttons are constructed with the same function (but with different button types). But in this library they are contructed by different functions (button and toggle). Normal button is a plain old button, but other values specify toggle buttons. So this property doesn't affect the buttons (since they could be only normal buttons).

Constructors

NormalButton

LightButton

CheckButton

RoundButton

Instances

Default ButtonType

Methods

def :: ButtonType

setButtonType :: ButtonType -> Gui -> Gui

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 :: [(String, Gui)] -> SE ()

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

keyTabs :: [(String, 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 :: String -> Maybe Rect -> Gui -> SE ()

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

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.

tabsBy :: String -> Maybe Rect -> [(String, 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 :: String -> Maybe Rect -> [(String, 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 :: String -> 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 :: String -> 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 :: String -> 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 :: String -> [Double] -> Source [Sig]

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

numeric :: String -> 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 :: String -> ValSpan -> Double -> Sink Sig

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

meter valueSpan initValue

box :: String -> 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 :: String -> Source (Evt Unit)

A FLTK widget opcode that creates a button.

button text

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

butBank :: String -> 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 :: String -> 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 :: String -> 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 :: String -> Int -> Int -> (Int, Int) -> Source Sig

toggle :: String -> 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 :: String -> Bool -> Source Sig

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

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

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

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

setToggleSig :: String -> Bool -> SinkSource Sig

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

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

Transformers

setTitle :: String -> Gui -> SE Gui

Appends a title to a group of widgets.

Keyboard

data KeyEvt

Keyboard events.

Constructors

Press Key

Release Key

Instances

Eq KeyEvt

Methods

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

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

Show KeyEvt

Methods

showsPrec :: Int -> KeyEvt -> ShowS

show :: KeyEvt -> String

showList :: [KeyEvt] -> ShowS

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

Eq Key

Methods

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

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

Show Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

keyIn :: KeyEvt -> Evt Unit

The stream of keyboard press/release events.