wiki:Documentation/ARexxAPI/WRITEEDITOR

Version 6 (modified by Jens Maus, 3 years ago) (diff)

--

Languages:

ARexx Function List

  1. Documentation/ARexxAPI/ADDRDELETE
  2. Documentation/ARexxAPI/ADDREDIT
  3. Documentation/ARexxAPI/ADDRFIND
  4. Documentation/ARexxAPI/ADDRGOTO
  5. Documentation/ARexxAPI/ADDRINFO
  6. Documentation/ARexxAPI/ADDRLOAD
  7. Documentation/ARexxAPI/ADDRNEW
  8. Documentation/ARexxAPI/ADDRRESOLVE
  9. Documentation/ARexxAPI/ADDRSAVE
  10. Documentation/ARexxAPI/APPBUSY
  11. Documentation/ARexxAPI/APPNOBUSY
  12. Documentation/ARexxAPI/FINDMAIL
  13. Documentation/ARexxAPI/FLUSHINDEXES
  14. Documentation/ARexxAPI/FOLDERINFO
  15. Documentation/ARexxAPI/GETCONFIGINFO
  16. Documentation/ARexxAPI/GETFOLDERINFO
  17. Documentation/ARexxAPI/GETMAILINFO
  18. Documentation/ARexxAPI/GETSELECTED
  19. Documentation/ARexxAPI/GETURL
  20. Documentation/ARexxAPI/HELP
  21. Documentation/ARexxAPI/HIDE
  22. Documentation/ARexxAPI/INFO
  23. Documentation/ARexxAPI/ISONLINE
  24. Documentation/ARexxAPI/LISTFREEZE
  25. Documentation/ARexxAPI/LISTSELECT
  26. Documentation/ARexxAPI/LISTUNFREEZE
  27. Documentation/ARexxAPI/MAILARCHIVE
  28. Documentation/ARexxAPI/MAILBOUNCE
  29. Documentation/ARexxAPI/MAILCHANGESUBJECT
  30. Documentation/ARexxAPI/MAILCHECK
  31. Documentation/ARexxAPI/MAILCOPY
  32. Documentation/ARexxAPI/MAILDELETE
  33. Documentation/ARexxAPI/MAILEDIT
  34. Documentation/ARexxAPI/MAILEXPORT
  35. Documentation/ARexxAPI/MAILFILTER
  36. Documentation/ARexxAPI/MAILFORWARD
  37. Documentation/ARexxAPI/MAILIMPORT
  38. Documentation/ARexxAPI/MAILINFO
  39. Documentation/ARexxAPI/MAILMOVE
  40. Documentation/ARexxAPI/MAILREAD
  41. Documentation/ARexxAPI/MAILREPLY
  42. Documentation/ARexxAPI/MAILSEND
  43. Documentation/ARexxAPI/MAILSENDALL
  44. Documentation/ARexxAPI/MAILSTATUS
  45. Documentation/ARexxAPI/MAILUPDATE
  46. Documentation/ARexxAPI/MAILWRITE
  47. Documentation/ARexxAPI/NEWMAILFILE
  48. Documentation/ARexxAPI/QUIT
  49. Documentation/ARexxAPI/READCLOSE
  50. Documentation/ARexxAPI/READINFO
  51. Documentation/ARexxAPI/READPRINT
  52. Documentation/ARexxAPI/READSAVE
  53. Documentation/ARexxAPI/REQUEST
  54. Documentation/ARexxAPI/REQUESTFILE
  55. Documentation/ARexxAPI/REQUESTFOLDER
  56. Documentation/ARexxAPI/REQUESTSTRING
  57. Documentation/ARexxAPI/RESTART
  58. Documentation/ARexxAPI/SCREENTOBACK
  59. Documentation/ARexxAPI/SCREENTOFRONT
  60. Documentation/ARexxAPI/SETFLAG
  61. Documentation/ARexxAPI/SETFOLDER
  62. Documentation/ARexxAPI/SETMAIL
  63. Documentation/ARexxAPI/SETMAILFILE
  64. Documentation/ARexxAPI/SHOW
  65. Documentation/ARexxAPI/USERINFO
  66. Documentation/ARexxAPI/WRITEATTACH
  67. Documentation/ARexxAPI/WRITEBCC
  68. Documentation/ARexxAPI/WRITECC
  69. Documentation/ARexxAPI/WRITEEDITOR
  70. Documentation/ARexxAPI/WRITEFROM
  71. Documentation/ARexxAPI/WRITEIDENTITY
  72. Documentation/ARexxAPI/WRITELETTER
  73. Documentation/ARexxAPI/WRITEMAILTO
  74. Documentation/ARexxAPI/WRITEOPTIONS
  75. Documentation/ARexxAPI/WRITEQUEUE
  76. Documentation/ARexxAPI/WRITEREPLYTO
  77. Documentation/ARexxAPI/WRITESEND
  78. Documentation/ARexxAPI/WRITESUBJECT
  79. Documentation/ARexxAPI/WRITETO

