Safe Haskell	Safe-Inferred

Ui.Event

Contents

types
access
- Orientation
modify
misc
style

Description

The main attributes of an event are its duration and text. The starting time is actually in the Track.

Events can display a signal, which will be rendered in the background in one of a few ways: a color, or a graph.

The text in events never changes size, even when you zoom in or out. If an Event gets too small for its text, it collapses into a blue chunk, which is the standard color for some data that didn't fit.

The beginning of the Event is marked with a red line. The text will begin slightly below the line, but still try to fit within the event. If the Event end doesn't give room for the text, the text will overlap the line so that its bottom touches the bottom of the Event. If there is no room for the text at all, because of other text or the top of the Event, the text will disappear and the line will be blue, to mark hidden text.

No Event may overlap another Event on the same Track.

Synopsis

data Event
data Stack = Stack {
- stack_stack :: !Stack.Stack
- stack_key :: !IndexKey
}
type IndexKey = ScoreTime.TrackTime
event :: ScoreTime.ScoreTime -> ScoreTime.ScoreTime -> Text -> Event
clear_integration :: Event -> Event
start :: Event -> ScoreTime.TrackTime
duration :: Event -> ScoreTime.TrackTime
text :: Event -> Text
style :: Event -> Style.StyleId
stack :: Event -> Maybe Stack
start_ :: Lens.Lens Event ScoreTime.TrackTime
duration_ :: Lens.Lens Event ScoreTime.TrackTime
text_ :: Lens.Lens Event Text
style_ :: Lens.Lens Event Style.StyleId
stack_ :: Lens.Lens Event (Maybe Stack)
end_ :: Lens.Lens Event ScoreTime.TrackTime
set_text_raw :: Text -> Event -> Event
end :: Event -> ScoreTime.ScoreTime
range :: Event -> (ScoreTime.ScoreTime, ScoreTime.ScoreTime)
overlaps :: ScoreTime.ScoreTime -> Event -> Bool
min :: Event -> ScoreTime.ScoreTime
max :: Event -> ScoreTime.ScoreTime
orientation :: Event -> Types.Orientation
orientation_of :: ScoreTime.TrackTime -> Types.Orientation
is_negative :: Event -> Bool
is_positive :: Event -> Bool
unmodified :: Event -> Event
set_start :: ScoreTime.ScoreTime -> Event -> Event
set_end :: ScoreTime.ScoreTime -> Event -> Event
place :: ScoreTime.ScoreTime -> ScoreTime.ScoreTime -> Event -> Event
round :: Event -> Event
intern_event :: Map Text (Text, Int) -> Event -> (Map Text (Text, Int), Event)
type EventStyle = Text -> Event -> Style.StyleId

types

data Event Source #

Instances

Instances details

Show Event Source #
Instance details Defined in Ui.Event Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
CStorable Event Source #
Instance details Defined in Ui.Event Methods sizeOf :: Event -> Int # alignment :: Event -> Int # peekElemOff :: Ptr Event -> Int -> IO Event # pokeElemOff :: Ptr Event -> Int -> Event -> IO () # peekByteOff :: Ptr b -> Int -> IO Event # pokeByteOff :: Ptr b -> Int -> Event -> IO () # peek :: Ptr Event -> IO Event # poke :: Ptr Event -> Event -> IO () #
DeepSeq.NFData Event Source #
Instance details Defined in Ui.Event Methods rnf :: Event -> () #
Eq Event Source #
Instance details Defined in Ui.Event Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Pretty.Pretty Event Source #
Instance details Defined in Ui.Event Methods pretty :: Event -> Text Source # format :: Event -> Doc Source # formatList :: [Event] -> Doc Source #
Serialize.Serialize Event Source #
Instance details Defined in Ui.Event Methods put :: Putter Event Source # get :: Serialize.Get Event Source #

data Stack Source #

Constructors

Stack
Fields stack_stack :: !Stack.Stack The stack is used so the event retains a reference to its generating event. stack_key :: !IndexKey

Instances

Instances details

