home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / util / edit / polyed / doc / arexx.doc next >
Text File  |  1994-09-29  |  16KB  |  542 lines
  1.  
  2.                        PolyEd's ARexx commands
  3.  
  4.                     Copyright © 1994 Avalon UnLtd.
  5.                       Written by Robert Brandner
  6.                          All Rights Reserved
  7.  
  8.  
  9. Like every good program, PolyEd provides an ARexx Port. This document
  10. describes all ARexx commands, PolyEd supports. For details about
  11. results, naming of ports etc. see the main guide (it's name depends
  12. on your preferred language).
  13.  
  14. Sorry, this document is - at the moment - only available in english.
  15.  
  16.  
  17. --------------------------------------------------------------------------
  18.  
  19. ACTIVATEWINDOW
  20.    ,
  21.  
  22. ACTIVATEWINDOW activates the first window of the project.
  23.  
  24. --------------------------------------------------------------------------
  25.  
  26. BACKSPACE
  27.    ,
  28.  
  29. BACKSPACE deletes the character left to the cursor. At the beginning
  30. of a line, the EOL character of the previous line is deleted, and so
  31. the previous and the current line are joined.
  32.  
  33. --------------------------------------------------------------------------
  34.  
  35. BLOCK
  36.    START/S,FORGET/S
  37.  
  38. BLOCK starts or forgets block selection.
  39.  
  40.  · START starts block selection. Following cursor movements will
  41.    select the block. Then you may CUT, COPY or ERASE the block.
  42.  · FORGET forgets selection.
  43.  
  44. Inserting or deleting text, or any mouse actions by the user,
  45. have the same effect as BLOCK FORGET, So you should "LOCKGUI", to
  46. avoid unwanted actions by the user.
  47.  
  48. --------------------------------------------------------------------------
  49.  
  50. CHANGEWINDOW
  51.    LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N
  52.  
  53. CHANGEWINDOW changes the position and size of the first window of
  54. the project.
  55.  
  56. --------------------------------------------------------------------------
  57.  
  58. CLOSE
  59.    FORCE/S
  60.  
  61. CLOSE closes the project and its window(s). If the project has been
  62. modified, the modified project requester comes up, asking the user if
  63. he wants to save the project first.
  64.  
  65.  · FORCE suppresses the modified project requester.
  66.  
  67. --------------------------------------------------------------------------
  68.  
  69. COLUMN
  70.    DELTA/N/A
  71.  
  72. COLUMN accepts positive and negative values, to move the cursor left or 
  73. right relative to its current position.
  74.  
  75. --------------------------------------------------------------------------
  76.  
  77. COPY 
  78.    ,
  79.  
  80. COPY places a duplicate of the currently selected block into the 
  81. clipboard.
  82.  
  83. --------------------------------------------------------------------------
  84.  
  85. CURSOR
  86.    UP/S,DOWN/S,LEFT/S,RIGHT/S
  87.  
  88. CURSOR moves the cursor up, down, left or right a single line or
  89. column position.
  90.  
  91. --------------------------------------------------------------------------
  92.  
  93. CUT
  94.    LINE/S,EOL/S
  95.  
  96. CUT removes the currently selected block from the project, and places
  97. it in the clipboard.
  98.  
  99.  · LINE cuts the current line (incl. EOL)
  100.  · EOL cuts from current cursor position to end of line (excl. EOL)
  101.  
  102. --------------------------------------------------------------------------
  103.  
  104. DELETE
  105.    ,
  106.  
  107. DELETE removes the character right to the cursor.
  108.  
  109. --------------------------------------------------------------------------
  110.  
  111. ERASE
  112.    ,
  113.  
  114. ERASE removes the selected block from the project.
  115.  
  116. --------------------------------------------------------------------------
  117.  
  118. FIND
  119.    PROMPT/S,NEXT/S,PREVIOUS/S,TEXT/F
  120.  
  121. FIND searches for text that matches the specified text.
  122.  
  123.  · PROMPT opens the Find requester, but does not search.
  124.  · NEXT searches for the next occurence of findstring.
  125.  · PREVIOUS searches for the previous occurence of findstring.
  126.  · TEXT sets findstring to specified text.
  127.  
  128. 'FIND NEXT' finds the next occurence of whatever findstring is.
  129. 'FIND foobar' sets findstring to 'foobar' but does not search.
  130. 'FIND NEXT foobar' sets findstring to 'foobar' and searches.
  131. 'FIND PROMPT' opens the Find requester.
  132.  
  133. --------------------------------------------------------------------------
  134.  
  135. FINDCHANGE
  136.    FINDCHANGE PROMPT/S,FIND/K,CHANGE/K,ALL/S
  137.  
  138. Searches for text and replaces it by another text. This is done  like 
  139. replace from the menu, i. e. if the selected block matches findstring 
  140. it is replaced by changestring, else nothing is done. Then the next 
  141. occurence of findstring is selected. 
  142.  
  143.  · PROMPT opens the Find & Change requester, but does not search.
  144.  · FIND sets findstring to specified text.
  145.  · CHANGE sets changestring to specified text.
  146.  · ALL searches and changes from current cursor position to end
  147.    of text.
  148.  
  149. 'FINDCHANGE FIND foobar CHANGE hello' sets findstring to 'foobar',
  150. changestring to 'hello' and does a find & replace.
  151. 'FINDCHANGE' does a find & replace with current findstring
  152. and changestring.
  153.  
  154. --------------------------------------------------------------------------
  155.  
  156. FINDNEXT
  157.    ,
  158.  
  159. FINDNEXT finds the next occurence of findstring.
  160.  
  161. --------------------------------------------------------------------------
  162.  
  163. FINDPREVIOUS
  164.    ,
  165.  
  166. FINDPREVIOUS finds the previous occurence of findstring.    
  167.  
  168. --------------------------------------------------------------------------
  169.  
  170. GETATTR
  171.    OBJECT/A,NAME,FIELD
  172.  
  173. GETATTR obtains information about the attributes of an object.
  174.  
  175.  · OBJECT specifies the object type to obtain information on.
  176.  · NAME specifies the name of the object.
  177.  · FIELD spceifies which field should be checked for information.
  178.  
  179. In the above OBJECT you may seek information an the attributes of 
  180. any of the following items:
  181.  
  182.  · APPLICATION
  183.  · PROJECTS
  184.  · PROJECT <name>
  185.  · MACROS
  186.  · MACRO <name>
  187.  
  188. If the destination variable is a stem variable, the following fields 
  189. are available:
  190.  
  191. APPLICATION consists of the following nodes (an aspect of APPLICATION
  192. you can seek sub-information about):
  193.  
  194.  · VERSION         Contains the current version information.
  195.  · SCREEN        Contains the name of the public screen, 
  196.             PolyEd resides in.
  197.  · CURRENT        Contains the name of current project's
  198.             arexx port.
  199.  · AREXX        Contains the name of PolyEd's global port.
  200.  · VAR_BLOCKSTARTLINE      These four nodes ...
  201.  · VAR_BLOCKSTARTCOL    ... contain the beginning ...
  202.  · VAR_BLOCKENDLINE    ... and end of ...
  203.  · VAR_BLOCKENDCOL    ... the selected block.
  204.  · VAR_FINDSTRING    Contains the findstring FIND, FINDCHANGE,
  205.             FINDNEXT and FINDPREVIOUS look for.
  206.  · VAR_CHANGESTRING    Contains the changestring, FINDCHANGE uses.
  207.  · FLAG_IGNORECASE    Contains the status of 'Ignore Case?'.
  208.  · FLAG_WHOLEWORDS    Contains the status of 'Whole Words?'.
  209.  · VAR_ARRANGEMODE    Contains the status of window arrange style
  210.             ( 0=stacked, 1=vertical, 2=horizontal, 3=full size )
  211.  · FLAG_LEARNING    Contains the status of 'Learn macro'.
  212.  · VAR_RIGHTBORDER    Contains right border value (from settings).
  213.  · VAR_TABWIDTH        Contains Tab width value (from settings).
  214.  · FLAG_OVERWRITE    Contains the status of 'Overwrite?'.
  215.  · FLAG_AUTOINDENT    Contains the status of 'Auto indent?'.
  216.  · FLAG_TABISSPACES    Contains the status of 'TAB is spaces?'.
  217.  · FLAG_CREATEICONS    Contains the status of 'Create icons?'.
  218.  · VAR_FULLINES        Contains the status of 'Full Lines'
  219.             ( 0=ignore, 1=word wrap ).
  220.  · VAR_AUTOSAVE      Contains the status of 'Auto Save'
  221.             ( 0=never, 1=every 5 min, 2=every 10 min, 
  222.             3=every 15 min, 4=every 30 min, 5=every hour ).
  223.  · VAR_BACKUPS        Contains the status of 'Backups'
  224.             ( 0=none, 1=last version, 2=infinite ).
  225.  · VAR_SAVEAS        Contains the status of 'Save as'
  226.             ( 0=ASCII, 1=IFF FTXT ).
  227.  
  228. PROJECTS.COUNT contains the number of projects; PROJECTS.0 through 
  229. PROJECTS.n contain the name of the project.
  230.  
  231. PROJECT consists of the following nodes:
  232.  
  233.  · AREXX        Contains the ARexx port of the project.
  234.  · FILENAME        Contains the complete filename of the project.
  235.  · PATH            Contains the path portion of the filename.
  236.  · FILE            Contains the file portion of the filename.
  237.  · LINES        Contains the number of lines of the project.
  238.  · CHANGES        Contains the number of cchanges mode to the 
  239.             project (since last save).
  240.  
  241. MACROS.COUNT contains the number of macros; MACROS.0 through 
  242. MACROS.n contain the name of the macro.
  243.  
  244. MACRO consists of the following nodes:
  245.  
  246.  · FILENAME        Contains the filename of the macro.
  247.  · HOTKEY        Contains the macros hotkey.
  248.  
  249. See the demo program 'getattr.ped' for how to use this complex command.
  250.  
  251. --------------------------------------------------------------------------
  252.  
  253. GETCHAR 
  254.    ,
  255.  
  256. GETCHAR returns the character right to (or under) the cursor.
  257.  
  258. --------------------------------------------------------