Simantics/BrowseContext module documentation

NodeContext

data NodeContext

A context used to represent a single visible UI item.

getConstant :: NodeContext -> ConstantKey -> <Proc> a

Finds value with the specified key or null if there was no value for the key

BrowseContext

data BrowseContext

BrowseContext holds all contributions related to given set of browse contexts.

createBrowseContext :: [Resource] -> <ReadGraph> BrowseContext

Creates a new BrowseContext for the given Collection of Resources.

browseContextChildren :: BrowseContext -> NodeContext -> <ReadGraph> Collection NodeContext

Returns the possible children of the given NodeContext parameter.

browseContextParents :: BrowseContext -> NodeContext -> <ReadGraph> Collection NodeContext

Returns the possible parents of the given NodeContext parameter.

browseContextLabel :: BrowseContext -> NodeContext -> <ReadGraph> Map.T String String

Finds labels for the given NodeContext parameter.

browseContextImage :: BrowseContext -> NodeContext -> <ReadGraph> Map.T String ImageDescriptor

Finds @link ImageDescriptors for the given NodeContext parameter.

browseContextCheckedState :: BrowseContext -> NodeContext -> <ReadGraph> CheckedState

Finds if the given NodeContext is checked or not.

browseContextLabelDecorator :: BrowseContext -> NodeContext -> <ReadGraph> LabelDecorator

Finds LabelDecorator for the given NodeContext parameter.

browseContextImageDecorator :: BrowseContext -> NodeContext -> <ReadGraph> ImageDecorator

Finds ImageDecorator for the given NodeContext parameter.

browseContextModifier :: BrowseContext -> NodeContext -> String -> <ReadGraph> Maybe Modifier

Finds Modifier for the given NodeContext parameter.

LabelDecorator

data LabelDecorator

An interface for decorating aesthetic properties of an UI item, including the label text, font, background color and foreground color.

decorateLabel :: LabelDecorator -> String -> String -> Integer -> <Proc> Maybe String

Decorates the given label with the name of the UI column which the label is for and the index of this label within its parenting INodeContext. Returns the decorated Label

decorateFont :: LabelDecorator -> Maybe a -> String -> Integer -> <Proc> Maybe a
decorateForeground :: LabelDecorator -> a -> String -> Integer -> <Proc> a
decorateBackground :: LabelDecorator -> a -> String -> Integer -> <Proc> a

Undocumented entities

CHECKED :: CheckedState
GRAYED :: CheckedState
NOT_CHECKED :: CheckedState
buildWithInput :: a -> <Proc> NodeContext
colorDescriptor :: (Double, Double, Double) -> <Proc> ColorDescriptor
colorDescriptorAsHex :: ColorDescriptor -> <Proc> String
colorDescriptorAsTuple3 :: ColorDescriptor -> <Proc> (Double, Double, Double)
defaultFontDescriptor :: FontDescriptor
getNodeContextForResource :: Resource -> <Proc> NodeContext
getNodeContextWithTypeForResource :: Resource -> <Proc,ReadGraph> NodeContext
getValue :: Modifier -> <Proc> String
instanceOfTest :: Variable -> <ReadGraph> Resource -> <ReadGraph> Boolean
isValid :: Modifier -> String -> <Proc> Maybe String
modify :: Modifier -> String -> <Proc> ()
toBrowseContextG :: Vector String -> <ReadGraph> BrowseContext