Documentation

Custom handlers

Custom handlers are used for overriding the generic formatting behaviour at some values (for example, printing a String directly into the Constructor or value column rather than as a list of chars).

If a custom handler matches (returns a Just), no recursion into its children is performed by default. You can recurse manually using self.

Constructors

CH
Fields runCH :: forall d. Data d => d -> MCH (Maybe (StrictTree Row))

Instances

Monoid CustomHandler

The mempty CustomHandler handles nothing. mappend ch1 ch2 tries ch1 first, falling back to ch2 if ch1 doesn't handle the argument.

showType :: TypeRep -> String Source

Show a type with some prettification like replacing [Char] with String.

showTypeOf :: Typeable a => a -> String Source

The monad in which custom handlers run

data MCH a Source

Instances

Monad MCH
Functor MCH
Typeable1 MCH
Applicative MCH
MonadControlIO MCH
MonadIO MCH

self :: Data d => d -> MCH (StrictTree Row)Source

Invokes the final Data-to-Tree conversion function, which includes the generic handler, the CustomHandler being defined, and any CustomHandlers mappended to the one being defined.

Thus, invoking self x from your implementation of runCH x will usually amount to an infinite loop, but invoking self y on some child y of x is fine.

Specialized constructors

simpleCH :: Typeable a => (a -> MCH ([CellAttr], [CellAttr])) -> CustomHandler Source

A CustomHandler that only works at a fixed type (and always works there), and generates a node with no children and with the default text in the type column. The function should return the rowCV in the first component and the rowCustomInfo in the second.

monoCH :: Typeable a => (a -> MCH (Maybe (StrictTree Row))) -> CustomHandler Source

Creates a custom handler that only applies at a fixed monomorphic type a.

monoPureCH :: Typeable a => (a -> Maybe (StrictTree Row)) -> CustomHandler Source

Creates a pure custom handler that only applies at a fixed monomorphic type a.

monoPureCH' :: Typeable a => (a -> StrictTree Row) -> CustomHandler Source

Creates a pure custom handler that only and always applies at a fixed monomorphic type a.

poly1CH :: Typeable1 f => (forall a. Data a => f a -> MCH (Maybe (StrictTree Row))) -> CustomHandler Source

Creates a custom handler that applies at f a for a fixed type constructor f and for any a.

poly2CH :: Typeable2 f => (forall a b. (Data a, Data b) => f a b -> MCH (Maybe (StrictTree Row))) -> CustomHandler Source

Creates a custom handler that applies at f a b for a fixed binary type constructor f and for any a and b.

Data that custom handlers must produce

module DataTreeView.StrictTypes

type CellData = StrictList CellAttr Source

data Row Source

Data for a row of the tree widget.

Constructors

Row
Fields rowCV :: !CellData Constructor name, literal value, or a placeholder like `"{List}"` for custom things rowFieldName :: !CellData Record field name. You can mostly ignore this, see the remark in `newRow`. rowCustomInfo :: !CellData Arbitrary information (left empty by the generic handler) rowTypeName :: !CellData

Instances

Data Row
Show Row
Typeable Row

newRow Source

Arguments

:: [CellAttr]	`rowCV`
-> [CellAttr]	`rowCustomInfo`
-> [CellAttr]	`rowTypeName`
-> Row

Construct a Row with empty rowFieldName.

You usually can't know the field name for a node x during a recursive call with x at its root - the field name will be added afterwards by the generic handler for the parent node of x if that parent node is a constructor with named fields.

addToAll :: Row -> [CellAttr] -> Row Source

Adds the given attribute to each cell of the given row.