WRITEEDITOR

NAME
WriteEditor -- Pass an ARexx command to the internal editor. (V2.0)
TEMPLATE
VAR/K,STEM/K,COMMAND/A
FUNCTION
Passes an ARexx command to the internal editor to act upon the contents of a given Write window.

Quoting the TextEditor.mcc class autodoc, the following commands are currently supported:

 CLEAR
 CUT
 COPY
 PASTE
 ERASE
 GOTOLINE       Template: /N/A
 GOTOCOLUMN     Template: /N/A
 CURSOR         Template: Up/S,Down/S,Left/S,Right/S
 LINE           Template: /N/A
 COLUMN         Template: /N/A
 NEXT           Template: Word/S,Sentence/S,Paragraph/S,Page/S
 PREVIOUS       Template: Word/S,Sentence/S,Paragraph/S,Page/S
 POSITION       Template: SOF/S,EOF/S,SOL/S,EOL/S,SOW/S,EOW/S,SOV/S,EOV/S
 SETBOOKMARK    Template: /N/A
 GOTOBOOKMARK   Template: /N/A
 TEXT           Template: /F
 UNDO
 REDO
 GETLINE
 GETCURSOR      Template: Line/S,Column/S
 MARK           Template: On/S,Off/S
 DELETE
 BACKSPACE
 KILLLINE
 TOUPPER
 TOLOWER

Refer to the Amiga User Interface Style Guide for more info about these commands.

Please note that because of the internal use of the ReadArgs() function, the ARexx Host requires to escape certain special characters like a newline (0x0a) or escape character (0x1b) if you want to pass it i.e. with an TEXT command to the texteditor.

This means that you have to use the following escape sequences in your provided strings:

*N substitutes to 0x0a
*E substitutes to 0x1b
!** substitutes to *
*" substitutes to "

Please have a look at the examples below for a short example on how to use these escape sequences properly.

INPUTS
VAR/K - alternative variable to put the results into instead of RESULT
STEM/K - base name used for the stem where the result will be stored
COMMAND/A - the command string to be passed
RETURNS
VAR - info returned by the query
<STEM>RESULT - results of the command, if any

RC is set to 10 if no Write window was previously specified as "active" with MAILWRITE.

NOTES
EXAMPLE
/* Enable result codes */
OPTIONS RESULTS

/* Start a new mail */
MAILWRITE STEM st.
win = st.window

/* Edit the Write window */
MAILWRITE WINDOW win
WRITETO 'boss@example.com'
'WRITESUBJECT "I do not think I can go to work today"'

/* Clear the editor */
WRITEEDITOR CLEAR

/* Write some text into the editor */
'WRITEEDITOR "TEXT Sorry, but I am sick today!"'

/* Write some text containing a newline (*N) */
'WRITEEDITOR "TEXT Hello Joe,*N I would like to meet you."'
BUGS
SEE ALSO
MAILWRITE