You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: TS/docs/script_reference.html
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -7,55 +7,55 @@
7
7
</head>
8
8
<body><center><tableborder=0><tr><td>
9
9
<p>lobster builtin functions:(file auto generated by compiler, do not modify)</p></td></tr><trclass="a" valign=top><td><h3>treesheets</h3></td></tr>
10
-
<tr><td><tableclass="a" border=1cellspacing=0cellpadding=4><trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_root</b>()</tt></td><tdclass="a">makes the root of the document the current cell. this is the default at the startof any script, so this function is only needed to return there.</td>
10
+
<tr><td><tableclass="a" border=1cellspacing=0cellpadding=4><trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_root</b>()</tt></td><tdclass="a">makes the root of the document the current cell. this is the default at the start of any script, so this function is only needed to return there.</td>
11
11
12
12
</tr>
13
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_view</b>()</tt></td><tdclass="a">makes what the user has zoomed into the current cell.</td>
13
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_view</b>()</tt></td><tdclass="a">makes what the user has zoomed into the current cell</td>
14
14
15
15
</tr>
16
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.has_selection</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">whether there is a selection.</td>
16
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.has_selection</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">whether there is a selection</td>
17
17
18
18
</tr>
19
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_selection</b>()</tt></td><tdclass="a">makes the current cell the one selected, or the first of a selection.</td>
19
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_selection</b>()</tt></td><tdclass="a">makes the current cell the one selected, or the first of a selection</td>
20
20
21
21
</tr>
22
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.has_parent</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">whether the current cell has a parent (is the root cell).</td>
22
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.has_parent</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">whether the current cell has a parent (is the root cell)</td>
23
23
24
24
</tr>
25
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_parent</b>()</tt></td><tdclass="a">makes the current cell the parent of the current cell, if any.</td>
25
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_parent</b>()</tt></td><tdclass="a">makes the current cell the parent of the current cell, if any</td>
26
26
27
27
</tr>
28
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.num_children</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">returns the total number of children of the current cell (rows * columns).returns 0 if this cell doesn't have a sub-grid at all.</td>
28
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.num_children</b>() -><fontcolor="#666666">int</font></tt></td><tdclass="a">returns the total number of children of the current cell (rows * columns).returns 0 if this cell doesn't have a sub-grid at all.</td>
29
29
30
30
</tr>
31
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.num_columns_rows</b>() -><fontcolor="#666666">int2</font></tt></td><tdclass="a">returns the number of columns & rows in the current cell.</td>
31
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.num_columns_rows</b>() -><fontcolor="#666666">int2</font></tt></td><tdclass="a">returns the number of columns & rows in the current cell</td>
32
32
33
33
</tr>
34
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.selection</b>() -><fontcolor="#666666">int2</font>, <fontcolor="#666666">int2</font></tt></td><tdclass="a">returns the (xs,ys) and (x,y) of the current selection, or zeroes if none.</td>
34
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.selection</b>() -><fontcolor="#666666">int2</font>, <fontcolor="#666666">int2</font></tt></td><tdclass="a">returns the (xs,ys) and (x,y) of the current selection, or zeroes if none</td>
35
35
36
36
</tr>
37
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_child</b>(n<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">makes the current cell the nth child of the current cell.</td>
37
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_child</b>(n<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">makes the current cell the nth child of the current cell</td>
38
38
39
39
</tr>
40
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_column_row</b>(col<fontcolor="#666666">: int</font>, row<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">makes the current cell the child at col / row.</td>
40
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.goto_column_row</b>(col<fontcolor="#666666">: int</font>, row<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">makes the current cell the child at col / row</td>
41
41
42
42
</tr>
43
43
<trclass="a" valign=top><tdclass="a"><tt><b>ts.get_text</b>() -><fontcolor="#666666">string</font></tt></td><tdclass="a">gets the text of the current cell.</td>
44
44
45
45
</tr>
46
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_text</b>(text<fontcolor="#666666">: string</font>)</tt></td><tdclass="a">sets the text of the current cell.</td>
46
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_text</b>(text<fontcolor="#666666">: string</font>)</tt></td><tdclass="a">sets the text of the current cell</td>
47
47
48
48
</tr>
49
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.create_grid</b>(cols<fontcolor="#666666">: int</font>, rows<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">creates a grid in the current cell if there isn't one yet.</td>
49
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.create_grid</b>(cols<fontcolor="#666666">: int</font>, rows<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">creates a grid in the current cell if there isn't one yet</td>
50
50
51
51
</tr>
52
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.insert_column</b>(c<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">insert n columns before column c in an existing grid.</td>
52
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.insert_column</b>(c<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">inserts n columns before column c in an existing grid</td>
53
53
54
54
</tr>
55
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.insert_row</b>(r<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">insert n rows before row r in an existing grid.</td>
55
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.insert_row</b>(r<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">inserts n rows before row r in an existing grid</td>
56
56
57
57
</tr>
58
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.delete</b>(pos<fontcolor="#666666">: int2</font>, size<fontcolor="#666666">: int2</font>)</tt></td><tdclass="a">clears the cells denoted by pos/size. also removes columns/rows if they becomecompletely empty, or the entire grid.</td>
58
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.delete</b>(pos<fontcolor="#666666">: int2</font>, size<fontcolor="#666666">: int2</font>)</tt></td><tdclass="a">clears the cells denoted by pos/size. also removes columns/rows if they become completely empty, or the entire grid.</td>
59
59
60
60
</tr>
61
61
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_background_color</b>(col<fontcolor="#666666">: float4</font>)</tt></td><tdclass="a">sets the background color of the current cell</td>
@@ -76,16 +76,16 @@
76
76
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_relative_size</b>(s<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">sets the relative size (0 is normal, -1 is smaller etc.) of the current cell</td>
77
77
78
78
</tr>
79
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_style_bits</b>(s<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">sets one or more styles (bold = 1, italic = 2, fixed = 4, underline = 8, strikethru = 16) on the current cell.</td>
79
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_style_bits</b>(s<fontcolor="#666666">: int</font>)</tt></td><tdclass="a">sets one or more styles (bold = 1, italic = 2, fixed = 4, underline = 8, strikethru = 16) on the current cell</td>
80
80
81
81
</tr>
82
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_status_message</b>(message<fontcolor="#666666">: string</font>)</tt></td><tdclass="a">sets the status message in TreeSheets.</td>
82
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.set_status_message</b>(message<fontcolor="#666666">: string</font>)</tt></td><tdclass="a">sets the status message in TreeSheets</td>
83
83
84
84
</tr>
85
85
<trclass="a" valign=top><tdclass="a"><tt><b>ts.get_filename_from_user</b>(is_save<fontcolor="#666666">: int</font>) -><fontcolor="#666666">string</font></tt></td><tdclass="a">gets a filename using a file dialog. empty string if cancelled.</td>
86
86
87
87
</tr>
88
-
<trclass="a" valign=top><tdclass="a"><tt><b>ts.get_filename</b>() -><fontcolor="#666666">string</font></tt></td><tdclass="a">gets the current documents file name.</td>
88
+
<trclass="a" valign=top><tdclass="a"><tt><b>ts.get_filename</b>() -><fontcolor="#666666">string</font></tt></td><tdclass="a">gets the current documents file name</td>
89
89
90
90
</tr>
91
91
<trclass="a" valign=top><tdclass="a"><tt><b>ts.load_document</b>(filename<fontcolor="#666666">: string</font>) -><fontcolor="#666666">int</font></tt></td><tdclass="a">loads a document, and makes it the active one. returns false if failed.</td>
0 commit comments