1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
CLASS:: HistoryGui
summary:: A gui for History objects
categories:: GUI>Interfaces
related:: Classes/History
DESCRIPTION::
HistoryGui allows easy access to History as it happens: one can read recent lines, when they were written and by whom; one can search for text strings and by author names; and one can quickly grab lines of code for rewriting. Apart from documenting just in time programming sessions, all of this can be useful in live coding performances. See e.g. the system developed by powerbooks_unplugged, in the Quark called Republic.
The gui elements in detail:
DEFINITIONLIST::
## button start/end || starts and ends History emphasis::if:: code::gui.history:: is current.
## button all/filt || turns filtering on/off.
## popup all/... || selects which name key to search for (useful if networked)
## TextView || allows for typing in a search string.
## button top/keep || sets mode whether ListView stays on top line, or keeps sticking to the selected line.
## ListView || shows either all code::lineShorts::, or the filtered code::lineShorts::; selecting them in ListView makes them come appear in post-doc window.
::
first example:
code::
(
// create a short history
h = History([
[0, \me, "1+2"],
[1, \me, "3+5"], [1.234, \you, "q = q ? ();"],
[3, \they, "\"The story\".speak"]
]);
// make a gui for it
g = h.makeWin(0@20);
// find or make a text window for code line display
// (called 'doc' because that was a Document in pre-Qt times)
g.findDoc;
// post line at index 2 in h.lines in doc window
g.postDoc(2);
)
::
ClassMethods::
method::docHeight
get and set the height of the text window opened by HistoryGui
method::docTitle
get and set the title of the text window opened by HistoryGui
method::new
create a new HistoryGui
argument:: object
the history
argument:: numItems
the number of lines in the TextView above
argument:: parent
a parent window or view in which to place new HistoryGui
argument:: bounds
bounds for new HistoryGui, constrained by its minSize.
argument:: makeSkip
flag whether to create a skipjack for the HistoryGui.
argument:: options
options to set for the HistoryGui (inherited from JITGui).
InstanceMethods::
private:: accepts, checkUpdate, getState, makeViews, setDefaults, postInlined
private:: updateBinVal, updateFunc, updateLines, updateVal, alignDoc
subsection:: views
method::textV
top: the TextView for the selected line
method::startBut, filtBut, keyPop, filTextV, topBut
the line of buttons, popup and TextView
method::listV
the ListView for the history lines
method::resetViews
reset all views
method::showLineAt
show the line at that index in History.lines in the TextView.
subsection:: 'doc'-related
method::doc
the external text window made by HistoryGui to show codelines on.
This is still called doc because it used to be a Document in pre-Qt times.
method::findDoc
find an open a re-usable text window, or make a new one
method:: docFlag
get or set the symbol for the doc strategy to use:
code::\sameDoc:: tries to re-use a single text window,
code::\newDoc:: always makes a new one (and keep track of old docs)
method::oldDocs
list of previous text windows (docs) opened
method::postDoc
find the codeline at index in History, and post it on the textwindow
method::setDocStr
set the string of the current textwindow
method::rip
create a new textwindow with currently selected line
subsection:: filtering
method::filtering
flag whether filtering is on
method::filterOn, filterOff
convenience on/off methods
method::filters
keys and string fragments to filter for.
e.g. [ 'all', "+" ] gets lines from all sources that contain the string "+".
method::filterLines
apply filtering to history lines
method::filteredIndices
the indices of the current filtered lines
method::filteredShorts
the current filtered short lines for gui display
method:.setKeyFilter
set the key(s) to filter for, and perform filtering
method::setStrFilter
set the string to filter for, and perform filtering
method::stickMode
stickMode 0 means top, i.e. select top when new lines come in;
stickMode 1 means keep, i.e. keep current line selected after new lines come in.
EXAMPLES::
code::
(
// create a short history
h = History([
[0, \me, "1+2"],
[1, \me, "3+5"], [1.234, \you, "q = q ? ();"],
[3, \they, "\"The story\".speak"]
]);
// make a gui for it
g = h.makeWin(0@20);
// find or make a text window for code line display
// (called 'doc' because that was a Document in pre-Qt times)
g.findDoc;
// post line at index 2 in h.lines in doc window
g.postDoc(2);
)
h.document;
// show how filtering works:
g.filtering; // is filter on?
g.filterOff; // shorthand for off
g.filterOn; // and on
// filtering looks for lines by author key(s)
// and strings in the code lines:
g.filters.postcs;
g.setKeyFilter(\all);
g.setKeyFilter(\me);
g.setStrFilter("");
g.setStrFilter("3");
g.filters.postcs;
// internal state cached in the HistoryGui:
g.filteredIndices;
g.filteredShorts;
::
|