Show Stack Source #
Instance details Defined in Ui.Event Methods showsPrec :: Int -> Stack -> ShowS # show :: Stack -> String # showList :: [Stack] -> ShowS #
DeepSeq.NFData Stack Source #
Instance details Defined in Ui.Event Methods rnf :: Stack -> () #
Eq Stack Source #
Instance details Defined in Ui.Event Methods (==) :: Stack -> Stack -> Bool # (/=) :: Stack -> Stack -> Bool #
Ord Stack Source #
Instance details Defined in Ui.Event Methods compare :: Stack -> Stack -> Ordering # (<) :: Stack -> Stack -> Bool # (<=) :: Stack -> Stack -> Bool # (>) :: Stack -> Stack -> Bool # (>=) :: Stack -> Stack -> Bool # max :: Stack -> Stack -> Stack # min :: Stack -> Stack -> Stack #
Pretty.Pretty Stack Source #
Instance details Defined in Ui.Event Methods pretty :: Stack -> Text Source # format :: Stack -> Doc Source # formatList :: [Stack] -> Doc Source #
Serialize.Serialize Stack Source #
Instance details Defined in Ui.Event Methods put :: Putter Stack Source # get :: Serialize.Get Stack Source #

type IndexKey = ScoreTime.TrackTime Source #

This is the original position of the event on its integrated track. I can use this to find the (hopefully) equivalent event from the next integration to apply it even if the event has been moved or altered.

Keying on just the position has the effect that moving an event means to move any event that is generated at that position. This might be perfectly reasonable or even desirable since it's easier to understand. I'll have to see what kinds of edits and what kinds of reintegrations are likely in practice.

event :: ScoreTime.ScoreTime -> ScoreTime.ScoreTime -> Text -> Event Source #

Event constructor.

clear_integration :: Event -> Event Source #

Recreate the event without the integrated-from metadata.

access

start :: Event -> ScoreTime.TrackTime Source #

duration :: Event -> ScoreTime.TrackTime Source #

text :: Event -> Text Source #

style :: Event -> Style.StyleId Source #

stack :: Event -> Maybe Stack Source #

start_ :: Lens.Lens Event ScoreTime.TrackTime Source #

duration_ :: Lens.Lens Event ScoreTime.TrackTime Source #

text_ :: Lens.Lens Event Text Source #

style_ :: Lens.Lens Event Style.StyleId Source #

stack_ :: Lens.Lens Event (Maybe Stack) Source #

end_ :: Lens.Lens Event ScoreTime.TrackTime Source #

set_text_raw :: Text -> Event -> Event Source #

end :: Event -> ScoreTime.ScoreTime Source #

Return the position at the end of the event. If it has a negative duration, this will be before the start.

range :: Event -> (ScoreTime.ScoreTime, ScoreTime.ScoreTime) Source #

overlaps :: ScoreTime.ScoreTime -> Event -> Bool Source #

min :: Event -> ScoreTime.ScoreTime Source #

max :: Event -> ScoreTime.ScoreTime Source #

Orientation

orientation :: Event -> Types.Orientation Source #

orientation_of :: ScoreTime.TrackTime -> Types.Orientation Source #

is_negative :: Event -> Bool Source #

is_positive :: Event -> Bool Source #

modify

unmodified :: Event -> Event Source #

Mark this is a generated event, which has not yet been modified.

set_start :: ScoreTime.ScoreTime -> Event -> Event Source #

Move the start only. This could invert the duration if the start moves past the end.

set_end :: ScoreTime.ScoreTime -> Event -> Event Source #

Redundant with the end_ lens, but here for symmetry with set_start.

place :: ScoreTime.ScoreTime -> ScoreTime.ScoreTime -> Event -> Event Source #

round :: Event -> Event Source #

Round event times as described in ScoreTime.round.

TODO used by Events, do I really need this?

misc

intern_event :: Map Text (Text, Int) -> Event -> (Map Text (Text, Int), Event) Source #

style

type EventStyle Source #

Arguments

= Text	track title
-> Event
-> Style.StyleId

This is called on events before they go to the UI, to be used for "syntax highlighting", i.e. it can set the style depending on the event, but the change in style won't be saved in the event itself.