Module Simantics/PlatformUI

This module is undocumented. This is a list of its definitions.

availableRanges :: Variable -> <ReadGraph> [String]

The names of the ranges of the spreadsheet that input represents. These are the choices offered by the combo box of the Ranges property tab.

checkedStateRule :: VariableOrResource -> <ReadGraph,Proc> CheckedState

Tells the explorer of the Validation property tab which issue sources to show as ticked: those tagged ISSUE.IssueSource.Selected.

configureButtonClick :: Variable -> <ReadGraph,Proc> AbstractEventHandler

The press handler of the Configure button of the Validation property tab, bound to the index root of the tab context.

configureButtonClickHandler :: Resource -> CommandContext -> <Proc> Maybe CommandResult

Opens the issue source configuration dialog for the given index root. This is the body of the Configure button of the Validation property tab.

createNewHandler :: Variable -> (String -> Maybe String) -> <WriteGraph> String

The New button of the Shared Libraries property tab. Opens the dialog for creating a new shared library, offering the concrete index root types inheriting L0.SharedOntology. The dialog runs asynchronously, so this returns before the library exists.

currentRangeExpression :: Variable -> Variable -> <ReadGraph> String

The SCL expression text of the range selected in the Ranges property tab.

currentRangeExpressionVariable :: Variable -> Variable -> <ReadGraph> Variable

The cells property variable of the range selected in the sibling combo box of the text editor self. This is the SCL value whose expression the Ranges property tab edits.

currentRangeName :: Variable -> Variable -> <ReadGraph> String

The name of the range currently shown by the combo box self of the Ranges property tab, falling back to defaultRange input while the user has not selected anything.

currentRangeTextAndErrors :: Variable -> Variable -> <ReadGraph> TextAndErrors

The content of the SCL text editor of the Ranges property tab: the expression of the selected range with an empty error list, so no error markers are shown.

defaultRange :: Variable -> <ReadGraph> String

The range selected in the Ranges property tab before the user has chosen one: the first of availableRanges, or an empty string if the spreadsheet has no ranges.

fooHandler :: Variable -> CommandContext -> <WriteGraph> Maybe CommandResult

The selection handler of the range combo box in the Ranges property tab. Stores the value of the selected command context parameter as the currentSelection component state of self, which is what currentRangeName reads back.

fooHandler2 :: Variable -> CommandContext -> <WriteGraph> Maybe CommandResult

A text editor modification handler that writes the text command context parameter into the SCL value that self itself represents. Currently unused; the Ranges property tab uses modifyCodeHandler instead.

importHandler :: Variable -> (String -> Maybe String) -> <WriteGraph> String

The Import button of the Shared Libraries property tab. Opens the shared library import wizard for input. The wizard runs asynchronously, so this returns before anything has been imported.

issueSourceExplorerCheck :: Variable -> <ReadGraph,Proc> AbstractEventHandler

The check handler of the issue source explorer of the Validation property tab, bound to the index root of the tab context.

issueSourceExplorerCheckHandler :: Resource -> CommandContext -> <Proc> Maybe CommandResult

Reacts to the user ticking an issue source in the explorer of the Validation property tab. Checking the source states ISSUE.IssueSource.Selected on it and unchecking retracts that statement, which is what decides whether the Validate button runs the source. Does nothing if the command context has no item or no checked value.

modifyCodeHandler :: Variable -> Variable -> CommandContext -> <WriteGraph> Maybe CommandResult

The modification handler of the SCL text editor of the Ranges property tab. Writes the edited text, given in the text command context parameter, into the expression of the range currently selected in the combo box.

standardPropertiesElementTransformation :: Variable -> <ReadGraph> Variable

The input transformation of the standard properties tab. When the selected variable is a diagram element that is mapped to a component, the properties of that component are shown instead. Any other variable is passed through unchanged.

unlinkSelectedHandler :: Variable -> (String -> Maybe String) -> <WriteGraph> String

The Unlink button of the Shared Libraries property tab. Unlinks the shared libraries in the workbench selection, given in the selection parameter, from the index root that input represents, and records the unlinking. Nothing is recorded if the unlinking was refused because the index root still contains instances of component types defined by those libraries.

useSelectedHandler :: Variable -> (String -> Maybe String) -> <WriteGraph> String

The Use button of the Shared Libraries property tab. Links every shared library in the workbench selection, given in the selection parameter, to the index root that input represents, and records the linking for command recording. Returns an empty string as the document event result.

usedIssueSources :: Resource -> <ReadGraph> [Resource]

The issue sources configured for the given index root. These are the rows of the explorer of the Validation property tab.

validateButtonClick :: Variable -> <ReadGraph,Proc> AbstractEventHandler

The press handler of the Validate button of the Validation property tab, bound to the index root of the tab context.

validateButtonClickHandler :: Resource -> CommandContext -> <Proc> Maybe CommandResult

Runs the issue sources that are currently selected for the given index root, without reporting progress. This is the body of the Validate button of the Validation property tab.