home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / HYPERBOOK2.DMS / in.adf / ARexx.hb (.txt) < prev    next >
Encoding:
HyperBook  |  1991-01-28  |  174.7 KB  |  2,724 lines
  1. Note1
  2. This is a test page to
  3. demonstrate the MASTERTOPAGE
  4. command. Click on the RETURN
  5. button to delete this page and
  6. return to the page you were on.
  7. Button1
  8. /* RETURN */
  9. pg = currentpage()
  10. call return()
  11. call delete(pg)
  12. Test master
  13. #(bes
  14. W/* Toggle name of object on this page between 'Button1' and 'First button'. */
  15. btn   = searchname(':','Button1')
  16. found = 0
  17. if length(btn) > 0 then do
  18.    if getpage(btn) == currentpage() then do
  19.       newname = 'First button'
  20.       found   = 1
  21.       end
  22.    end
  23. if found == 0 then do
  24.    btn = searchname(':', 'First button')
  25.    if length(btn) > 0 then do
  26.       if getpage(btn) == currentpage() then do
  27.          newname = 'Button1'
  28.          found   = 1
  29.          end
  30.       end
  31.    end
  32. if found == 1 then
  33.    say "The old button name was" setname(btn, newname)
  34.    say "Couldn't find the button."
  35. ChangeButtonName
  36. /* Toggle name of this page between 'setname' and 'modified setname'. */
  37. oldname = getname(':')
  38. found   = 1
  39. if oldname == 'setname' then do
  40.    newname = 'modified setname'
  41.    end
  42. else do
  43.    if oldname == 'modified setname' then do
  44.       newname = 'setname'
  45.       end
  46.    else
  47.       found = 0
  48.    end
  49. if found == 1 then
  50.    say 'Old page name:' setname(':', newname)
  51.    say 'This macro is meant for the "setname" page only.'
  52. ChangePageName
  53. 5/* Delete everything on the current page, the Bin, and the page. */
  54.  * Build a list of all the buttons on Page 1 which refer to the
  55.  * page we're about to delete, so we can restore their actions later.
  56. pagenum = getpage(":")
  57. pagename = getname(":")
  58. list = searchname("1:", "Section List")
  59. fixitems = ""
  60. do i=1 to totalelements(list)
  61.    item = list"/"i
  62.    if getaction(item)="gopage" & getactiontext(item)=pagename then
  63.       fixitems = fixitems item
  64. call clonepage(':', sequencenumber(":") + 1)
  65. n = numelements(':')
  66. do i = 1 to n
  67.    ob = objectnumber(':', 1)
  68.    if gettype(ob) == 'List' then do
  69.       ln = numelements(ob)
  70.       do j = 1 to n
  71.          call delete(objectnumber(ob, j))
  72.          end
  73.       end
  74.    call delete(ob)
  75.    call refreshpage()
  76.    end
  77. call delete('0:')
  78. call delete(':')
  79.  * When a page is deleted, all objects whose actions are to go to that
  80.  * page, have their actions reset to "no action".
  81.  * So we now have to fix them.
  82. do while fixitems ~= ""
  83.    parse var fixitems item fixitems
  84.    call setactionpage(item, pagenum)
  85. DeleteStuff
  86. /* FindAction - say action type of object clicked on by user */
  87. prompt = 'Click to find out the action of an object on this page...'
  88. obj    = GetObject(prompt)
  89. if length(obj) == 0 then
  90.    say 'This macro only works on objects.'
  91. else do
  92.    type = gettype(obj)
  93.    if type == 'Page' || type == 'Bin' || type == 'Item' then
  94.       say 'This macro only works on objects.'
  95.    else
  96.       say 'Action type is:' getaction(obj)
  97.    end
  98. FindAction
  99. /* FindActionText - give action text of object clicked on by user */
  100. prompt = 'Click to find out the action of an object on this page...'
  101. obj    = GetObject(prompt)
  102. if length(obj) == 0 then
  103.    say 'This macro only works on objects.'
  104. else do
  105.    type = gettype(obj)
  106.    if type == 'Page' || type == 'Bin' || type == 'Item' then
  107.       say 'This macro only works on objects.'
  108.    else
  109.       text = getactiontext(obj)
  110.       if length(text) > 0 then
  111.          say 'Action text:' '0a'X ' ' text
  112.       else
  113.          say 'Action text: none'
  114.    end
  115. FindActionText
  116. /* RelocateItem - moves Initiator() item from
  117.    'reloc list 1' to 'reloc list 2' or vice versa.
  118. L1 = searchname(':','reloc list 1')
  119. L2 = searchname(':','reloc list 2')
  120. it = initiator()
  121.    if length(it) > 0 then if gettype(it) == 'Item' then break
  122.    say 'This macro must be launched from a list item.'
  123.    EXIT
  124.    end
  125. plist = parent(it)
  126. if plist == L1 then
  127.    call relocate(it, L2)
  128. else if plist == L2 then
  129.    call relocate(it, L1)
  130.    say "Use this macro with the two lists on the `relocate' page."
  131. RelocateItem
  132. /* Relocate object - moves 'reloc button' from 'reloc group' to the current
  133.    page or back again.
  134. call interactive(0)
  135. init = initiator()
  136. if length(init) == 0 then do
  137.    say 'This macro must be launched from an object.'
  138.    EXIT
  139.    end
  140. par = parent(init)
  141. grp = 'reloc group'()
  142. call setbackground(grp,-1)
  143. if par == grp then
  144.    call relocate(init, ':')
  145. else do
  146.    call relocate(init, grp)
  147.    call setbackground(grp,5)
  148.    end
  149. RelocateObject
  150. ^/* CloneItem - clones Initiator() item from
  151.    'clone list 1' to 'clone list 2' or vice versa.
  152. list1 = searchname(':','clone list 1')
  153. list2 = searchname(':','clone list 2')
  154. init = initiator()
  155. launch_ok = 1
  156. if length(init) == 0 then launch_ok = 0
  157. else if gettype(init) ~= 'Item' then launch_ok = 0
  158. if launch_ok == 0 then do
  159.    say 'This macro must be launched from a list item.'
  160.    EXIT
  161.    end
  162. plist = parent(init)
  163. if plist == list1 then call clone(init, list2)
  164. else do
  165.    if plist == list2 then call clone(init, list1)
  166.    else say 'Use this macro with the two lists on the "clone" page.'
  167.    end
  168.     CloneItem
  169. /* Clone object - clones 'clone button' to 'clone group', renames it
  170.    'cloned button', and repositions it 10 pixels right and 5 lines up from
  171.    the group's top left, unless that would be less than 0, in which case it
  172.    repositions below and to the right of the bottom left.
  173. init = initiator()
  174. if length(init) == 0 then do
  175.    say 'This macro must be launched from an object.'
  176.    EXIT
  177.    end
  178. grp = searchname(':','clone group')
  179. if length(grp) > 0 then do
  180.    new = clone(init, grp)
  181.    call setname(new, 'cloned button')
  182.    left = getleft(grp) + 100
  183.    top  = gettop(grp) - 5
  184.    if top < 0 || left > getwidth(':') then top = top + getheight(grp) + 10
  185.    call setposition(new, left, top)
  186.    end
  187. CloneObject
  188. /* ListCurrentPage   List the objects on this page by number and name */
  189. ob = objectnumber(':',1)
  190. pg = currentpage()
  191. do while getpage(ob) == pg
  192.    say ob getname(ob)
  193.    ob = getnext(ob)
  194.    if length(ob) == 0 then EXIT     /* This happens if on last page */
  195.    end
  196. ListCurrentPage
  197. O/* LastPage - call last page of HyperBook */
  198. call callpage(numpages() || ':')
  199. LastPage
  200. b/* Select object by clicking */
  201. y = getclickrow(arg(1))
  202. x = getcolumn()
  203. return getobjectat(x,y)
  204. GetObject(prompt)
  205. x/* Returns the text used by the setaction buttons */
  206. return 'b=initiator(); call setbackground(b, 9-getbackground(b))'
  207. getBGtext(void)
  208. a/* run as a macro the text of the initiating button */
  209. interpret readnotetext(initiator(),0,-1)
  210. ExecuteText()
  211. /* FindPage - The action for all the items in the lists on the index page
  212.    is to run this macro. It finds the page whose title is the same as the
  213.    item text, then visits the page with callpage().
  214. nm = getitemtext(initiator())
  215. pn = 2
  216. do until getname(pg) = nm
  217.    pg = searchpagename(objectnumber('', pn + 1), nm)
  218.    if pg = '' then EXIT
  219.    pn = sequencenumber(pg)
  220.    end
  221. call callpage(pg)
  222. FindPage()
  223. /* ListSectionContents - activated by button on page 1 of this book */
  224. cr    = '0a'X
  225. list  = searchname(':', 'Section list')
  226. item  = selectitem(list, 'Click on a section name in the list')
  227. actxt = getactiontext(item)
  228. text  = cr || '  Contents of `' || getitemtext(item) || ''' section  ' || cr || cr
  229. start = sequencenumber(searchpagename(':', actxt))
  230. item  = getnext(item)
  231. if length(item) > 0 then
  232.    stop = sequencenumber(searchpagename('', getactiontext(item))) - 1
  233.    stop = numpages()
  234. left = 1
  235. do i = start to stop
  236.    name = getname(objectnumber('', i))
  237.    if left then
  238.       text = text '  ' left(name, 20)
  239.    else do
  240.       text = text name '  ' cr
  241.       end
  242.    left = 1 - left
  243.    end
  244. if left == 0 then text = text || cr
  245. call inform(text)
  246. List section contents
  247. /* This page entry macro is used only to assign "hdat:" to its proper
  248.    place when this hyperbook is first loaded. After that it uses the
  249.    visibility of the "AssignInfo" note as a flag meaning "Don't redo
  250.    the assign". Change this macro as needed to use the ARexx hyperbook
  251.    in different environments.
  252.    If you need to save this hyperbook for some reason, make sure the
  253.    AssignInfo note is invisible at the time.
  254. if sequencenumber(':') = 1 then do
  255.    note = searchname(':','AssignInfo')
  256.    if length(note) > 0 then do
  257.       if ~getvisibility(note) then do
  258.          address command "assign hdat: HB_Samples:hbk"
  259.          call setvisibility(note, 1)
  260.          end
  261.       end
  262.    end
  263. PageEntryMacro
  264. /* INTERACTIVE demo
  265.    This is called from the page about the Interactive() command. The items
  266.    in the first half of the list on that page are changed to a different
  267.    color. Because interactive mode is on, each is refreshed separately,
  268.    which is rather slow and messy. The bottom half of the list is processed
  269.    in the same way, but with interactive mode off, so the refresh is not
  270.    done until after the macro terminates.
  271. list = 'interactive list'()
  272. n    = numelements(list)
  273. do i = 1 to 5
  274.    item = objectnumber(list, i)
  275.    call setitemcolor(item, 3 - getitemcolor(item))
  276.    end
  277. call interactive(0)
  278. do i = 6 to n
  279.    item = objectnumber(list, i)
  280.    call setitemcolor(item, 3 - getitemcolor(item))
  281. INTERACTIVE demo
  282. Note1
  283. HML Functions
  284. The sections listed at right
  285. split the HML ARexx
  286. functions into groups (by
  287. color) and subgroups (by
  288. line). To go to the first
  289. page of any section, click
  290. on its name. To see the
  291. functions documented in a
  292. given section, click on the
  293. `List Section Contents'
  294. button.
  295. "Section list"
  296.     HyperBook
  297. Navigation
  298. Main control panel
  299. General operations
  300. Page creation
  301. Master pages
  302. Page files
  303. Page editing
  304. Object creation
  305. Object editing
  306. Actions
  307. Note and button text
  308. Items and Lists
  309. Searches
  310. User input
  311. Text editing
  312. Printing
  313. Data display
  314. Language support
  315. Button1
  316. COMMAND INDEX
  317. Button2
  318. Sections
  319. Button3
  320. LIST SECTION
  321. CONTENTS
  322. "AssignInfo"
  323. id=inputstring("Enter hdat: directory","HB_Samples:");if length(d)>0 then address command "assign hdat:" d
  324. Button4
  325. ABOUT THIS
  326. HYPERBOOK
  327. "ARexx Commands"
  328. "Message from AHA!"
  329. The pages of this hyperbook
  330.  describe and illustrate each of the 137 HML
  331. functions. Many of the programming examples, while not necessarily useful in
  332. themselves, are sufficiently detailed to give a good idea of not only how
  333. but also 
  334.  a particular function might be used.
  335. Knowledge of ARexx
  336.  is needed for full understanding of the sample code.
  337. You will also need to know how HML `objnums' work (consult your owner's
  338. manual), and to be familiar with using HyperBook interactively.
  339. HML does not duplicate the interactive capabilities of HyperBook
  340. some areas it is more powerful, in others less. The design goal has been to
  341. make it useful in as many typical applications as possible. If HML lacks a
  342. capability you can't do without, don't suffer in silence. Write to us
  343. explaining the problem, and we'll try to address it in a future release.
  344. "About this hyperbook"
  345. List1
  346. activate
  347. appenditem
  348. beginprompt
  349. bigpanel
  350. callpage
  351.     clearlist
  352.     cleartext
  353. clone
  354.     clonepage
  355. controlpanel
  356. createbutton
  357. creategroup
  358. createlist
  359. createnote
  360. createpage
  361. currentpage
  362. delete
  363. deletemaster
  364. deletetext
  365. edittext
  366.     endprompt
  367. explode
  368. filerequest
  369. formattext
  370.     getaction
  371. getactiontext
  372. getbackground
  373.     getborder
  374. getclickrow
  375.     getcolumn
  376. getgroupdepth
  377.     getheight
  378. getitemcolor
  379. getitemtext
  380. getleft
  381. List2
  382. getname
  383. getnext
  384. getnextsib
  385. getobjectat
  386. getpage
  387. getpagecolors
  388. getpagelace
  389. getpagergb
  390. getprintwidth
  391. getresponse
  392.     getshadow
  393. gettop
  394. gettype
  395. getvisibility
  396. getwidth
  397. gotopage
  398. hyperbookname
  399. hyperbooktoback
  400. hyperbooktofront
  401. inform
  402.     initiator
  403.     inputform
  404. inputobject
  405.     inputpage
  406. inputstring
  407. insertitem
  408. inserttext
  409. interactive
  410. ismacro
  411. ismasterpage
  412. listheight
  413. listscroll
  414. loadhyperbook
  415. loadpage
  416. loadtext
  417. List3
  418. mastertopage
  419.     mergepage
  420. moveitem
  421.     movemacro
  422. nextpage
  423. numelements
  424. numpages
  425. objectnumber
  426. objecttoback
  427. objecttofront
  428. pagedim
  429. pagetomaster
  430. parent
  431. pause
  432. prevpage
  433.     printpage
  434. quithyperbook
  435. readnotetext
  436. refreshlist
  437. refreshpage
  438. relocate
  439. replacetext
  440. return
  441. savehyperbook
  442. savemoretext
  443. savepage
  444. savetext
  445. scale
  446. scaletosize
  447. searchitems
  448. searchname
  449. searchnote
  450. searchpagename
  451. searchstart
  452. List4
  453. searchtext
  454. selectitem
  455. sequencenumber
  456. setactiondos
  457. setactionlink
  458. setactionmacro
  459. setactionnone
  460. setactionpage
  461. setactionpic
  462. setactionread
  463. setactionrexx
  464. setactionshow
  465. setbackground
  466.     setborder
  467. setitemcolor
  468. setitemtext
  469. setname
  470. setpagecolors
  471. setpagelace
  472. setpagenumber
  473. setpagergb
  474. setposition
  475.     setshadow
  476. setvisibility
  477. shadowstyle
  478. showpic
  479. showtext
  480. showtextrange
  481. sortlist
  482.     tinypanel
  483. totalelements
  484. wiperoutine
  485. Note1
  486. Click on the name of the function
  487. you wish to learn about...
  488. "Command index"
  489. "numpages"
  490. num = NUMPAGES ()
  491. eturn the number of pages in
  492. the current hyperbook.
  493. Button1
  494. say numpages() 'pages'
  495. "numpages"
  496. PLNCNTSH
  497. "hyperbookname"
  498. name = HYPERBOOKNAME ()
  499. eturn the name (i.e. the full path
  500. name) of the current hyperbook.
  501. Button1
  502. say hyperbookname()
  503. "hyperbookname"
  504. "loadhyperbook"
  505. bool (0 or 1) = LOADHYPERBOOK (filename)
  506. oad the specified hyperbook.
  507. "Load demo"
  508. /* Attempt to load a hyperbook. This won't
  509.    succeed until after a run of the test
  510.    script for 
  511. savehyperbook
  512.  (see next page).
  513. thispage = currentpage()
  514. call beginprompt('Loading...')
  515. if loadhyperbook('ram:rexxtest.hb') then do
  516.    say 'Load succeeded.'
  517.    call gotopage(thispage)
  518.    end
  519.    say 'Load failed.'
  520. "loadhyperbook"
  521. "savehyperbook"
  522. bool (0 or 1) = SAVEHYPERBOOK (filename)
  523. ave the current hyperbook under the given name.
  524. "Save demo"
  525. /* Save hyperbook as 'ram:rexxtest.hb' */
  526. call beginprompt('Saving...')
  527. if savehyperbook('ram:rexxtest.hb') then
  528.    say 'Save succeeded.'
  529.    say 'Save failed.'
  530. "savehyperbook"
  531. 2INTB_COP
  532. "hyperbooktofront"
  533. HYPERBOOKTOFRONT ()
  534. ring the HyperBook screen to the front.
  535. Button1
  536. call hyperbooktoback()
  537. call pause(10)
  538. call hyperbooktofront()
  539. "hyperbooktofront"
  540. "hyperbooktoback"
  541. HYPERBOOKTOBACK ()
  542. ush the HyperBook screen to the back.
  543. Button1
  544. call hyperbooktoback()
  545. call pause(10)
  546. call hyperbooktofront()
  547. "hyperbooktoback"
  548. "quithyperbook"
  549. QUITHYPERBOOK ()
  550. xit the HyperBook program.
  551. Button1
  552. /* A chance to quit... */
  553. f getresponse('Really quit?') then
  554.    call quithyperbook()
  555. "quithyperbook"
  556. "nextpage"
  557. NEXTPAGE ()
  558. quivalent to the right arrow
  559. gadget on the main control panel.
  560. Button1
  561. call nextpage()
  562. "nextpage"
  563. "prevpage"
  564. PREVPAGE ()
  565. alent to the left arrow
  566. gadget on the main control panel.
  567. Button1
  568. call prevpage()
  569. "prevpage"
  570. P_PREFIX)
  571. "gotopage"
  572. old = GOTOPAGE (new)
  573. Go to the page whose objnum is 
  574. ; return the
  575. objnum of the departed page.
  576. Button1
  577. /* Go to a random page, then return here */
  578. pgnum   = rand(1, numpages())
  579. oldpage = gotopage(objectnumber('', pgnum))
  580. pgname  = getname(':')
  581. call gotopage(oldpage)
  582. say 'Page visited:' pgname '(' || pgnum || ')'
  583. "gotopage"
  584. uNU32
  585. "callpage"
  586. old = CALLPAGE (new)
  587. o to the given new page, and return the
  588. objnum of the departed page. A subsequent
  589. RETURN will go back to the departed page.
  590. Button1
  591. call callpage('1:')
  592. call return()
  593. "callpage"
  594. "return"
  595. newpage = RETURN ()
  596. ake current the last page called (from Table of Contents,
  597. CALLPAGE, etc.), and return the objnum of that page.
  598. Button1
  599. call callpage(objectnumber('', rand(1,numpages()) ))
  600. call return()
  601. "return"
  602. CINIT
  603. "bigpanel"
  604. BIGPANEL ()
  605. ut the main control panel into
  606. its `big' state.
  607. Button1
  608. call bigpanel()
  609. "bigpanel"
  610. "tinypanel"
  611. TINYPANEL ()
  612. ut the main control panel into
  613. its `tiny' state.
  614. Button1
  615. call tinypanel()
  616. "tinypanel"
  617. LAYERSUPER
  618. "controlpanel"
  619. CONTROLPANEL (bool)
  620. lose (arg = 0) or open (arg = 1) the
  621. main control panel.
  622. Button1
  623. call bigpanel()
  624. call controlpanel(0)
  625. call inform('The panel is gone')
  626. call controlpanel(1)
  627. "controlpanel"
  628. 0000000)
  629. "delete"
  630. DELETE (arg)
  631. elete a page, object or item, or
  632. empty the bin.
  633. Button1
  634. I call 
  635. DeleteStuff
  636. Note2
  637. The test button above calls the macro 
  638. DeleteStuff
  639. , which destroys everything
  640. on this page, the contents of the bin, and the page itself. (Nothing is
  641. permanently lost - the macro first clones this page.) To see the macro,
  642. select the menu item 
  643. ARexx/Edit macro
  644. , and pick 
  645. DeleteStuff
  646.  from the list.
  647. Group1
  648. Button1
  649. List1
  650. items
  651. deleted
  652. DeleteStuff
  653. macro.
  654. "delete"
  655. "relocate"
  656. new = RELOCATE (arg, newparent)
  657. ove the given object to the bin, a page or a group; or the given item
  658. to a new list. Return the new objnum of the object or item moved.
  659. Note2
  660. The button calls the 
  661. RelocateObject
  662.  macro, which alternately relocates
  663. it to the page and to the group with the black bar. List items clicked
  664. on are relocated to the other list using the 
  665. RelocateItem
  666.  macro.
  667. Button1
  668. Button2
  669. "reloc list 1"
  670. alpha
  671. gamma
  672. delta
  673. epsilon
  674. "reloc list 2"
  675. ALPHA
  676. GAMMA
  677. DELTA
  678. EPSILON
  679. "reloc group"
  680. Drawing1
  681. "reloc button"
  682. group
  683. Drawing2
  684. "reloc button"
  685. I call 
  686. RelocateObject
  687. "relocate"
  688. "getbackground"
  689. color = GETBACKGROUND (arg)
  690. eturn the background color number of a page or object
  691. (-1 is returned for transparent object backgrounds).
  692. Button1
  693. say 'Page background:' getbackground(':')
  694. Button2
  695. say 'Button background:' getbackground(initiator())
  696. "getbackground"
  697. "setbackground"
  698. oldcolor = SETBACKGROUND (arg, newcolor)
  699. et the background color of a page or object, and return the
  700. old color. The object transparent `color' is -1.
  701. Button1
  702. call setbackground(':', 8 - getbackground(':'))
  703. Button2
  704. b=initiator(); call setbackground(b, 8 - getbackground(b))
  705. "setbackground"
  706. "getwidth"
  707. width = GETWIDTH (arg)
  708. eturn the width in pixels of the given page or object.
  709. Button1
  710. say 'Page width =' getwidth(':')
  711. Button2
  712. say 'My width =' getwidth(initiator())
  713. "getwidth"
  714. "getheight"
  715. width = GETHEIGHT (arg)
  716. eturn the height in scan-lines of the given page or object.
  717. Button1
  718. say 'Page height =' getheight(':')
  719. Button2
  720. say 'My height =' getheight(initiator())
  721. "getheight"
  722.     "getname"
  723. name = GETNAME (arg)
  724. eturn the name of a page or object.
  725. Button1
  726. say 'Page name:' getname(':')
  727. Button2
  728. say 'My name:' getname(initiator())
  729.     "getname"
  730.     "setname"
  731. oldname = SETNAME (arg, newname)
  732. et the name of the given page or
  733. object, and return the previous
  734. name.
  735.     "Button1"
  736. I call 
  737. ChangeButtonName
  738. Note2
  739. The buttons call the 
  740. ChangeButtonName
  741.  macro, which toggles the name of
  742. the first button on the current page between 
  743. Button1
  744.  and 
  745. First button
  746. and reports the old name; and the similar 
  747. ChangePageName
  748.  macro.
  749. Button2
  750. I call 
  751. ChangePageName
  752.     "setname"
  753. "createpage"
  754. page = CREATEPAGE (frompage, number)
  755. reate a new page with the given page number using the page specified
  756. by the 
  757. frompage
  758.  objnum as a template. The new page is a clone
  759. frompage
  760.  but does not have any objects on it. Giving zero 
  761. the page number causes the new page to be appended to the hyperbook.
  762. Return the objnum of the new page.
  763. Button1
  764. /* Create and go to new page;
  765. clone the RETURN gadget onto it
  766. ret = 'ReturnFromCreate'()
  767. call callpage(createpage(':',0))
  768. call clone(ret, ':')
  769. "ReturnFromCreate"
  770. /* Return from cloned page */
  771. if numelements(':')==1 then do
  772. pg = currentpage()
  773. call return()
  774.    call delete(pg)
  775.    end
  776. "createpage"
  777. "clonepage"
  778. page = CLONEPAGE (frompage, number)
  779. reate a new page with the given page number using the page specified
  780. by the 
  781. frompage
  782.  objnum as a template. The new page is a clone
  783. frompage
  784. , including
  785. any objects on it.
  786. Giving zero as the page
  787. number causes the new
  788. page to be appended to
  789. the hyperbook. Return
  790. the objnum of the new
  791. page.
  792. Button1
  793. /* Clone this page; visit and rename clone */
  794. call callpage(clonepage(':',0))
  795. call setname(':', 'Copy of' getname(':'))
  796. Button2
  797. /* Delete page if it's the clone */
  798. if left(getname(':'), 7) == 'Copy of' then do
  799. pg = currentpage()
  800. call return()
  801.    call delete(pg)
  802.    end
  803. "clonepage"
  804. "mastertopage"
  805. page = MASTERTOPAGE(name, pos)
  806.  new page is created at position 
  807.  from the given
  808. master page. The objnum of the new page is returned.
  809. Button1
  810. call callpage(mastertopage('Test Master', 0))
  811. "mastertopage"
  812. "pagetomaster"
  813. PAGETOMASTER (page, name)
  814. Clone t
  815. he specified page, including any objects on it, and add it to the
  816. master page list under the given name.
  817. Button1
  818. /* Turn this page into a master page, create a page from it,
  819.    then delete both the created page and the master page.
  820. call pagetomaster(':','Temporary master')
  821. pg = mastertopage('Temporary master', 0)
  822. call callpage(pg)
  823. call inform("This page was made from 'Temporary Master'")
  824. call return()
  825. call delete(pg)
  826. call deletemaster('Temporary master')
  827. "pagetomaster"
  828. "ismasterpage"
  829. bool = ISMASTERPAGE (name)
  830. eturn TRUE (1) if the given name is that of an existing master page.
  831. Button1
  832. m = ismasterpage('Test Master')
  833. n = ismasterpage('Rumpelstiltskin')
  834. not.0 = 'not a'
  835. not.1 = 'a'
  836. say "`Test Master' is" not.m "master page."
  837. say "`Rumpelstiltskin' is" not.n "master page."
  838. "ismasterpage"
  839. "deletemaster"
  840. DELETEMASTER (name)
  841. elete the master page of the given name.
  842. Button1
  843. /* Step 1 */
  844. call pagetomaster('1:','Porthos')
  845. call pagetomaster('2:','Athos')
  846. call pagetomaster('3:','Aramis')
  847. call inform('Look at the master page list then run step 2')
  848. Button2
  849. /* Step 2 */
  850. call deletemaster('Porthos')
  851. call deletemaster('Athos')
  852. call deletemaster('Aramis')
  853. call inform('Three master pages have been deleted')
  854. "deletemaster"
  855. "loadpage"
  856. page = LOADPAGE (file, num)
  857. Load t
  858. he specified file as page 
  859. , and return the objnum of the
  860. newly-loaded page. A page number of 0 loads to the last page.
  861. Button1
  862. call callpage(loadpage('hdat:loadpage.pg',0))
  863. "loadpage"
  864. "mergepage"
  865. MERGEPAGE (parg, file)
  866. erge the objects in the specified page file
  867. onto the page whose objnum is 
  868. Button1
  869. call mergepage(':','hdat:mergepage.pg')
  870. "mergepage"
  871. "savepage"
  872. SAVEPAGE (parg, file)
  873. ave the specified page to the named file.
  874. Button1
  875. /* Save the current page, then load it in again to the
  876. same place. The first and last lines are hoop-jumping
  877. to avoid getting another copy of the ExecuteText macro.
  878. call setactionnone(initiator())
  879. call savepage(':','ram:foo.pg')
  880. n=sequencenumber(':')
  881. call delete(':')
  882. call gotopage(loadpage('ram:foo.pg',n))
  883. call setactionmacro('Button1'(), 'ExecuteText')
  884. "savepage"
  885. "getpagelace"
  886. bool (1 or 0) = GETPAGELACE (page)
  887. Returns 1 if the given page is in interlace mode, otherwise 0
  888. Button1
  889. if getpagelace(':') then n='on'; else n='off'; say 'Interlace is' n
  890. "getpagelace"
  891. "setpagelace"
  892. bool (1 or 0) = SETPAGELACE (page, bool)
  893. et the current page to interlace on (bool
  894. argument 1) or off (bool argument 0).
  895. Return the previous interlace state.
  896. Button1
  897. call setpagelace(':',1)
  898. Button2
  899. call setpagelace(':',0)
  900. "setpagelace"
  901. "getpagecolors"
  902. count = GETPAGECOLORS (page)
  903. eturn the number of colors in the palette of the given page.
  904. Button1
  905. say 'Color count =' getpagecolors(':')
  906. "getpagecolors"
  907. "setpagecolors"
  908. oldcount = SETPAGECOLORS (arg, count)
  909. et the number of colors (normalized to 4, 8 or 16) for
  910. the current page's palette, and return the old count.
  911. Button1
  912. /* Alternate between 8 and 16 colors */
  913. call setpagecolors(':', 24 - getpagecolors(':'))
  914. Group1
  915. Note1
  916. Drawing1
  917. Drawing2
  918. Drawing3
  919. Drawing4
  920. Drawing5
  921. Drawing6
  922. Drawing7
  923. Drawing8
  924. Drawing9
  925.     Drawing10
  926.     Drawing11
  927.     Drawing12
  928.     Drawing13
  929.     Drawing14
  930.     Drawing15
  931.     Drawing16
  932. "setpagecolors"
  933. "getpagergb"
  934. rgb = GETPAGERGB (page, reg)
  935. eturn the packed rgb value of color register 
  936.  on the given
  937. Button1
  938. say 'Color 3 RGB = $' || right(d2x(getpagergb(':',3)),4,'0')
  939. "getpagergb"
  940. "setpagergb"
  941. oldrgb = SETPAGERGB (page, reg, rgb)
  942. et the color register 
  943.  on the given page to the new
  944. rgb value, and return the old value of that register.
  945. Button1
  946. call setpagergb(':',0,c2d('0fda'x))
  947. Button2
  948. call setpagergb(':',0,c2d('0fff'x))
  949. "setpagergb"
  950. "wiperoutine"
  951. old = WIPEROUTINE (page, new)
  952. et/set the wipe effect used by the given
  953. page. Values for 
  954.  in the range 0 to 17 will
  955. change the page effect as per the list at
  956. right; other values (e.g. -1) do not select a
  957. new effect.
  958. "fxlist"
  959.  0 - NONE -
  960.  1 Instant
  961.  2 Left to right
  962.  3 Right to left
  963.  4 Top to bottom
  964.  5 Bottom to top
  965.  6 Curtain
  966.  7 Expand from center
  967.  8 Random blocks
  968.  9 Dissolve
  969. 10 Double dissolve
  970.     11 Blinds
  971. 12 Tiles - Expanding
  972. 13 Tiles - Shrinking
  973. 14 Tiles - Growing
  974. 15 Tiles - Diagonal
  975. 16 Tiles - Clock
  976. 17 Roll
  977. Button1
  978. /* Select and demonstrate page effect */
  979. list = 'fxlist'()
  980. it   = selectitem(list,'Select an effect')
  981. call wiperoutine(':',sequencenumber(it)-1)
  982. call nextpage()
  983. call prevpage()
  984. "wiperoutine"
  985.     "pagedim"
  986. old = PAGEDIM (page, new)
  987. et/set the screen dimming effect that precedes the wipe
  988. effect for the given page, and return the previous setting.
  989.  value of 0 turns dimming off; 1 turns it on. Other
  990. values (e.g. -1) do not change the current setting.
  991. Button1
  992. old = pagedim(':',-1)
  993. call pagedim(':',1 - old)
  994. call nextpage()
  995. call prevpage()
  996. call pagedim(':',old)
  997.     "pagedim"
  998. "setpagenumber"
  999. new = SETPAGENUMBER (page, num)
  1000. esequence the page whose position is 
  1001. , and return its new objnum.
  1002. Button1
  1003. /* Execute this button twice in order not to disturb the page order */
  1004. say 'This page is now' setpagenumber(':', 50 - sequencenumber(':'))
  1005. "setpagenumber"
  1006. "refreshpage"
  1007. REFRESHPAGE ()
  1008. Redraw the current page.
  1009. Button1
  1010. call refreshpage()
  1011. Group1
  1012. Drawing1
  1013. Drawing2
  1014. Drawing3
  1015. Drawing4
  1016. Drawing5
  1017. Drawing6
  1018. Drawing7
  1019. Drawing8
  1020. Drawing9
  1021.     Drawing10
  1022.     Drawing11
  1023.     Drawing12
  1024.     Drawing13
  1025.     Drawing14
  1026.     Drawing15
  1027.     Drawing16
  1028.     Drawing17
  1029.     Drawing18
  1030.     Drawing19
  1031.     Drawing20
  1032. "refreshpage"
  1033. "createnote"
  1034. note = CREATENOTE ()
  1035. reate an empty note of size 61x23 and position (0,0) in the bin, using
  1036. the current default note attributes, and return its objnum.
  1037. Button1
  1038. n = createnote()
  1039. call scaletosize(n, 135, 50)
  1040. call setposition(n, 412, 115)
  1041. call inserttext(n,'I am a newly-created note.',0)
  1042. call setbackground(n,5)
  1043. call relocate(n, ':')
  1044. "createnote"
  1045. "createbutton"
  1046. button = CREATEBUTTON ()
  1047. reate an empty button of size 33x17 and position (0,0) in the bin,
  1048. using the current default button attributes, and return its objnum.
  1049. Button1
  1050. b = createbutton()
  1051. call scaletosize(b, 145, 21)
  1052. call setposition(b, 247, 159)
  1053. call inserttext(b, 'I delete myself', 0)
  1054. call setactionrexx(b, 'call delete(initiator())')
  1055. call setbackground(b, 2)
  1056. b = relocate(b, ':')
  1057. "createbutton"
  1058. "createlist"
  1059. list = CREATELIST ()
  1060. reate an empty list of size 65x43 and position (0,0) in the bin,
  1061. using the current default list attributes, and return its objnum.
  1062. Button1
  1063. list = createlist()
  1064. call scaletosize(list,123,90)
  1065. call setposition(list,509,61)
  1066. fox = 'The quick brown fox jumps over the lazy dog'
  1067. do i = 1 to 9
  1068.    call appenditem(list, subword(fox,i,1), 1)
  1069. call relocate(list, ':')
  1070. "createlist"
  1071. "creategroup"
  1072. group = CREATEGROUP ()
  1073. reate an empty group object in the bin, and return its objnum.
  1074. "creategroup macro"
  1075. /* Create a group to contain both the note and the button
  1076. on this page, or explode such a group if it exists. */
  1077. call interactive(0)
  1078. if gettype(':1') = 'Group' then
  1079.    call explode(':1')
  1080. else do
  1081.    g = creategroup()
  1082.    call relocate(searchname(':',creategroup),g)
  1083.    call relocate(initiator(),g)
  1084.    call relocate(g, ':')
  1085.    end
  1086. call listcurrentpage()
  1087. "creategroup"
  1088. "clone"
  1089. new = CLONE (arg, newparent)
  1090. lone the given object to the bin, a page or a group; or the given item
  1091. to a new list. 
  1092.  is unchanged. Return the clone's objnum.
  1093. Button1
  1094. "clone button"
  1095. I call 
  1096. CloneObject
  1097. Note2
  1098. The button calls the 
  1099. CloneObject
  1100.  macro, which clones it to the group with
  1101. the black bar. List items clicked on are cloned to the other list using
  1102. CloneItem
  1103.  macro. Delete the clones by hand to restore the page.
  1104. Button3
  1105. "clone list 1"
  1106. alpha
  1107. gamma
  1108. delta
  1109. epsilon
  1110. "clone list 2"
  1111. ALPHA
  1112. GAMMA
  1113. DELTA
  1114. EPSILON
  1115. "clone group"
  1116. Drawing1
  1117. Group1
  1118. "reloc button"
  1119. group
  1120. Drawing2
  1121. "clone"
  1122.     "getleft"
  1123. left = GETLEFT (obj)
  1124. eturn the left edge position of the object, measured in
  1125. pixels from the left edge of its page.
  1126. Button1
  1127. say 'My left edge is' getleft(initiator())
  1128.     "getleft"
  1129. "gettop"
  1130. top = GETTOP (obj)
  1131. eturn the top edge position of the object, measured in
  1132. scan-lines from the top edge of its page.
  1133. Button1
  1134. say 'My top edge is' gettop(initiator())
  1135. "gettop"
  1136. "setposition"
  1137. SETPOSITION (obj, x, y)
  1138. et the left and top co-ordinates of the given object.
  1139. Button1
  1140. /* Randomly reposition this button:  
  1141. Move Me
  1142. i    = initiator()
  1143. b    = 'MoveMe'()
  1144. left = rand(0, getwidth(i)  - getwidth(b)  - 1)
  1145. top  = rand(0, getheight(i) - getheight(b) - 1)
  1146. call setposition(b, left + getleft(i), top + gettop(i))
  1147. "MoveMe"
  1148. $call setposition(initiator(),347,55)
  1149. Move Me
  1150. "setposition"
  1151. "getborder"
  1152. border = GETBORDER (obj)
  1153. eturn the border color of the object, or -1 if the
  1154. object's border is transparent.
  1155. Button1
  1156. say 'My border color is' getborder(initiator())
  1157. "getborder"
  1158. "setborder"
  1159. oldcolor = SETBORDER (obj, color)
  1160. et the border of the object to the given color, and
  1161. return the previous color. The transparent `color' is -1.
  1162. Group1
  1163. Button1
  1164. Button2
  1165. Button3
  1166. b = objectnumber(parent(initiator()),2)
  1167. call setborder(b, rand(-1,7))
  1168. "setborder"
  1169. "getshadow"
  1170. shadow = GETSHADOW (obj)
  1171. eturn the shadow color of the object, or -1 if the
  1172. object's shadow is transparent.
  1173. Button1
  1174. say 'My shadow color is' getshadow(initiator())
  1175. "getshadow"
  1176. "setshadow"
  1177. oldcolor = SETSHADOW (obj, color)
  1178. et the shadow of the object to the given color, and return the
  1179. previous color. The transparent `color' is -1.
  1180. Button1
  1181. call setshadow(initiator(),rand(-1,7))
  1182. "setshadow"
  1183. "shadowstyle"
  1184. old = SHADOWSTYLE (obj, style)
  1185. et/set the style of shadow used by 
  1186. . The available styles are
  1187. drop-shadow (
  1188. style
  1189.  = 1) and embossed (2). Any other value (e.g. 0)
  1190. doesn't change the current shadow style setting.
  1191. Button1
  1192. call interactive(0)
  1193. ss = shadowstyle(initiator(), 0)
  1194. if ss = 2 then
  1195.    b = 6  
  1196. /* orange */
  1197.    b = 1  
  1198. /* black  */
  1199. call shadowstyle(initiator(), 3-ss)
  1200. call setborder(initiator(), b)
  1201. "shadowstyle"
  1202. "getvisibility"
  1203. bool (1 or 0) = GETVISIBILITY (obj)
  1204. eturn 1 if the `natural visibility state' of
  1205. the object is visible, or 0 if it is invisible.
  1206. Button1
  1207. n = 'VisiButton'()
  1208. if getvisibility(n) then
  1209.    say 'Visible'
  1210.    say 'Invisible'
  1211. Group1
  1212. 9b='VisiButton'(); call setvisibility(b,~getvisibility(b))
  1213. "VB_Frame"
  1214.     "ClickMe"
  1215. Click Me
  1216. "VisiButton"
  1217. VisiButton
  1218. "getvisibility"
  1219. "setvisibility"
  1220. bool (1 or 0) = SETVISIBILITY (obj, state)
  1221. et the `natural visibility state' of the
  1222. object to visible (1), or invisible (0). Return
  1223. the previous state.
  1224. Button1
  1225. b = 'Cheshire face'()
  1226. call setvisibility(b, ~getvisibility(b))
  1227. Group1
  1228. Button1
  1229. Button2
  1230. Note1
  1231. "Cheshire face"
  1232. Note2
  1233. "setvisibility"
  1234. "scale"
  1235. SCALE (obj, percent)
  1236. cale the object's width and
  1237. height to the given percentage
  1238. of its current dimensions.
  1239. "GoodTime"
  1240. For a good
  1241. time call
  1242. favorite
  1243. restaurant
  1244. and make a
  1245. reservation.
  1246. Enjoy a
  1247. fine,
  1248. healthy meal
  1249. with a
  1250. friend or
  1251. family
  1252. member.
  1253. Button1
  1254. n = 'GoodTime'()
  1255. if getwidth(n) < 150 then
  1256.    call scale(n, 200)
  1257.    call scale(n, 50)
  1258. "scale"
  1259. "scaletosize"
  1260. SCALETOSIZE (obj, width, height)
  1261. Scale the object to the given width and height.
  1262. Button1
  1263. n = 'Planets'()
  1264. call interactive(0)
  1265. if getwidth(n) < 200 then do
  1266.    call setposition(n,20,170)
  1267.    call scaletosize(n,520,18)
  1268.    end
  1269. else do
  1270.    call setposition(n,438,68)
  1271.    call scaletosize(n,90,100)
  1272.    end
  1273.     "Planets"
  1274. Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto
  1275. "scaletosize"
  1276. "objecttoback"
  1277. objnum = OBJECTTOBACK (obj)
  1278. ring the given object to the
  1279. back of its group/page and
  1280. return its new objnum.
  1281. Button1
  1282. btn = objecttoback(initiator())
  1283. call inform('Continue...')
  1284. call objecttofront(btn)
  1285. "objecttoback"
  1286. "objecttofront"
  1287. objnum = OBJECTTOFRONT (obj)
  1288. ring the given object to the
  1289. front of its group/page and
  1290. return its new objnum.
  1291. Button1
  1292. n = searchname(':',objecttofront)
  1293. n = objecttofront(n)
  1294. call inform('Continue...')
  1295. call objecttoback(n)
  1296. "objecttofront"
  1297. "getgroupdepth"
  1298. depth = GETGROUPDEPTH (obj)
  1299. eturn the grouping depth of the given
  1300. object, starting with 0 if the object is
  1301. not in a group.
  1302. Button1
  1303. /* List the grouping depth of
  1304.    objects on this page
  1305. do i=1 to totalelements(':')
  1306. o = objectnumber(':',i)
  1307. d = getgroupdepth(o)
  1308. say 'Object' o || ', depth =' d
  1309. Group1
  1310. Note1
  1311. Drawing1
  1312. Group1
  1313. Drawing1
  1314. Group1
  1315. Drawing1
  1316. Group1
  1317. Drawing1
  1318. Drawing2
  1319. "getgroupdepth"
  1320.     "explode"
  1321. firstobj = EXPLODE (group)
  1322. xplode the given group, and insert its constituent
  1323. objects in the group's place in its parent list.
  1324. Return the objnum of the first of these objects
  1325. (or the empty string if the group had no objects).
  1326. Button1
  1327. /* Explode the group of rectangles at right.
  1328.    Re-group them afterwards to restore the page.
  1329. call explode('Rectangles'())
  1330. Group1
  1331. Note1
  1332.     "Regroup"
  1333.     "Regroup"
  1334.     "Regroup"
  1335. "Regroup_macro"
  1336. parent('Dra
  1337. wing1'())
  1338. currentpage
  1339. () then
  1340.    exit
  1341. interactive
  1342. g=creategro
  1343. relocate('D
  1344. rawing4'(),
  1345. relocate('D
  1346. rawing3'(),
  1347. relocate('D
  1348. rawing2'(),
  1349. relocate('D
  1350. rawing1'(),
  1351. setbackgrou
  1352. nd(g,7)
  1353. setborder(g
  1354. setshadow(g
  1355. shadowstyle
  1356. (g,2)
  1357. setposition
  1358. (g,497,53)
  1359. setname(g,'
  1360. Rectangles'
  1361. relocate(g,
  1362. Button1
  1363. .interpret readnotetext('Regroup_macro'(),0,-1)
  1364. Click here
  1365. to regroup
  1366. "Rectangles"
  1367. Drawing1
  1368. Drawing2
  1369. Drawing3
  1370. Drawing4
  1371.     "explode"
  1372. "getaction"
  1373. action = GETACTION (arg)
  1374. eturn the action type associated with the given object or
  1375. item, one of: 
  1376. noaction
  1377. gopage
  1378. showpic
  1379. showhide
  1380. displaytext
  1381. doscommand
  1382. rexxcommand
  1383. rexxmacro
  1384. Button1
  1385. I call FindAction
  1386. Note2
  1387. The main button calls the 
  1388. FindAction
  1389.  macro, which
  1390. invites you to click on an object then tells you its
  1391. action. The small buttons invoke various actions.
  1392. Group1
  1393. Note1
  1394. Button1
  1395. Button2
  1396. Button3
  1397.     hdat:odie
  1398. Button4
  1399. Button5
  1400.     hdat:text
  1401. Button6
  1402. say "Greetings from Hy-perBook"
  1403. Button7
  1404. 0call inform('Greetings from object' initiator())
  1405. Button8
  1406. "getaction"
  1407. "Informative note"
  1408. The main button calls the 
  1409. FindActionText
  1410.  macro, which
  1411. invites you to click on an object then tells you its
  1412. action text. The small buttons invoke various actions.
  1413. "getactiontext"
  1414. action = GETACTIONTEXT (arg)
  1415. eturn the text associated with the given object or item's action.
  1416. Group1
  1417. Note1
  1418. Button1
  1419. Button2
  1420. Button3
  1421.     hdat:odie
  1422. Button4
  1423. Button5
  1424.     hdat:text
  1425. Button6
  1426. say "Greetings from Hy-perBook"
  1427. Button7
  1428. 0call inform('Greetings from object' initiator())
  1429. Button8
  1430. Button1
  1431. I call FindActionText
  1432. "getactiontext"
  1433. "setactionnone"
  1434. oldact = SETACTIONNONE (arg)
  1435. et the action of the specified object or item to 
  1436. noaction
  1437. . Return the
  1438. type of the former action.
  1439. Button1
  1440. call setactionnone('Act3'())
  1441. Button2
  1442. call setactionrexx('Act3'(), getBGtext())
  1443. "Act3"
  1444. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1445. b=initiator(); call setbackground(b, 9-getbackground(b))
  1446. Note2
  1447. The name of the third button is `Act3'. The first button
  1448. clears Act3's action; the second restores it (to the HML
  1449. command string returned by the 
  1450. getBGtext
  1451.  macro).
  1452. "setactionnone"
  1453. "setactionpage"
  1454. oldact = SETACTIONPAGE (arg, parg)
  1455. et the action of the specified object or item to 
  1456. gopage
  1457. . The page's
  1458. objnum is 
  1459. . Return the type of the former action.
  1460. Button1
  1461. call setactionpage('Act3'(), ':')
  1462. "action restore"
  1463. call setactionrexx('Act3'(), getBGtext())
  1464. "Act3"
  1465. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1466. b=initiator(); call setbackground(b, 9-getbackground(b))
  1467. Note2
  1468. The name of the third button is `Act3'. The first button changes Act3's
  1469. action to 
  1470. gopage
  1471.  (linking it to 
  1472.  page); the second restores it (to
  1473. the HML command string returned by the 
  1474. getBGtext
  1475.  macro).
  1476. "setactionpage"
  1477. "setactionpic"
  1478. oldact = SETACTIONPIC (arg, name)
  1479. et the action of the specified object or item to 
  1480. showpic
  1481. . The picture
  1482. is the ILBM file 
  1483. . Return the type of the former action.
  1484. Button1
  1485. call setactionpic('Act3'(), 'hdat:odie')
  1486. "action restore"
  1487. call setactionrexx('Act3'(), getBGtext())
  1488. "Act3"
  1489. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1490. b=initiator(); call setbackground(b, 9-getbackground(b))
  1491. Note2
  1492. The name of the third button is `Act3'. The first button
  1493. changes Act3's action to 
  1494. showpic
  1495. ; the second restores it (to
  1496. the HML command string returned by the 
  1497. getBGtext
  1498.  macro).
  1499. "setactionpic"
  1500. "setactionshow"
  1501. oldact = SETACTIONSHOW (arg, oarg)
  1502. et the action of the specified object or item to 
  1503. showhide
  1504. . The objnum
  1505. of the target object is 
  1506. . Return the type of the former action.
  1507. Button1
  1508. call setactionshow('Act3'(), 'hidden object'())
  1509. "action restore"
  1510. call setactionrexx('Act3'(), getBGtext())
  1511. "Act3"
  1512. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1513. b=initiator(); call setbackground(b, 9-getbackground(b))
  1514. Note2
  1515. The name of the third button is `Act3'. The first button
  1516. changes Act3's action to 
  1517. showhide
  1518. ; the second restores it
  1519. (to the HML command string returned by the 
  1520. getBGtext
  1521.  macro).
  1522. "hidden object"
  1523. Drawing1
  1524. Note1
  1525. Hidden object
  1526. "setactionshow"
  1527. "setactionread"
  1528. oldact = SETACTIONREAD (arg, name)
  1529. et the action of the specified object or item to 
  1530. displaytext
  1531. . The text
  1532. is in the file 
  1533. . Return the type of the former action.
  1534. Button1
  1535. call setactionread('Act3'(), 'hdat:text')
  1536. "action restore"
  1537. call setactionrexx('Act3'(), getBGtext())
  1538. "Act3"
  1539. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1540. b=initiator(); call setbackground(b, 9-getbackground(b))
  1541. Note2
  1542. The name of the third button is `Act3'. The first button
  1543. changes Act3's action to 
  1544. displaytext
  1545. ; the second restores it
  1546. (to the HML command string returned by the 
  1547. getBGtext
  1548.  macro).
  1549. "hidden object"
  1550. Drawing1
  1551. Note1
  1552. Hidden object
  1553. "setactionread"
  1554. "setactiondos"
  1555. oldact = SETACTIONDOS (arg, cmd)
  1556. et the action of the specified object or item to 
  1557. doscommand
  1558. . The
  1559. command is the string 
  1560. . Return the type of the former action.
  1561. Button1
  1562. call setactiondos('Act3'(), 'dir >hdat:files')
  1563. "action restore"
  1564. call setactionrexx('Act3'(), 'call showtext("hdat:files")')
  1565. "Act3"
  1566. call showtext("hdat:files")
  1567. call showtext("hdat:files")
  1568. Note2
  1569. The name of the third button is `Act3'. The first button changes
  1570. Act3's action to 
  1571. doscommand
  1572.  (creating a current-directory listing).
  1573. The second restores it (to displaying the generated listing).
  1574. "hidden object"
  1575. Drawing1
  1576. Note1
  1577. Hidden object
  1578. "setactiondos"
  1579. "setactionrexx"
  1580. oldact = SETACTIONREXX (arg, dos)
  1581. et the action of the specified object or item to 
  1582. rexxcommand
  1583. . The
  1584. command is the string 
  1585. . Return the type of the former action.
  1586. Button1
  1587. call setactionrexx('Act3'(), 'call tinypanel()')
  1588. "action restore"
  1589. call setactionrexx('Act3'(), 'call bigpanel()')
  1590. "Act3"
  1591. call bigpanel()
  1592. call bigpanel()
  1593. Note2
  1594. The name of the third button is `Act3'. The first
  1595. button changes Act3's action to 
  1596. rexxcommand
  1597. tinypanel()
  1598. ). The second restores it (
  1599. call bigpanel()
  1600. "hidden object"
  1601. Drawing1
  1602. Note1
  1603. Hidden object
  1604. "setactionrexx"
  1605. "setactionmacro"
  1606. oldact = SETACTIONMACRO (arg, marg)
  1607. et the action of the specified object or item to 
  1608. rexxmacro
  1609. . The named
  1610. macro (
  1611. ) is used. Return the type of the former action.
  1612. Button1
  1613. call setactionmacro('Act3'(), 'FindActionText')
  1614. "action restore"
  1615. call setactionrexx('Act3'(), getBGtext())
  1616. "Act3"
  1617. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1618. b=initiator(); call setbackground(b, 9-getbackground(b))
  1619. Note2
  1620. The name of the third button is `Act3'. The first button
  1621. changes Act3's action to 
  1622. rexxmacro
  1623. ; the second restores it
  1624. (to the HML command string returned by the 
  1625. getBGtext
  1626.  macro).
  1627. "hidden object"
  1628. Drawing1
  1629. Note1
  1630. Hidden object
  1631. "setactionmacro"
  1632. "setactionlink"
  1633. oldact = SETACTIONLINK (arg, linktype)
  1634. et the action of the specified object or item to one of the special
  1635. variants of the 
  1636. gopage
  1637.  action: 
  1638. nextpage
  1639. prevpage
  1640. firstpage
  1641. lastpage
  1642. return
  1643. selectpage
  1644. . Return the type of the former action.
  1645. Note2
  1646. The name of the third button is `Act3'. The first button changes
  1647. Act3's action to 
  1648. gopage
  1649.  (the 
  1650. nextpage
  1651.  variant); the second restores
  1652. it (to the HML command string returned by the 
  1653. getBGtext
  1654.  macro).
  1655. "hidden object"
  1656. Drawing1
  1657. Note1
  1658. Hidden object
  1659. Button1
  1660. call setactionlink('Act3'(), 'nextpage')
  1661. "action restore"
  1662. call setactionrexx('Act3'(), getBGtext())
  1663. "Act3"
  1664. 8b=initiator(); call setbackground(b, 9-getbackground(b))
  1665. b=initiator(); call setbackground(b, 9-getbackground(b))
  1666. "setactionlink"
  1667. "activate"
  1668. ACTIVATE (object)
  1669. xecute the action for the given object or item as though it had
  1670. been clicked on.
  1671. "LeftButton"
  1672. call activate('RightButton'())
  1673. "RightButton"
  1674. say getname(initiator())
  1675. I say the name of the
  1676. initiating object
  1677. Note2
  1678. The left button above activates the right button,
  1679. whose 
  1680. rexxcommand
  1681.  action is: 
  1682. say getname(initiator())
  1683. "activate"
  1684. "readnotetext"
  1685. str = READNOTETEXT (arg, pos, amt)
  1686. eturn a string consisting of 
  1687.  characters beginning at 
  1688.  in the
  1689. given note or button. An 
  1690.  of -1 means `to the end of text'.
  1691. Button1
  1692. /* Synopsize promotional message below */
  1693. ob = 'Promo'()
  1694. say readnotetext(ob,79,4) readnotetext(ob,47,7)
  1695. Group1
  1696. "Promo"
  1697. Happy computing!
  1698. rom the good folks at Apple, the
  1699. machine to complement 
  1700.  skill!
  1701. Button2
  1702. Button3
  1703. "readnotetext"
  1704. "inserttext"
  1705. INSERTTEXT (arg, text, pos)
  1706. nsert 
  1707.  in the given note or
  1708. button. If 
  1709.  is -1, the text is appended.
  1710. Button1
  1711. n = 'Very tired'()
  1712. call inserttext(n, 'very, ', 5)
  1713. Group1
  1714. Button1
  1715. Button2
  1716. "Very tired"
  1717. 4call replacetext(initiator(),'I am very tired',0,-1)
  1718. I am very tired
  1719. "inserttext"
  1720. "replacetext"
  1721. oldtext = REPLACETEXT (arg, text, pos, amt)
  1722. he new text replaces 
  1723.  characters, beginning at 
  1724.  in the
  1725. given note or button. An 
  1726.  of -1 means `to the end of text'.
  1727. Button1
  1728. note  = 'proven'()
  1729. first = readnotetext(note, 32, 3)
  1730. f first = 'egg' then
  1731.    call replacetext(note,'chicken',32,3)
  1732.    call replacetext(note,'egg',32,7)
  1733. Group1
  1734. "proven"
  1735. It has now been proven that the egg came first.
  1736. Button1
  1737. Button2
  1738. "replacetext"
  1739. "cleartext"
  1740. CLEARTEXT (arg)
  1741. emove all the text from the given note or button.
  1742. Button1
  1743. note = 'cleartext note'()
  1744. if length(readnotetext(note,0,-1)) > 1 then
  1745.    call cleartext(note)
  1746.    call inserttext(note, 'Easy come, easy go.', 0)
  1747. Group1
  1748. "cleartext note"
  1749. Easy come, easy go.
  1750. Button1
  1751. Button2
  1752. "cleartext"
  1753. "deletetext"
  1754. oldtext = DELETETEXT (note, pos, amt)
  1755. elete 
  1756.  characters beginning at 
  1757.  in the
  1758. given note or button, and return the deleted
  1759. text. An 
  1760.  of -1 means `to the end of text'.
  1761. Button1
  1762. call interactive(0)
  1763. m = 'Marvin'()
  1764. n = 'Edgar'()
  1765. call inserttext(m, deletetext(n, 34, 4), 38)
  1766. call inserttext(n, deletetext(m, 42, 4), 34)
  1767. Group1
  1768. Note1
  1769. "Marvin"
  1770. Marvin was
  1771. famous for his
  1772. sensitive palate.
  1773. "Edgar"
  1774. But Edgar
  1775. always beat him
  1776. to the punch.
  1777. "deletetext"
  1778. "getitemcolor"
  1779. color = GETITEMCOLOR (item)
  1780. Return the color of the given item.
  1781. Note2
  1782. In the test list above, each item's action is the HML command:
  1783. say 'My color is' getitemcolor(initiator())
  1784. Group1
  1785. Button1
  1786. "getitemcolor list"
  1787. +say 'My color is' getitemcolor(initiator())
  1788. Click
  1789. +say 'My color is' getitemcolor(initiator())
  1790. +say 'My color is' getitemcolor(initiator())
  1791. +say 'My color is' getitemcolor(initiator())
  1792. these
  1793. +say 'My color is' getitemcolor(initiator())
  1794. items.
  1795. "getitemcolor"
  1796. "setitemcolor"
  1797. old = SETITEMCOLOR (item, color)
  1798. et the color of the given item, and return
  1799. its previous color.
  1800. Note2
  1801. In the test list above, each item's action is the HML command:
  1802. call setitemcolor(initiator(), rand(0,7))
  1803. Group1
  1804. Button1
  1805. "setitemcolor list"
  1806. (call setitemcolor(initiator(),rand(0,7))
  1807. Click
  1808. (call setitemcolor(initiator(),rand(0,7))
  1809. (call setitemcolor(initiator(),rand(0,7))
  1810. (call setitemcolor(initiator(),rand(0,7))
  1811. these
  1812. (call setitemcolor(initiator(),rand(0,7))
  1813. items.
  1814. "setitemcolor"
  1815. "getitemtext"
  1816. text = GETITEMTEXT (item)
  1817. eturn the text string associated with
  1818. the given item.
  1819. Button1
  1820. l = 'getitemtext list'()
  1821. say 'Words of 8 letters or more' '0a'X
  1822. do i = 1 to numelements(l)
  1823. t = getitemtext(objectnumber(l,i))
  1824. if length(t) >= 8 then say '  ' t
  1825.    end
  1826. Group1
  1827. Note1
  1828. "getitemtext list"
  1829. hydrogen
  1830. helium
  1831. lithium
  1832.     beryllium
  1833. boron
  1834. carbon
  1835. nitrogen
  1836. oxygen
  1837. fluorine
  1838. sodium
  1839.     magnesium
  1840. "getitemtext"
  1841. "setitemtext"
  1842. oldtext = SETITEMTEXT (item, text)
  1843. et the item text to text, and return
  1844. the former text.
  1845. Note2
  1846. In the test list above, each item's action is the HML command:
  1847. =initiator(); t=getitemtext(i); if left(t,1)==' ' then
  1848.    setitemtext(i,substr(t,2)) rand(0,7))
  1849. Group1
  1850. Button1
  1851. "replaceitem list"
  1852. Wi=initiator(); t=getitemtext(i); if left(t,1)==' ' then call setitemtext(i,substr(t,2))
  1853.       Click
  1854. Wi=initiator(); t=getitemtext(i); if left(t,1)==' ' then call setitemtext(i,substr(t,2))
  1855.           any
  1856. Wi=initiator(); t=getitemtext(i); if left(t,1)==' ' then call setitemtext(i,substr(t,2))
  1857.       of
  1858. Wi=initiator(); t=getitemtext(i); if left(t,1)==' ' then call setitemtext(i,substr(t,2))
  1859.       these
  1860. Wi=initiator(); t=getitemtext(i); if left(t,1)==' ' then call setitemtext(i,substr(t,2))
  1861.       items.
  1862. "setitemtext"
  1863. "insertitem"
  1864. item = INSERTITEM (next, text, color)
  1865. reate a new item with the given color and text,
  1866. inserted before item 
  1867.  in its list, and return
  1868. the objnum of the new item.
  1869. Button1
  1870. /* Insert names between 'John' and 'Schmidt' */
  1871. i = 'insertitem list'()
  1872. n  = numelements(li)
  1873. i  = objectnumber(li,rand(2,n))
  1874. tx = inputstring('Enter name','Jacob')
  1875. call insertitem(i,tx,1)
  1876. Group1
  1877. Button1
  1878. "insertitem list"
  1879. Schmidt
  1880. "insertitem"
  1881. "appenditem"
  1882. item = APPENDITEM (list, text, color)
  1883. Create a new item with the given color and text,
  1884. append it to the given list, and return its objnum.
  1885. Button1
  1886. li = 'appenditem list'()
  1887. call appenditem(li,'Item' numelements(li)+1,2)
  1888. Group1
  1889. Button1
  1890. "appenditem list"
  1891. "appenditem"
  1892. "moveitem"
  1893. item = MOVEITEM (olditem, pos)
  1894. Move t
  1895. he given item within its
  1896. list to position 
  1897. , and return
  1898. its new objnum.
  1899. Group1
  1900. Note1
  1901. "moveitem list"
  1902. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1903. hydrogen
  1904. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1905. helium
  1906. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1907. lithium
  1908. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1909.     beryllium
  1910. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1911. boron
  1912. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1913. carbon
  1914. =i=initiator();call moveitem(i,rand(1,numelements(parent(i))))
  1915. nitrogen
  1916. "moveitem"
  1917. "clearlist"
  1918. CLEARLIST (list)
  1919. mpty the given list of all items.
  1920. Button1
  1921. list = 'clearlist list'()
  1922. list = clone(list, ':')
  1923. call clearlist(list)
  1924. call inform('Animals list clone now empty...')
  1925. call delete(list)
  1926. Group1
  1927. Note1
  1928. "clearlist list"
  1929. monkey
  1930. narwhal
  1931. tiger
  1932. okapi
  1933. rhinoceros
  1934. zebra
  1935. penguin
  1936. gibbon
  1937. walrus
  1938. dugong
  1939. Note2
  1940. The macro in the button clones the list of animals, then clears
  1941. the list. Upon confirming a requester, the clone is deleted.
  1942. "clearlist"
  1943. "sortlist"
  1944. SORTLIST (list1 [,list2, ..., listn])
  1945. Sort t
  1946. he items in the given list in ascending lexical order. If more than
  1947. one list is given, the first is sorted, and the others are re-ordered in
  1948. the same way as 
  1949. list1
  1950. . All the lists must
  1951. have the same number of items.
  1952. Button1
  1953. /* sort elements alphabetically */
  1954. call sortlist('elements'(),'atomnums'())
  1955. Button2
  1956. /* sort elements by atomic number */
  1957. call sortlist('atomnums'(),'elements'())
  1958. "Elements"
  1959. hydrogen  (AN1)
  1960. helium    (AN2)
  1961. lithium   (AN3)
  1962. beryllium (AN4)
  1963. boron     (AN5)
  1964. carbon    (AN6)
  1965. nitrogen  (AN7)
  1966. oxygen    (AN8)
  1967. fluorine  (AN9)
  1968. neon      (AN10)
  1969. sodium    (AN11)
  1970. "AtomNums"
  1971. "sortlist"
  1972. "refreshlist"
  1973. REFRESHLIST (list)
  1974. edraw the given list. Use this to force a
  1975. refresh while the INTERACTIVE flag is turned off
  1976. (which normally suppresses list rendering).
  1977. Button1
  1978. list = 'refreshee'()
  1979. all interactive(0)
  1980. o i=1 to numelements(list)
  1981.    call setitemcolor(objectnumber(list,i),2)
  1982.    end
  1983. call refreshlist(list)
  1984. o i=1 to numelements(list)
  1985.    call setitemcolor(objectnumber(list,i),1)
  1986.    end
  1987. Group1
  1988. Note1
  1989. "refreshee"
  1990. hydrogen
  1991. helium
  1992. lithium
  1993.     beryllium
  1994. boron
  1995. carbon
  1996. nitrogen
  1997. oxygen
  1998. fluorine
  1999. sodium
  2000.     magnesium
  2001. "refreshlist"
  2002. "listscroll"
  2003. LISTSCROLL (item)
  2004. croll the given item's list so that the
  2005. item is at the top, or as near as possible
  2006. to the top, of the list's display area.
  2007. Button1
  2008. li = 'listscroll list'()
  2009. n  = numelements(li) - 4
  2010. it = objectnumber(li, rand(1,n))
  2011. call listscroll(it)
  2012. Group1
  2013. Note1
  2014. "listscroll list"
  2015.  1 hydrogen
  2016.      2 helium
  2017.  3 lithium
  2018.  4 beryllium
  2019.  5 boron
  2020.      6 carbon
  2021.  7 nitrogen
  2022.      8 oxygen
  2023.  9 fluorine
  2024. 10 neon
  2025.     11 sodium
  2026. 12 magnesium
  2027. "listscroll"
  2028. "listheight"
  2029. count = LISTHEIGHT (list)
  2030. eturn the number of items the given list can
  2031. display at its current size. The list does not
  2032. necessarily contain this many items.
  2033. Button1
  2034. bl = 'black list'()
  2035. rl = 'blue list'()
  2036. bc = listheight(bl)
  2037. rc = listheight(rl)
  2038. say 'The black list can show' bc 'items.'
  2039. say 'The blue list can show' rc 'items.'
  2040. Group1
  2041. Note1
  2042. "Black list"
  2043. three
  2044. "Blue list"
  2045. three
  2046. seven
  2047. eight
  2048. "listheight"
  2049. "searchstart"
  2050. SEARCHSTART (start)
  2051. et the default starting point for SEARCHNAME, SEARCHPAGENAME and
  2052. SEARCHTEXT. If 
  2053. start
  2054.  is an objnum, set the starting point to the
  2055. corresponding page and object (if the objnum is that of a page or the
  2056. bin, the object is taken to be the first in the relevant object list).
  2057. An empty 
  2058. start
  2059.  string is equivalent to specifying '1:' - the first page.
  2060. Button1
  2061. call searchstart(':')
  2062. say 'From this page, found' getname(searchtext('','search'))
  2063. Button2
  2064. call searchstart('')
  2065. say 'From start, found' getname(searchtext('','search'))
  2066. "searchstart"
  2067. "searchname"
  2068. obj = SEARCHNAME (start, substr)
  2069. rom the given starting point in the hyperbook, search for an
  2070. object whose name contains 
  2071. substr
  2072. , and return its objnum (the
  2073. empty string if not found). If the 
  2074. start
  2075.  argument is empty,
  2076. the search begins where the most recent search left off, or
  2077. at the point set by SEARCHSTART. The search is case insensitive.
  2078. Button1
  2079. ob = searchname(':','butt')
  2080. f length(ob) > 0 then
  2081.    say 'Found' getname(ob)
  2082. "searchname"
  2083. "searchpagename"
  2084. obj = SEARCHPAGENAME (start, substr)
  2085. rom the given starting point in the hyperbook, search for a page
  2086. whose name contains 
  2087. substr
  2088. , and return its objnum (the empty string
  2089. if not found). If the 
  2090. start
  2091.  argument is the empty string, the search
  2092. begins where the most recent search left off, or at the point set by
  2093. SEARCHSTART. The search is case insensitive.
  2094. Button1
  2095. p=searchpagename('1:','search')
  2096. f length(p) > 0 then
  2097.    say 'Found' getname(p)
  2098. "searchpagename"
  2099. "searchtext"
  2100. obj = SEARCHTEXT (start, substr)
  2101. rom the given starting point in the hyperbook, search for an object
  2102. or list whose text contains 
  2103. substr
  2104. , and return its objnum (the empty
  2105. string if not found). If 
  2106. start
  2107.  is the empty string, the search begins
  2108. where the most recent search left off, or as set by SEARCHSTART. The
  2109. search is case insensitive.
  2110. "Left searchtext button"
  2111. /* Find the first note or
  2112. list whose text contains
  2113. the word `begin'. */
  2114. ob=searchtext('1:','begin')
  2115. f length(ob)>0 then
  2116. say 'Found' getname(ob)
  2117. "Right searchtext button"
  2118. /* Search for another */
  2119. ob=searchtext('','begin')
  2120. f length(ob)>0 then 
  2121. say 'Found' getname(ob)
  2122. say 'Not found'
  2123. "searchtext"
  2124. "searchitems"
  2125. item = SEARCHITEMS (arg, text)
  2126. earch a list (from the beginning, if 
  2127.  is a
  2128. list; or from the given item) for 
  2129. , and
  2130. return either the objnum of the item containing
  2131. the text or, if the search failed, the empty
  2132. string. The search is case insensitive.
  2133. Button1
  2134. list = 'searchitems list'()
  2135. item = searchitems(list, 'turkey')
  2136. item = searchitems(item, 'chicken')
  2137. say 'Found chicken in' getitemtext(item)
  2138. Group1
  2139. Note1
  2140. "searchitems list"
  2141. chicken soup
  2142. turkey sandwich
  2143. chicken pie
  2144. duck 
  2145.  l'orange
  2146. chicken feet
  2147. "searchitems"
  2148. "searchnote"
  2149. pos = SEARCHNOTE (arg, pattern, start)
  2150. earch the given note or button, 
  2151. , starting at
  2152. position 
  2153. start
  2154. , for the string 
  2155. pattern
  2156. , and return
  2157. the position at which it is found, or -1 if the
  2158. search fails. The search is case insensitive.
  2159. Button1
  2160. note = 'Quick Brown Fox'()
  2161. c  = substr(xrange('a','z'),rand(1,26),1)
  2162. p  = searchnote(note, c, 0)
  2163. say "Found letter `" || c || "' at position" p
  2164. Group1
  2165. "Quick Brown Fox"
  2166. The quick brown
  2167. fox jumps over
  2168. the lazy dog.
  2169. Button1
  2170. Button2
  2171. "searchnote"
  2172. "getresponse"
  2173. bool (1 or 0) = GETRESPONSE (prompt)
  2174. ut up the Okay/Cancel requester with the
  2175. given prompt string. Return 1 if the user
  2176. clicks Okay (the checkmark), 0 for Cancel
  2177. (the X).
  2178. Button1
  2179. if getresponse('Okay or cancel?') then
  2180.    say 'Okay'
  2181.    say 'Cancel'
  2182. "getresponse"
  2183. "inputstring"
  2184. str = INPUTSTRING (prompt, default)
  2185. rompt the user to enter a string (modifying the given text, if 
  2186. default
  2187. is non-empty) and return it. Note: the empty string is returned if the
  2188. user cancels the requester.
  2189. Button1
  2190. say 'You entered "' || inputstring('Enter a string', 'Default') || '"'
  2191. "inputstring"
  2192. "inputform"
  2193. text = INPUTFORM (prompt, formtext)
  2194. btain multiple lines of input from the user. 
  2195. Formtext
  2196.  specifies the
  2197. label and the default string for each input line in this format:
  2198.    <label>:<text>[<LF><label>:<text> ...]
  2199. where LF is a linefeed (in ARexx, a linefeed is 
  2200. '0a'X
  2201. ). The returned
  2202. text consists of the input strings separated by LFs.
  2203. Button1
  2204. cr = '0a'X
  2205. fm = 'Animal:' || cr || 'Origin:Africa' || cr || 'Class:mammal'
  2206. tx = inputform('Enter information for animal', fm)
  2207. if tx = '' then EXIT
  2208. parse var tx animal '0a'X origin '0a'X class
  2209. say 'The' animal 'is a' class 'from' origin || '.'
  2210. "inputform"
  2211. "inputobject"
  2212. obj = INPUTOBJECT (prompt)
  2213. Prompt the user
  2214.  to select an object from a list of
  2215. those on the current page. Return the objnum of
  2216. the selected object.
  2217. "inputobject demo"
  2218. ob = inputobject('Select an object')
  2219. say 'You selected' ob '(' || getname(ob) || ')'
  2220. "Framed boxes"
  2221. "Frame"
  2222. "Five boxes"
  2223.     "Red box"
  2224. "Four boxes"
  2225. "Orange box"
  2226. "Three boxes"
  2227. "White box"
  2228. "Two boxes"
  2229. "Yellow box"
  2230. "Black box"
  2231. "inputobject"
  2232. "inputpage"
  2233. page = INPUTPAGE (prompt)
  2234. Prompt t
  2235. he user to select a page from the page
  2236. list. Return the objnum of the selected page.
  2237. Button1
  2238. p = inputpage('Pick a page')
  2239. say 'Page chosen:' p '(' || getname(p) || ')'
  2240. "inputpage"
  2241. Note1
  2242. "selectitem"
  2243. item = SELECTITEM (list, prompt)
  2244. isplay the given prompt to the user, and wait for
  2245. a click on an item in the given list. Return the
  2246. objnum of the selected item.
  2247. Button1
  2248. li = 'selectitem list'()
  2249. it = selectitem(li, 'Click on a list item')
  2250. say 'You selected "' || getitemtext(it) || '"'
  2251. "selectitem list"
  2252. hydrogen
  2253. helium
  2254. lithium
  2255.     beryllium
  2256. boron
  2257. carbon
  2258. nitrogen
  2259. oxygen
  2260. fluorine
  2261. sodium
  2262.     magnesium
  2263. "selectitem"
  2264. "getclickrow"
  2265. row = GETCLICKROW (prompt)
  2266. Display the given prompt in a bar at the top the screen. When the user
  2267. clicks on the page, return the number of the scan-line clicked on.
  2268. Button1
  2269. say 'You clicked on line' getclickrow('Click somewhere on the page')
  2270. "getclickrow"
  2271. "getcolumn"
  2272. col = GETCOLUMN ()
  2273. eturn the column that was clicked on the
  2274. last time GETCLICKROW was called.
  2275. Button1
  2276. y = getclickrow('Click somewhere')
  2277. say 'Click x =' getcolumn() 'y =' y
  2278. "getcolumn"
  2279. "getobjectat"
  2280. obj = GETOBJECTAT (x, y)
  2281. eturn the objnum of the object at page
  2282. co-ordinates (x,y). A null objnum (the empty
  2283. string) is returned if there is no object at the
  2284. given co-ordinates.
  2285. Button1
  2286. y = getclickrow('Click on an object')
  2287. x = getcolumn()
  2288. say 'objnum is "' || getobjectat(x,y) || '"'
  2289. Group1
  2290. Note1
  2291. Group1
  2292. Drawing1
  2293. Group1
  2294. Drawing1
  2295. Group1
  2296. Drawing1
  2297. Group1
  2298. Drawing1
  2299. Drawing2
  2300. "getobjectat"
  2301. "beginprompt"
  2302. BEGINPROMPT (text)
  2303. pen the prompt window along the top of the
  2304. screen, containing the given text. If not closed with
  2305. ENDPROMPT, the window will close automatically when
  2306. the script finishes executing.
  2307. "beginprompt script"
  2308. call beginprompt('This is a prompt window')
  2309. call inform('Continue...')
  2310. "beginprompt"
  2311. "endprompt"
  2312. ENDPROMPT ()
  2313. lose the prompt window (opened with BEGINPROMPT).
  2314. "endprompt script"
  2315. call beginprompt('This is a prompt window')
  2316. call inform('Ready to close prompt window?')
  2317. call endprompt()
  2318. call inform('Prompt window now closed')
  2319. "endprompt"
  2320. "filerequest"
  2321. file = FILEREQUEST (prompt, default)
  2322. pen a file requester with the given prompt and default
  2323. AmigaDOS path name, and return the path name selected by
  2324. the user. Return the empty string if the user cancels.
  2325. Button1
  2326. name = filerequest('Select a file', 'c:echo')
  2327. say 'You selected "' || name || '"'
  2328. "filerequest"
  2329. "loadtext"
  2330. text = LOADTEXT (filename)
  2331. eturn a string whose value is the
  2332. entire contents of the given file.
  2333. Button1
  2334. say loadtext('s:startup-sequence')
  2335. "loadtext"
  2336. "savetext"
  2337. SAVETEXT (file, text)
  2338. reate a file whose contents is the given text.
  2339. Button1
  2340. text = readnotetext(initiator(),0,-1)
  2341. call savetext('ram:test_file', text)
  2342. say loadtext('ram:test_file')
  2343. address command 'delete ram:test_file'
  2344. "savetext"
  2345. "savemoretext"
  2346. SAVEMORETEXT (file, text)
  2347. ppend the given text to an existing file.
  2348. Button1
  2349. text = 'This file grows and grows.' || '0a'X
  2350. call savemoretext('ram:test_file', text)
  2351. say loadtext('ram:test_file')
  2352. "savemoretext"
  2353. "edittext"
  2354. newtext = EDITTEXT (name, text)
  2355. Make t
  2356. he text available for editing in the built-in text editor, displaying
  2357. the given name in the editor's title bar. Return the edited text.
  2358. Button1
  2359. note = 'edittext note'()
  2360. call inserttext(note,edittext('Edit Text',deletetext(note,0,-1)),0)
  2361. "edittext note"
  2362. (Your thoughts go here.)
  2363. "edittext"
  2364. "getprintwidth"
  2365. width = GETPRINTWIDTH ()
  2366. eturn the printer line width as set in Preferences,
  2367. calculated as: right margin - left margin + 1.
  2368. Button1
  2369. say 'Print-line width:' getprintwidth()
  2370. "getprintwidth"
  2371. "formattext"
  2372. newtext = FORMATTEXT (text, margin, width)
  2373. reate and return a new string in which the given string
  2374. has been word-wrapped to lines of 
  2375. width
  2376.  characters, with
  2377. margin
  2378.  extra spaces added to the beginning of each line
  2379. (these are not counted as part of 
  2380. width
  2381. Button1
  2382. note = searchname(':', 'formattext')
  2383. say formattext(readnotetext(note,0,-1),10,43)
  2384. "formattext"
  2385. "printpage"
  2386. bool (1 or 0) = PRINTPAGE ()
  2387. rint the current page... this is just like
  2388. selecting 
  2389. Print Page
  2390.  on the 
  2391. Project
  2392.  menu. Return
  2393. 1 if the print succeeded, otherwise 0.
  2394. Button1
  2395. /* Print this page... takes 30 seconds to
  2396.    come back if printer is not connected.
  2397. call printpage()
  2398. "printpage"
  2399.     "showpic"
  2400. bool = SHOWPIC (file)
  2401. isplay the given ILBM file. Return FALSE (0)
  2402. if the file does not exist.
  2403. Button1
  2404. if showpic('hdat:odie') = 0 then
  2405.    say "Can't find file"
  2406.     "showpic"
  2407. "showtext"
  2408. bool = SHOWTEXT (file)
  2409. isplay the given text file. Return FALSE (0)
  2410. if the file does not exist.
  2411. Button1
  2412. if showtext('hdat:text') = 0 then
  2413.    say "Can't find file"
  2414. "showtext"
  2415. "showtextrange"
  2416. bool (1 or 0) = SHOWTEXTRANGE (file, start, amt)
  2417. isplay a text range from the given file, beginning
  2418. start
  2419.  bytes into the file and continuing for 
  2420. bytes. (The equivalent line number values for 
  2421. start
  2422.  can be converted to byte values with the
  2423. `textrange' utility.)
  2424. Button1
  2425. if showtextrange('hdat:text',541,664) = 0 then
  2426.    say "Can't find file"
  2427. "showtextrange"
  2428. "numelements"
  2429. num = NUMELEMENTS (arg)
  2430. eturn the number of elements in a page, the bin, a
  2431. group or a list. A group is counted as one element,
  2432. regardless of how many objects it contains.
  2433. "Group of 4"
  2434. Note1
  2435. This group contains four elements.
  2436. Button1
  2437. 'say 'Objects on page:' numelements(':')
  2438. numelements (page)
  2439. Button2
  2440. .say 'Group count:' numelements('Group of 4'())
  2441. numelements (group)
  2442. Button3
  2443. ,say 'List count:' numelements('List of 5'())
  2444. numelements (list)
  2445. Group2
  2446. Note1
  2447. "List of 5"
  2448.     elements.
  2449. Note2
  2450. Button macros
  2451. Left button  :
  2452.  say 'Objects on page:' numelements(':')
  2453. Middle button
  2454. : say 'Group count:' numelements('Group of 4'())
  2455. Right button :
  2456.  say 'List count:' numelements('List of 5'())
  2457. "numelements"
  2458. "sequencenumber"
  2459. num = SEQUENCENUMBER (arg)
  2460. eturn the list position of a page, object or
  2461. item, counting from 1. For objects within a
  2462. group, the position returned is relative to
  2463. the group, not the containing page.
  2464. Button1
  2465. say 'Page' sequencenumber(':')
  2466. Button2
  2467. say 'Object' sequencenumber(initiator())
  2468. "sequencenumber"
  2469. "totalelements"
  2470. num = TOTALELEMENTS (arg)
  2471. eturn the number of elements contained in a page, the bin, a list
  2472. object or a group at all levels (i.e. including nested groups). This is
  2473. equivalent to NUMELEMENTS only for lists.
  2474. Note2
  2475. Button macros
  2476. Left button  :
  2477.  say 'Total objects on page:' totalelements(':')
  2478. Middle button
  2479. : say 'Group 1 count:' totalelements('Group of 5'())
  2480. Right button :
  2481.  say 'Group 2 count:' totalelements('Group of 6'())
  2482. "Group of 5"
  2483. Note1
  2484. (Group 1,
  2485. 5 elements,
  2486. one of
  2487. which is
  2488. Group 2)
  2489. "Group of 6"
  2490. Note1
  2491. (Group 2, 6 elements)
  2492. Drawing1
  2493. Drawing2
  2494. Drawing3
  2495. Drawing4
  2496. Drawing5
  2497. Button1
  2498. /say 'Total objects on page:' totalelements(':')
  2499. totalelements
  2500. (page)
  2501. Button2
  2502. 2say 'Group 1 count:' totalelements('Group of 5'())
  2503. totalelements
  2504. (group 1)
  2505. Button3
  2506. 2say 'Group 2 count:' totalelements('Group of 6'())
  2507. totalelements
  2508. (group 2)
  2509. "totalelements"
  2510.     "gettype"
  2511. type = GETTYPE (arg)
  2512. eturn one of these strings: 
  2513. Drawing
  2514. Picture
  2515. Button
  2516. Group
  2517. , depending on the type of the argument.
  2518. Button1
  2519. /* Get a screen position, announce the type of object there. */
  2520. bj = GetObject('Click on object/page to find its type...')
  2521. f length(obj) = 0
  2522.    then obj = ':'
  2523. ay 'Type is:' gettype(obj)
  2524. Group1
  2525. Note1
  2526. Picture1
  2527. hdat:
  2528. Note2
  2529. Button1
  2530. Button
  2531. Drawing1
  2532. List1
  2533.     "gettype"
  2534.     "getpage"
  2535. pg = GETPAGE (arg)
  2536. eturn the objnum of the page to which 
  2537.  pertains.
  2538. Button1
  2539. say 'My page is:' getpage(initiator())
  2540.     "getpage"
  2541.     "getnext"
  2542. next = GETNEXT (arg)
  2543.  is a page or an item, the returned value 
  2544.  is the objnum of
  2545. the next page or item. If 
  2546.  is an object, 
  2547.  is the objnum of the
  2548. next object in a depth-first search of the page, or the first object on
  2549. the next page if there are no more objects on the current page. An
  2550. empty objnum is returned if the end of the list in 
  2551. 's category has
  2552. been reached.
  2553. Button1
  2554. /* list all objects on page 50 */
  2555. ob = '50:1'
  2556. o while getpage(ob) = '50:'
  2557.    say ob '-' getname(ob)
  2558.    ob = getnext(ob)
  2559.    end
  2560.     "getnext"
  2561.     "getnext"
  2562. next = GETNEXTSIB (arg)
  2563.  is a page or an item, the returned value 
  2564.  is the objnum of
  2565. the next page or item. If 
  2566.  is an object, 
  2567.  is the objnum of the
  2568. next object at the same level as the given one (i.e. without descending
  2569.  is a group), or the empty string if there are no more objects
  2570. 's list.
  2571. Button1
  2572. /* list level 1 objects on page 50
  2573. ob = objectnumber('50:',1)
  2574. o while ob ~= ''
  2575.    say ob '-' getname(ob)
  2576.    ob = getnextsib(ob)
  2577.    end
  2578. "getnextsib"
  2579. "objectnumber"
  2580. obj = OBJECTNUMBER (arg, num)
  2581. eturn the objnum of the object/item whose sequence number on the
  2582. given (page or group)/list is 
  2583. . The empty string is returned if the
  2584. sequence number is invalid. If 
  2585.  is the empty string, return the
  2586. objnum of page 
  2587. "Script"
  2588. /* Say objnums/names of objects on page */
  2589. n=totalelements(':')
  2590. o i=1 to n
  2591. o=objectnumber(':',i)
  2592. say 'Object' o || ', name =' getname(o)
  2593. "Framed boxes"
  2594. "Frame"
  2595. "Five boxes"
  2596.     "Red box"
  2597. "Four boxes"
  2598. "Blue box"
  2599. "Three boxes"
  2600. "Purple box"
  2601. "Two boxes"
  2602. "Green box"
  2603. "Black box"
  2604. "objectnumber"
  2605. "parent"
  2606. parent = PARENT (arg)
  2607. eturn the objnum of the page, bin, group or list one
  2608. level up from the given object or item.
  2609. Button1
  2610. say 'My parent is' parent(initiator())
  2611. "parent"
  2612. "currentpage"
  2613. page = CURRENTPAGE ()
  2614. eturn the objnum of the current page
  2615. Button1
  2616. say 'Current page =' currentpage()
  2617. "currentpage"
  2618. "initiator"
  2619. obj = INITIATOR ()
  2620. eturn the objnum of the object or item that launched
  2621. the current macro or ARexx command. Return the
  2622. empty string if the macro or command was not
  2623. launched by an object or item (e.g. from a menu).
  2624. Button1
  2625. say 'My objnum is "' || initiator() || '"'
  2626. "initiator"
  2627.     "ismacro"
  2628. bool (1 or 0) = ISMACRO (name)
  2629. eturn 1 if the given name is that of a macro in the
  2630. current hyperbook, and 0 otherwise. (A zero result does
  2631. not preclude the possibility that the macro may be
  2632. available to be executed from disk.)
  2633. Button1
  2634. m = ismacro('FindAction')
  2635. n = ismacro('MindAction')
  2636. not.0 = 'not a'
  2637. not.1 = 'a'
  2638. say "`FindAction' is" not.m "macro."
  2639. say "`MindAction' is" not.n "macro."
  2640.     "ismacro"
  2641. "movemacro"
  2642. MOVEMACRO (macroname, newpos)
  2643. ove the named macro to position 
  2644. newpos
  2645. the macro list, which is displayed by several
  2646. selections in the 
  2647. ARexx
  2648.  menu. If the given
  2649. position is less than or equal to zero, the
  2650. macro is moved to the end of the list.
  2651. Button1
  2652. /* Examine Macro list after... */
  2653. call movemacro('ExecuteText', 1)
  2654. Button2
  2655. /* ... and again after... */
  2656. call movemacro('ExecuteText', 14)
  2657. "movemacro"
  2658. "interactive"
  2659. oldstate = INTERACTIVE (bool)
  2660. et (1) or clear (0) interactive mode, and return its
  2661. previous state. In interactive mode, objects are updated
  2662. on-screen after each operation. Otherwise, objects are
  2663. updated only: when REFRESHLIST or REFRESHPAGE is used;
  2664. on re-entering interactive mode explicitly (with the
  2665. present function); on exiting a command or macro to
  2666. interactive operation. Commands and macros always
  2667. start in interactive mode.
  2668. Note2
  2669. The macro 
  2670. INTERACTIVE demo
  2671.  colors the top half of the list at right with
  2672. interactive mode on, and the bottom half with interactive mode off.
  2673. Button1
  2674. I call "INTERACTIVE demo"
  2675. Group1
  2676. Note1
  2677. "interactive list"
  2678. hydrogen
  2679. helium
  2680. lithium
  2681.     beryllium
  2682. boron
  2683. carbon
  2684. nitrogen
  2685. oxygen
  2686. fluorine
  2687. sodium
  2688.     magnesium
  2689. "interactive"
  2690. "pause"
  2691. PAUSE (tenths)
  2692. ause program execution for the given number of
  2693. tenths of seconds.
  2694. "Pause demo"
  2695. call beginprompt("Pausing for 1 1/2 seconds...")
  2696. call pause(15)
  2697. "pause"
  2698. "inform"
  2699. INFORM (string)
  2700. isplay the given string, and wait for the user to click Okay.
  2701. Button1
  2702. call inform(' This is an informative message. ')
  2703. "inform"
  2704. "rand"
  2705. value = RAND (low, high)
  2706. eturn a pseudo-random integer between 
  2707.  and 
  2708. , inclusive. Unlike
  2709. ARexx's RANDOM function, RAND does not need to be reseeded for each
  2710. script.
  2711. "Rand demo"
  2712. call beginprompt('Generating random numbers...')
  2713. tx = '0a'X
  2714. o i = 1 to 10
  2715.    do j = 1 to 10
  2716.       tx = tx right(rand(1,1000),4)
  2717.       end
  2718.   tx = tx || '0a'X
  2719.    end
  2720. all inform(tx)
  2721. "rand"
  2722. diamond.font
  2723. diamond.font
  2724.