Ctrl K

#cp.highland2.Document

Highland 2 Document Window extension.

#API Overview

Functions - API calls offered directly by the extension

matches

Fields - Variables which can only be accessed from an object returned by a constructor

documentPath
doShow
revisionMode
sidebar
splitter
sprint
templatePicker
text
themePicker

#API Documentation

#Functions

#matches


Signature	`cp.highland2.Document.matches(element) -> boolean`
Type	Function
Description	Checks if the element is a Document.
Parameters	element - The element to check.
Returns	`true` if the element matches, `false` otherwise.
Notes	None
Examples	None
Source	src/extensions/cp/highland2/Document.lua line 22

#Fields

#documentPath


Signature	`cp.highland2.Document:documentPath() -> cp.prop <string; live>`
Type	Field
Description	The current path for the document.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 36

#doShow


Signature	`cp.highland2.Document.doShow <cp.rx.go.Statement>`
Type	Field
Description	A Statement that will show the `Document` when run.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 121

#revisionMode


Signature	`cp.highland2.Document.revisionMode <cp.ui.Button>`
Type	Field
Description	The Revision Mode button.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 72


Signature	`cp.highland2.Document.sidebar <cp.highland2.Sidebar>`
Type	Field
Description	The Sidebar.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 86

#splitter


Signature	`cp.highland2.Document.splitter <cp.ui.Splitter>`
Type	Field
Description	The Splitter.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 93

#sprint


Signature	`cp.highland2.Document.sprint <cp.ui.Button>`
Type	Field
Description	The Sprint button.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 79

#templatePicker


Signature	`cp.highland2.Document.templatePicker <cp.ui.Button>`
Type	Field
Description	The Template Picker button.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 58

#text


Signature	`cp.highland2.Document.text <cp.ui.TextArea>`
Type	Field
Description	The TextArea containing the document text.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 114

#themePicker


Signature	`cp.highland2.Document.themePicker <cp.ui.Button>`
Type	Field
Description	The Theme Picker button.
Notes	None
Source	src/extensions/cp/highland2/Document.lua line 65

Ctrl K