home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / C / OTL-MC4.DMS / in.adf / Archive / Prog.lha / Docs / ARexx < prev    next >
Encoding:
Text File  |  1994-02-14  |  19.8 KB  |  483 lines

  1.  
  2. Die ARexx-Schnittstelle
  3. =======================
  4.  
  5.    Ab  Version 3.00 ist HotHelp auch über ARexx ansteuerbar. Das bedeutet,
  6. daß  es jetzt über ARexx möglich ist, auf einfachste Weise HotHelp-Fenster
  7. zu öffnen und zu kontrollieren - der direkte, aber auch kompliziertere Weg
  8. über  die  Library-Schnittstelle ist damit nicht mehr notwendig! Der Name,
  9. unter  dem  HotHelp  angesprochen  werden  kann,  ist  voreingestellt  als
  10. 'HOTHELP_REXX'.  Der  Name  kann  jedoch  in den Voreinstellungen beliebig
  11. gewählt werden.
  12.  
  13.    Das  ARexx-Interface  wird  nicht  von  der  Library  selber angeboten,
  14. sondern  vom  Programm  HotKeyHelp.  Dieses  Vorgehen  war praktischer, da
  15. HotKeyHelp selber auch einige ARexx-Kommandos zur Verfügung stellt.
  16.  
  17.    Die  Mehrzahl  der  angebotenen  ARexx-Befehle erfordert von HotKeyHelp
  18. keine  Aktionen, da sie direkt auf Library-Funktionen zurückgeführt werden
  19. können. Über ARexx geöffnete HotHelp-Fenster sind grundsätzlich asynchron.
  20. Das  bedeutet,  daß  das  ARexx-Programm  weiter arbeiten kann, sobald das
  21. Fenster geöffnet wurde.
  22.  
  23.    Hier  nun  eine  Übersicht  über  alle  ARexx-Befehle,  die  HotKeyHelp
  24. bereitstellt.  Die  Parameter  der  einzelnen  Kommandos  werden  auf zwei
  25. verschiedene  Weisen  beschrieben:  zum  einen über eine Format-Zeile, zum
  26. anderen  über  eine  Befehls-Schablone. Beides entspricht der auch bei der
  27. Beschreibung  der  Shell-Befehle verwendeten Syntax; eine Erklärung finden
  28. Sie im Shell-Projekt unter den Stichworten 'Format' und 'Schablone'.
  29.  
  30.    Falls  ein  Befehl  einen definierten Rückgabewert hat, wird dieser bei
  31. der Beschreibung des Kommandos erklärt. Der Rückgabewert wird immer in der
  32. ARexx-Variablen  'Result'  abgelegt und ist nur verfügbar, wenn vorher der
  33. ARexx-Befehl 'Options Result' ausgeführt wurde.
  34.  
  35.    Im  Fall  eines Fehlers gibt HotHelp drei unterschiedliche Werte in der
  36. ARexx-Variablen  'RC'  zurück. Ein Wert von 5 zeigt an, daß das gewünschte
  37. Element  (Gadget  oder  Menu bei 'HH_ControlGadget' bzw. 'HH_ControlMenu')
  38. momentan  nicht  angewählt  werden  kann, da es nicht aktiv (ghosted) oder
  39. nicht  erreichbar ist (z.B. Export-Gadgets vom Arbeitsmodus aus). Ein Wert
  40. von  10 wird zurückgegeben, wenn ein Befehl an ein Fenster geschickt wird,
  41. das  gar  nicht  mehr  offen ist. Der Wert 20 wird zurückgegeben, wenn ein
  42. ernsthafer  Fehler  auftrat  oder  wenn  ein unbekannter Befehl an HotHelp
  43. übermittelt wird.
  44.  
  45.  
  46. Die ARexx-Befehle
  47. =================
  48.  
  49. HH_ActivateWindow
  50. -----------------
  51.  
  52. Format:        HH_ActivateWindow Id
  53.  
  54. Schablone:     HH_ActivateWindow Id/A/N
  55.  
  56. Beschreibung:
  57.  
  58.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  59. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  60. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  61. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  62. ab.
  63.  
  64.    Die   Funktion  aktiviert  ein  HotHelp-Fenster  wieder.  Dabei  werden
  65. folgende  Aktionen  ausgeführt:  Der  Screen,  auf  dem  sich  das Fenster
  66. befindet,  wird  ganz  nach  vorne  gebracht.  Falls er nach unten gezogen
  67. wurde,   wird  er  wieder  an  den  oberen  Bildschirmrand  gebracht.  Das
  68. angesprochene  HotHelp-Fenster  wird  vor  alle anderen Fenster geholt und
  69. anschließend aktiviert.
  70.  
  71.  
  72. HH_CheckWindow
  73. --------------
  74.  
  75. Format:        HH_CheckWindow Id
  76.  
  77. Schablone:     HH_CheckWindow Id/A/N
  78.  
  79. Beschreibung:
  80.  
  81.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  82. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  83. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  84. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  85. ab.
  86.  
  87.    Wie  oben  beschrieben, läuft ein über ARexx geöffnetes HotHelp-Fenster
  88. paralell  zum ARexx-Programm ab. Es kann also auch durchaus geschehen, daß
  89. der  User  das Fenster irgendwann selber wieder schließt. Mit Hilfe dieses
  90. Befehls  kann nun überprüft werden, ob das entsprechende Fenster überhaupt
  91. noch offen ist.
  92.  
  93.    Das  Kommando  gibt  in  der  ARexx-Variablen  'Result'  eine  von zwei
  94. möglichen  Kennungen  zurück:  'OPEN', wenn das Fenster noch geöffnet ist,
  95. oder 'CLOSED', wenn es zwischenzeitlich geschlossen wurde.
  96.  
  97.  
  98. HH_CloseWindow
  99. --------------
  100.  
  101. Format:        HH_CloseWindow Id
  102.  
  103. Schablone:     HH_CloseWindow Id/A/N
  104.  
  105. Beschreibung:
  106.  
  107.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  108. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  109. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  110. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  111. ab.
  112.  
  113.    Dies  ist das Gegenstück zum 'HH_OpenWindow'-Kommando - es schließt ein
  114. vorher geöffnetes HotHelp-Fenster wieder.
  115.  
  116.  
  117. HH_ControlGadget
  118. ----------------
  119.  
  120. Format:        HH_ControlGadget Id Gadget
  121.  
  122. Schablone:     HH_ControlGadget Id/A/N,GADGET/A/N
  123.  
  124. Beschreibung:
  125.  
  126.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  127. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  128. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  129. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  130. ab.
  131.  
  132.    Über  dieses  Kommando  ist es möglich, die Auswahl eines Gadgets durch
  133. den Benutzer zu simulieren. HotHelp verhält sich ganz genauso, also ob das
  134. Gadget  vom  Benutzer  selber  angeklickt  wurde:  das  Gadget  wird  kurz
  135. hervorgehoben;  anschließend dann wird die entsprechende Aktion ausgeführt
  136. (sofern das Gadget überhaupt aktiv war).
  137.  
  138.    Als 'Gadget' wird dabei eine Zahlen-Kennung aus der folgenden Übersicht
  139. übergeben.  Andere  als  die  verwendeten Kennungen dürfen nicht angegeben
  140. werden!
  141.  
  142.    0  - Schlüssel-Gadget.
  143.    1  - Projekte-Gadget.
  144.    2  - Kapitel-Gadget.
  145.    3  - Links-Pfeil (<).
  146.    4  - Drucker-Gadget
  147.    5  - Datei-Gadget
  148.    6  - ClipBoard-Gadget.
  149.    7  - Spezial-Gadget (Editor, Einfügen).
  150.    8  - Vortext-Gadget.
  151.    9  - Rechts-Pfeil (>).
  152.    10 - Export-Gadget.
  153.    11 - Zurück-Gadget.
  154.  
  155.  
  156. HH_ControlMenu
  157. --------------
  158.  
  159. Format:        HH_ControlMenu Id Menu Item
  160.  
  161. Schablone:     HH_ControlMenu Id/A/N,Menu/A/N,Item/A/N
  162.  
  163. Beschreibung:
  164.  
  165.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  166. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  167. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  168. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  169. ab.
  170.  
  171.    Über  dieses  Kommando  ist  es möglich, die Auswahl eines Menu-Punktes
  172. durch  den Benutzer zu simulieren. HotHelp verhält sich ganz genauso, also
  173. ob  das  Menu  vom  Benutzer  selber angewählt wurde (sofern der Menupunkt
  174. überhaupt aktiv war).
  175.  
  176.    'Menu'  und  'Item'  sind  zwei  Zahlen, die die Nummer des gewünschten
  177. Menus  und  die  des  darin  liegenden  Items angeben. Die Zählung beginnt
  178. jeweils  bei  0.  Ein 'Menu'-Wert von 0 steht z.B. für das Views Menu, ein
  179. Wert  von 1 für das Suchen-Menu etc. Hat z.B. 'Menu' den Wert 2 und 'item'
  180. den  Wert  3,  wird  damit  automatisch  die  Text-Marke 4 an die aktuelle
  181. Text-Position gesetzt.
  182.  
  183.  
  184. HH_GetStrGadget
  185. ---------------
  186.  
  187. Format:        HH_GetStrGadget Id PROJECT|KEY
  188.  
  189. Schablone:     HH_GetStrGadget Id/A/N,Type/A
  190.  
  191. Beschreibung:
  192.  
  193.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  194. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  195. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  196. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  197. ab.
  198.  
  199.    Mit  Hilfe  dieses  Befehls  kann  der Inhalt der beiden String-Gadgets
  200. eines  HotHelp-Fensters  abgefragt  werden.  Wird  als  zweiter  Parameter
  201. 'PROJECT'  angegeben,  gibt  HotHelp den Inhalt des Projekt-Gadgets in der
  202. ARexx-Variablen  'Result'  zurück;  bei Angabe von 'KEY' wird statt dessen
  203. der Inhalt des Schlüssel-Gadgets zurückgegeben.
  204.  
  205.  
  206. HH_HotKeyWindow
  207. ---------------
  208.  
  209. Format:        HH_HotKeyWindow [Project Key]
  210.  
  211. Schablone:     HH_HotKeyWindow Project,Key
  212.  
  213. Beschreibung:
  214.  
  215.    Während  über das 'HH_OpenWindow'-Kommando ein vollkommen neues Fenster
  216. geöffnet  werden  kann,  öffnet  dieser  Befehl  das  HotHelp-Fenster  von
  217. HotKeyHelp,  das  auch  über die verschiedenen HotKeys angesprochen werden
  218. kann.  Wenn  das  Fenster schon offen war, wird es lediglich aktiviert und
  219. ggf.  wird  ein neuer Text dargestellt. HotKeyHelp verhält sich bei diesem
  220. Befehl  ganz  genauso,  als  wenn  der entsprechende HotKey erkannt worden
  221. wäre.
  222.  
  223.    Falls  für  'Project'  und  'Key'  ein Begriff angegeben wird, wird der
  224. entsprechende  Text  dargestellt - andernfalls wird das HotKeyHelp-Fenster
  225. geöffnet und der zuletzt angezeigte Text wird nochmals dargestellt.
  226.  
  227.    Wie  bei  einem  HotKey  üblich, öffnet das Fenster sich auf dem gerade
  228. aktiven Screen.
  229.  
  230.    Bei  Verwendung  des HotKeyHelp-eigenen Fensters ist nicht möglich, mit
  231. Hilfe eines der anderen Kommandos Einfluß auf das Fenster zu nehmen. Dafür
  232. bietet  sich  aber  der  Vorteil,  daß  der  Anwender  sich  mit Hilfe des
  233. Vortext-Gadgets  die  vorher  im  HotKeyHelp-Fenster betrachteten Einträge
  234. nochmals  ansehen  kann.  Wird  über  'HH_OpenWindow'  ein eigenes Fenster
  235. geöffnet,   so   ist   dies   nicht   möglich  -  das  Vortext-Gadget  ist
  236. ausgeschaltet, da in diesem Fenster noch keine Texte betrachtet wurden.
  237.  
  238.  
  239. HH_OnlineBlock
  240. --------------
  241.  
  242. Format:        HH_OnlineBlock [Project] [Key] [Tab]
  243.  
  244. Schablone:     HH_OnlineBlock Project,Key,Tab/N
  245.  
  246. Beschreibung:
  247.  
  248.    Ein  neuer  Text  für  ein Online-Projekt wird normalerweise definiert,
  249. indem der entsprechende Textbereich in einem Editor markiert und dann über
  250. einen HotKey übernommen und abgespeichert wird. Mit Hilfe dieses Kommandos
  251. ist es nun möglich, programmgesteuert einen beliebigen Textblock als neuen
  252. Eintrag  eines  Online-Projektes  zu definieren. Der Text muß sich dazu im
  253. ClipBoard   befinden.   Unter   OS  1.3  wird  ein  einfacher  Aufbau  der
  254. ClipBoard-Daten  vorausgesetzt (FORM FTXT CHRS direkt hintereinander), was
  255. normalerweise auch gewährleistet sein sollte. Unter OS 2.0 können dank der
  256. IFFParse-Library auch komplexere Datenblöcke verarbeitet werden.
  257.  
  258.    Dieses  Kommando  bringt HotKeyHelp nun dazu, den Inhalt des ClipBoards
  259. einzulesen und in dem Online-Projekt 'Project' unter dem Schlüssel-Begriff
  260. 'Key' abzuspeichern.  Der  Text  kann dann später in jedem HotHelp-Fenster
  261. direkt   wieder   abgerufen  werden.  Falls  der  Text  Tabulator-Schritte
  262. beinhaltet,  sollte  mit  'Tab' noch die gewünschte Schrittweite übergeben
  263. werden. Wird kein Projektname und Schlüsselbegriff angegeben, verhält sich
  264. der Befehl wie bei Betätigung des Tastenbefehles: je nach der festgelegten
  265. Voreinstellung  der  Schlüsselauswahl  wird  ein  Fenster geöffnet, um den
  266. gewünschten  Schlüsselbegriff  vom  Anwender  zu  erfragen,  oder  er wird
  267. automatisch aus dem Text im Clipboard ermittelt.
  268.  
  269.  
  270. HH_OpenWindow
  271. -------------
  272.  
  273. Format:        HH_OpenWindow Project Key Screen Window [LASTPOS]
  274.                              [LASTTEXT]
  275.  
  276. Schablone:     HH_OpenWindow Project/A,Key/A,Screen/A/N,Window/A/N,
  277.                              LASTPOS/S,LASTTEXT/S
  278.  
  279. Beschreibung:
  280.  
  281.    Über diesen Befehl kann ein neues HotHelp-Fenster geöffnet werden. Wenn
  282. 'LASTPOS'  angegeben wird, öffnet es sich an der gleichen Position und mit
  283. derselben  Größe wie das zuletzt geöffnete HotHelp-Fenster, andernfalls an
  284. der   in  den  Voreinstellungen  festgelegten  Position.  Wird  'LASTTEXT'
  285. angefordert,  wird  der im zuletzt geöffneten HotHelp-Fenster dargestellte
  286. Text  erneut  angezeigt. War noch kein Fenster geöffnet, wird statt dessen
  287. die  in  den  Voreinstellungen gewählte Standard-Startseite angezeigt. Bei
  288. Angabe von 'LASTTEXT' sollte für 'Project' und 'Key' 0 übergeben werden.
  289.  
  290.    Wird  'LASTTEXT'  nicht  angegeben, wird in dem neuen Fenster der durch
  291. 'Project'  und  'Key' angegebene Text dargestellt - es sollte sich also um
  292. einen gültigen Projekt-Namen und einen gültigen Schlüssel-Begriff handeln!
  293.  
  294.    Über   'Screen'   und  'Window'  kann  beeinfluß  werden,  auf  welchem
  295. Bildschirm  sich  das neue Fenster öffnen soll. Enthält 'Window' eine Zahl
  296. ungleich  0,  wird  dieser Wert als Adresse eines Fensters betrachtet; das
  297. neue  Fenster  öffnet sich dann auf dem Screen, auf dem sich auch 'Window'
  298. schon  befindet. Ist 'Window' 0 und wird für 'Screen' eine Zahl ungleich 0
  299. angegeben,  wird  diese Zahl als Speicher-Adresse eines Screens verwendet,
  300. auf  dem  das  neue Fenster geöffnet wird. Nur, wenn für beide Parameter 0
  301. angegeben  wird,  öffnet das neue Fenster sich auf der Workbench (bzw. auf
  302. dem  Default-Public-Screen). Außerdem ist es noch möglich, das Fenster auf
  303. dem  gerade  aktiven Screen zu öffnen (das ist derjenige, auf dem sich das
  304. gerade  aktive  Fenster  befindet; somit also der Screen, mit dem der User
  305. gerade arbeitet), indem beide Variablen auf -1 gesetzt werden.
  306.  
  307.    Konnte  das Fenster geöffnet werden, gibt das Kommando in der Variablen
  308. 'Result'  die  sogenannte  ID  des  neuen Fensters zurück. Es handelt sich
  309. hierbei  um  eine ganze Zahl > 0, die benötigt wird, um das Fenster später
  310. über   die   übrigen   Funktionen   manipulieren   zu   können  (wie  z.B.
  311. 'HH_CloseWindow').  Trat  beim  Öffnen ein Fehler auf, wird statt dessen 0
  312. zurückgegeben.
  313.  
  314.  
  315. HH_ScrollPage
  316. -------------
  317.  
  318. Format:        HH_ScrollPage Id UP|DOWN|TOP|BOTTOM|LEFT|RIGHT|START|END
  319.  
  320. Schablone:     HH_ScrollPage Id/A/N,Direction/A
  321.  
  322. Beschreibung:
  323.  
  324.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  325. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  326. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  327. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  328. ab.
  329.  
  330.    Dieses  Kommando  dient  zum  seitenweisen Scrollen des Textes in einem
  331. HotHelp-Fenster.  Wird als Parameter 'UP' angegeben, wird um eine Seite in
  332. Richtung Textanfang, bei 'DOWN' eine Seite in Richtung Textende gescrollt.
  333. 'TOP'  und  'BOTTOM'  stellen  die erste bzw. letzte Seite des Textes dar.
  334. Über  'LEFT'  und 'RIGHT' kann eine Seite nach links oder rechts gescrollt
  335. werden,  während  'START'  und  'END'  den  sichtbaren  Textausschnitt  so
  336. verschieben, daß der Anfang bzw. das Ende der Zeilen sichtbar ist.
  337.  
  338.  
  339. HH_ScrollWindow
  340. ---------------
  341.  
  342. Format:        HH_ScrollWindow Id Lines Columns
  343.  
  344. Schablone:     HH_ScrollWindow Id/A/N,Lines/A/N,Columns/A/N
  345.  
  346. Beschreibung:
  347.  
  348.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  349. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  350. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  351. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  352. ab.
  353.  
  354.    Dieses  Kommando  verschiebt  den  sichtbaren  Textausschnitt  in einem
  355. HotHelp-Fenster  um  eine gewisse Anzahl von Zeilen und Spalten, die durch
  356. 'Lines' und  'Columns'  festgelegt  wird.  Ein negativer Wert bewirkt eine
  357. Verschiebung   in   Richtung   Textanfang   ('Lines')   bzw.  Zeilenanfang
  358. ('Columns'),  ein  positiver in die entgegengesetzte Richtung. Wenn Anfang
  359. oder  Ende des Textes erreicht werden, bricht die Funktion automatisch ab.
  360. Wird  0 übergeben, findet keine Verschiebung in die entsprechende Richtung
  361. statt.
  362.  
  363.  
  364. HH_SearchWindow
  365. ---------------
  366.  
  367. Format:        HH_SearchWindow Id Suchtext [IGNORE] [BACKWARD] [ALL]
  368.  
  369. Schablone:     HH_SearchWindow Id/A/N,SuchText/A,IGNORE/S,BACKWARD/S,ALL/S
  370.  
  371. Beschreibung:
  372.  
  373.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  374. HotHelp-Fenster.  Als  'Id' muß dazu die ID des Fensters angegeben werden,
  375. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  376. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  377. ab.
  378.  
  379.    Mit Hilfe dieses Kommandos kann die Suchfunktion eines HotHelp-Fensters
  380. angesteuert  werden. Es können hier dieselben Vorgaben wie im Such-Fenster
  381. von  HotHelp  selber vorgenommen werden: 'Suchtext' ist der Text, nach dem
  382. gesucht  werden  soll.  Die  drei  folgenden Optionen entsprechen den drei
  383. Schaltern   im   Such-Fenster.   Wird   'IGNORE'   angegeben,  wird  keine
  384. Unterscheidung  zwischen  Groß- und Kleinschreibung gemacht. Normalerweise
  385. wird immer von der aktuellen Position an vorwärts gesucht; dies kann durch
  386. 'BACKWARD'  geändert  werden;  die  Suche  findet dann rückwärts statt. Im
  387. Normalfall  bricht  die  Suche  ab, wenn der Suchbegriff im aktuellen Text
  388. nicht  gefunden  werden  konnte.  Wird  jedoch 'ALL' angegeben, durchsucht
  389. HotHelp  in diesem Fall alle zum aktuellen Muster passenden Schlüssel nach
  390. dem  gesuchten Begriff. Die Suchrichtung hängt auch hierbei wieder von der
  391. 'BACKWARD'-Option ab.
  392.  
  393.  
  394. HH_SetStrGadget
  395. ---------------
  396.  
  397. Format:        HH_SetStrGadget Id Project Key
  398.  
  399. Schablone:     HH_SetStrGadget Id/A/N,Project/A,Key/A
  400.  
  401. Beschreibung:
  402.  
  403.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  404. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  405. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  406. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  407. ab.
  408.  
  409.    Dieser  Befehl  trägt  zwei  neue  Strings in das Eingabegadget für den
  410. Projekt-  und  den  Schlüssel-Namen  eines HotHelp-Fensters ein. Es werden
  411. dieselben  Aktionen  durchgeführt,  wie wenn der User einen neuen Projekt-
  412. und Schlüssel-Begriff einträgt und dann über Return bestätigt.
  413.  
  414.  
  415. HH_Status
  416. ---------
  417.  
  418. Format:        HH_Status Id PRO|KEY|ACT_PRO|ACT_KEY|WIN_LINES|WIN_COLUMNS|
  419.                             TXT_LINES|TXT_COLUMNS|FIRST_LINE|FIRST_COLUMN
  420.  
  421. Schablone:     HH_Status Id/A/N,Ask/A
  422.  
  423. Beschreibung:
  424.  
  425.    Dieser  Befehl  erfragt  den  Status  eines vorher über 'HH_OpenWindow'
  426. geöffneten  HotHelp-Fensters.  Als  'Id'  muß  dazu  die  ID  des  Fenster
  427. angegeben  werden,  die  beim  Öffnen zurückgegeben wurde. Der Befehl darf
  428. auch an ein bereits wieder geschlossenes Fenster geschickt werden; HotHelp
  429. fängt diesen Fall ab.
  430.  
  431.    Abhängig   von  dem  angegebenen  Schlüsselwort  gibt  HotHelp  in  der
  432. Variablen  'Result'  den  gewünschten Wert zurück. Es können die folgenden
  433. Werte abgefragt werden:
  434.  
  435.    PRO, KEY:
  436.       Der aktuelle Inhalt des Projekt- bzw. Schlüssel-Eingabefeldes.
  437.    ACT_PRO, ACT_KEY:
  438.       Der  Name  des Projektes, aus dem der aktuelle Text stammt, bzw. der
  439.       Name  des  Schlüssels,  unter  dem  er angesprochen wurde. Wurde als
  440.       Projekt-  oder  Schlüssel-Name  ein  Muster angegeben, unterscheidet
  441.       sich  dieser  Wert  von  dem  durch 'PRO' bzw. 'KEY' zurückgegebenen
  442.       Pattern-String.
  443.    WIN_LINES, WIN_COLUMNS:
  444.       Über  diese  beiden Schlüssel kann die Anzahl von Zeilen und Spalten
  445.       ermittelt  werden,  die  im HotHelp-Fenster gleichzeitig dargestellt
  446.       werden können.
  447.    TXT_LINES, TXT_COLUMNS:
  448.       Gibt  an,  wieviele Zeilen und Spalten der aktuelle Text beinhaltet.
  449.       Als  Spaltenzahl  wird  die  Breite  der  längsten  Zeile des Textes
  450.       zurückgegeben.
  451.    FIRST_LINE, FIRST_COLUMN:
  452.       Gibt die Nummer der ersten im Fenster sichtbaren Zeile und Spalte an
  453.       (von 0 an gezählt).
  454.  
  455.    Bei  jedem  Aufruf  des  Befehls  kann  nur eines dieser Schlüsselworte
  456. angegeben  werden; sollen mehrere Werte abgefragt werden, muß das Kommando
  457. also  entsprechend  oft aufgerufen werden, wobei die jeweiligen Ergebnisse
  458. in anderen Variablen festgehalten werden sollten.
  459.  
  460.  
  461. HH_WaitForWindow
  462. ----------------
  463.  
  464. Format:        HH_WaitForWindow Id
  465.  
  466. Schablone:     HH_WaitForWindow Id/A/N
  467.  
  468. Beschreibung:
  469.  
  470.    Dieser  Befehl  manipuliert  ein vorher über 'HH_OpenWindow' geöffnetes
  471. HotHelp-Fenster.  Als  'Id'  muß dazu die ID des Fenster angegeben werden,
  472. die  beim  Öffnen zurückgegeben wurde. Der Befehl darf auch an ein bereits
  473. wieder  geschlossenes  Fenster geschickt werden; HotHelp fängt diesen Fall
  474. ab.
  475.  
  476.     Ein   über   ARexx   geöffnetes   HotHelp-Fenster  läuft  parallel  zum
  477. ARexx-Programm  ab  -  d.h.,  die  auf  den HH_OpenWindow-Aufruf folgenden
  478. Befehle  werden  ausgeführt,  sobald das HotHelp-Fenster geöffnet ist. Mit
  479. Hilfe  dieses  Befehls kann die Ausführung des ARexx-Programms nun solange
  480. angehalten werden, bis das HotHelp-Fenster vom Anwender wieder geschlossen
  481. wird. Erst dann werden die darauf folgenden Befehle ausgeführt.
  482.  
  483.