HelpSource/Classes/HistoryGui.schelp

   1 CLASS:: HistoryGui
   2 summary:: A gui for History objects
   3 categories:: GUI>Interfaces
   4 related::
   5
   6 DESCRIPTION::
   7 The gui elements in detail:
   8 DEFINITIONLIST::
   9 ## button start || stops and starts History emphasis::if:: code::gui.history:: is current.
  10 ## popUp sameDoc/newDoc || switches whether the code::postDoc:: method posts to old post-doc window or new.
  11 ## button closeAll || closes all documents called "History repeats".
  12 ## button closeOld || closes only those created from this gui, except the latest.
  13
  14 ## button X/- || turns filtering on/off.
  15 ## popup \all || selects which key to search for (only useful if networked)
  16 ## textview || allows for typing in search string.
  17
  18 ## listview || shows either all code::lineShorts::, or the filtered code::lineShorts::; selecting them in listview makes them come appear in post-doc window.
  19 ::
  20
  21
  22 EXAMPLES::
  23
  24 code::
  25 (
  26 h = History.new.lines_([
  27         [0, \me, "1+2"],
  28         [1, \me, "3+5"], [1.234, \you, "q = q ? ();"],
  29         [3, \her, "\"Herstory\".speak"]
  30 ]);
  31 g = h.makeWin;
  32 g.findDoc;
  33 g.postDoc(2);
  34 )
  35
  36 h.document;
  37 // how filtering works:
  38 g.filters.postcs;
  39 g.filterOff;
  40 g.filterOn;
  41 g.filtering;
  42 g.setKeyFilter(\all);
  43 g.setKeyFilter(\me);
  44 g.setStrFilter("");
  45 g.setStrFilter("3");
  46
  47 // internal state cached in gui:
  48 g.filteredIndices;
  49 g.filteredShorts;
  50
  51 // to do: execute line on special key in listview;
  52 // window following?
  53 ::