Safe Haskell	Safe-Inferred

Ui.Ruler

Contents

Ruler
- bounds

Synopsis

data Ruler = Ruler {
- ruler_marklists :: !Marklists
- ruler_bg :: !Color.Color
- ruler_show_names :: !Bool
- ruler_align_to_bottom :: !Bool
}
type Marklists = Map Name (Maybe Meter.Meter, Mark.Marklist)
type Name = Text
meter_ruler :: Meter.Meter -> Ruler
meter_name :: Name
empty :: Ruler
get_meter :: Ruler -> Meter.Meter
lookup_meter :: Ruler -> Maybe Meter.Meter
set_meter :: Meter.Meter -> Ruler -> Ruler
modify_meter :: (Meter.Meter -> Meter.Meter) -> Ruler -> Ruler
lookup_marklist :: Name -> Ruler -> Maybe Mark.Marklist
get_marklist :: Name -> Ruler -> Mark.Marklist
set_marklist :: Name -> Mark.Marklist -> Ruler -> Ruler
remove_marklist :: Name -> Ruler -> Ruler
modify_marklist :: Name -> (Mark.Marklist -> Mark.Marklist) -> Ruler -> Ruler
modify_marklists :: (Map Name (Maybe Meter.Meter, Mark.Marklist) -> Map Name (Maybe Meter.Meter, Mark.Marklist)) -> Ruler -> Ruler
time_end :: Ruler -> ScoreTime
bounds_name :: Name
set_bounds :: Maybe ScoreTime -> Maybe ScoreTime -> Ruler -> Ruler
get_bounds :: Ruler -> (Maybe ScoreTime, Maybe ScoreTime)
bounds_of :: Ruler -> (ScoreTime, Maybe ScoreTime)

Ruler

data Ruler Source #

A Ruler contains all the data to display a ruler.

Constructors

Ruler
Fields ruler_marklists :: !Marklists ruler_bg :: !Color.Color ruler_show_names :: !Bool Show the names if this is on an event track. Ruler tracks always show the names. ruler_align_to_bottom :: !Bool Align bottoms of marks to beats, instead of the top. Looks good used with negative duration events (arrival beats).

Instances

Instances details

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

type Marklists = Map Name (Maybe Meter.Meter, Mark.Marklist) Source #

Each ruler can have multiple named marklists. This means a ruler can have multiple simultaneous meters, or a separate list of ad-hoc cue points. All marks are flattened before display, and are drawn in the sort order of their Names.

However, multiple meters are liable to be cluttered, and multiple cue lists also seem gratuitous.

type Name = Text Source #

meter_ruler :: Meter.Meter -> Ruler Source #

Create a ruler with just a meter marklist.

meter_name :: Name Source #

The meter marklist by convention has marks corresponding to the meter of the piece. Other commands may use this to find out where beats are.

empty :: Ruler Source #

get_meter :: Ruler -> Meter.Meter Source #

lookup_meter :: Ruler -> Maybe Meter.Meter Source #

set_meter :: Meter.Meter -> Ruler -> Ruler Source #

modify_meter :: (Meter.Meter -> Meter.Meter) -> Ruler -> Ruler Source #

lookup_marklist :: Name -> Ruler -> Maybe Mark.Marklist Source #

get_marklist :: Name -> Ruler -> Mark.Marklist Source #

set_marklist :: Name -> Mark.Marklist -> Ruler -> Ruler Source #

remove_marklist :: Name -> Ruler -> Ruler Source #

modify_marklist :: Name -> (Mark.Marklist -> Mark.Marklist) -> Ruler -> Ruler Source #

If the marklist isn't set, modify will be given an empty one.

modify_marklists :: (Map Name (Maybe Meter.Meter, Mark.Marklist) -> Map Name (Maybe Meter.Meter, Mark.Marklist)) -> Ruler -> Ruler Source #

time_end :: Ruler -> ScoreTime Source #

Get the position of the last mark of the ruler.

bounds

bounds_name :: Name Source #

Marks on this marklist given the logical block bounds. If there is one mark, it denotes the logical block end. Two morks mean the first one is the logical block start. The mark text doesn't matter, but s and e are customary.

set_bounds :: Maybe ScoreTime -> Maybe ScoreTime -> Ruler -> Ruler Source #

get_bounds :: Ruler -> (Maybe ScoreTime, Maybe ScoreTime) Source #

bounds_of :: Ruler -> (ScoreTime, Maybe ScoreTime) Source #

Get block bounds as defined by the ruler. This uses explicit bounds_name if there are any, otherwise it uses the meter. Otherwise, the start time can default to 0, but the end time defaults to Nothing so the caller can use the end of the last event.