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:

button start/end

starts and ends History if 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 lineShorts, or the filtered lineShorts; selecting them in ListView makes them come appear in post-doc window.

first example:( // 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); )

Class Methods

HistoryGui.docHeight

HistoryGui.docHeight = value

HistoryGui.docTitle

HistoryGui.docTitle = value

HistoryGui.new(object, numItems: 8, parent, bounds, makeSkip: true, options: [ ])

Inherited class methods

Instance Methods

views

.textV

.startBut

.filtBut

.keyPop

.filTextV

.topBut

.listV

.resetViews

.showLineAt(index)

'doc'-related

.doc

.findDoc

.docFlag

.oldDocs

.postDoc(index)

.setDocStr(str)

.rip

filtering

.filtering

.filtering = flag: true

.filterOn

.filterOff

.filters

.filterLines

.filteredIndices

.filteredShorts

.setStrFilter(str)

.stickMode

.stickMode = value

Inherited instance methods

Undocumented instance methods

.setKeyFilter(key)

Examples

( // 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;