Changes between Version 3 and Version 4 of Documentation/ARexxAPI/APPBUSY


Ignore:
Timestamp:
Feb 4, 2014, 5:01:00 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/APPBUSY

    v3 v4  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    42== APPBUSY
    53
    6 '''NAME'''
     4 NAME::
    75     AppBusy -- Switch YAM into busy state.  (V2.0)
    86
    9 '''TEMPLATE'''
     7 TEMPLATE::
    108     TEXT
    119
    12 '''FUNCTION'''
     10 FUNCTION::
    1311     Switches YAM into busy state and optionally displays a short text
    1412     in the status bar.  During this state, YAM won't accept any input.
    1513
    16 '''INPUTS'''
    17      TEXT   - optional, a brief piece of text to display in the status bar while YAM is in busy state; the maximum length of the displayable text depends on the width of the characters used
     14 INPUTS::
     15     `TEXT`   - optional, a brief piece of text to display in the status bar while YAM is in busy state; the maximum length of the displayable text depends on the width of the characters used
    1816
    19 '''RETURNS'''
    20      RC is set to 1 if YAM was already busy.
     17 RETURNS::
     18     `RC` is set to 1 if YAM was already busy.
    2119
    22 '''NOTES'''
     20 NOTES::
    2321     V2.4 introduced the concept of busy levels, meaning the command
    2422     is now accumulative: if AppBusy is called several times, an equal
     
    2624     return to normal state.
    2725
    28 '''EXAMPLE'''
    29          /* Turn busy mode on */
     26 EXAMPLE::
     27     {{{#!urbiscript
     28     /* Turn busy mode on */
     29     'APPBUSY "Please wait..."'
    3030
    31          'APPBUSY "Please wait..."'
     31     /* Say we are doing something different */
     32     'APPBUSY "Making coffee..."'
    3233
    33          /* Say we are doing something different */
     34     /* Turn all busy modes off */
     35     APPNOBUSY
     36     APPNOBUSY
     37     }}}
    3438
    35          'APPBUSY "Making coffee..."'
     39 BUGS::
    3640
    37          /* Turn busy mode off */
    38 
    39          APPNOBUSY\\
    40          APPNOBUSY\\
    41 
    42 '''BUGS'''
    43 
    44 '''SEE ALSO'''
    45      [[ARexx API/APPNOBUSY| APPNOBUSY ]]
     41 SEE ALSO::
     42     [[APPNOBUSY]]