home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / basic / blib / Docs / Libraries < prev    next >
Encoding:
Text File  |  1993-10-18  |  5.2 KB  |  162 lines
  1.  
  2.  
  3. A quick guide to the supplied libraries
  4. ---------------------------------------
  5.  
  6. Although each library contains help text for each procedure/function (and the
  7. library as a whole), here is an outline of the available libraries supplied
  8. with BlibII :
  9.  
  10.  
  11. The Memory Library
  12. ------------------
  13.  
  14. The memory library provides a convenient and fast memory allocation for Basic
  15. programs. It also has full deallocation (something missing from Basic) and
  16. can even control the size of your wimpslot (raining AND lowering).
  17.  
  18. It provides the usual functions and procedures (malloc, free, realloc, etc.)
  19. as well as a general purpose memory copy routine.
  20.  
  21.  
  22. The Wimp Library
  23. ----------------
  24.  
  25. This library contains routines for initialising your program with the wimp
  26. (including placing the sprite on the iconbar), quitting your application
  27. cleanly, producing errors and messages, and performing a wimp poll.
  28.  
  29. The wimp poll procedure is made using a unique feature of the BlibII linker,
  30. the 'update block'. This means that each time you pass your program through
  31. the linker, this procedure is updated (ripped out and replaced).
  32.  
  33. This is done because the procedure uses another feature of the linker,
  34. conditional linking. This means that exactly what is linked into your
  35. program depends upon what your program requires. Thus the call to a, say,
  36. key press handling procedure is only linked in if your program needs it.
  37.  
  38. You indicate which events you can handle, by providing event handlers for
  39. that event (see the Event library, below).
  40.  
  41.  
  42. The Event Library
  43. -----------------
  44.  
  45. This library contains a few default event handlers (eg. for handling
  46. window open events). You can, however, write you own replacement version
  47. of these routines if they don't do what you require.
  48.  
  49. The main purpose of the Event library, however, is in it's main description
  50. which lists all the procedure names for event handlers which you can write
  51. into your program, and which will get called automatically by the wimp poll
  52. procedure from the Wimp library.
  53.  
  54.  
  55. The Data Transfer Library (Transfer)
  56. -------------------------
  57.  
  58. This library provides a number of routines to help handle saving and loading
  59. of data to/from applications.
  60.  
  61. The main part of this library is an 'update block', so the more functionality
  62. your program requires from this library, the more functionality you get.
  63. (See the main description in this library for details).
  64.  
  65.  
  66. The Template Library
  67. --------------------
  68.  
  69. This library contains the necessary routines to load a templates file into
  70. memory (or multiple files), locate templates from loaded files, and also
  71. make (and destroy) copies of templates.
  72.  
  73.  
  74. The Window Library
  75. ------------------
  76.  
  77. This library supplies routines for create, open, close, resize, move, delete
  78. and redraw windows. Also set the title, get the position, set/get the extent,
  79. set/get it's type (see below) and centre the window on the screen.
  80.  
  81. This library uses a special structure to hold windows which allows windows
  82. to be given a type (and also local data). Thus then a procedure states
  83. that it requires a 'window' as a parameter, this means this special data
  84. structure, not the window's handle.
  85.  
  86. At present there are two supplied window types, the simple text window (which
  87. allows text to be displayed in a window (using any of the wimp colours), and
  88. a draw window (allowing a drawfile to be displayed in a window).
  89.  
  90.  
  91. The Menu Library
  92. ----------------
  93.  
  94. This library contains routines allowing the creation of menus. It supplies
  95. two methods of creating a menu (array based or building items one at a time).
  96.  
  97.  
  98. The Draw and Sprite Libraries
  99. -----------------------------
  100.  
  101. These two libraries contain routines for creating drawfiles and sprites, and
  102. handling them, etc.
  103.  
  104.  
  105. The Icon Library
  106. ----------------
  107.  
  108. This library contains a few useful routines relating to icons.
  109.  
  110.  
  111. The Font Library
  112. ----------------
  113.  
  114. This library contains routines that allow the handling of fonts.
  115.  
  116.  
  117. The Message Library
  118. -------------------
  119.  
  120. Contains routines for handling messages files which allow software to be
  121. written in a language independent way. It also provides a way of creating
  122. menus from a message file.
  123.  
  124. The OS Library
  125. --------------
  126.  
  127. This library contains a few general routines for handling :
  128.  
  129.   -  Program arguments
  130.   -  Finding the screen size and number of colours
  131.   -  Writing and reading zero terminated strings
  132.   -  Reading system variables
  133.   -  Calling OS_GSTrans
  134.  
  135.  
  136. The Calendar Library
  137. --------------------
  138.  
  139. This library contains various routines related to the calendar, including :
  140.  
  141.   -  Finding the day of the week for a given date
  142.   -  Finding todays date from TIME$
  143.   -  Finding the number of days in a given year
  144.   -  Finding if a given year is a leap year or not
  145.   -  Finding the number of days between any two dates
  146.   -  Finding out if a given date is valid
  147.   -  Finding out what day of the year a given date is
  148.  
  149. The take account of the calendar switch in 1752, but leap years are assumed
  150. to follow the current method of calculation.
  151.  
  152.  
  153.  
  154. The Slider (Sub) Library
  155. ------------------------
  156.  
  157. The Slider Library (which is located within the Icon library, allows simple
  158. and convenient handling of sliders. The routines allow for the Risc OS 3
  159. style of slider icons (as defined in the Risc OS 3 Style Guide) which
  160. comprise of three icons, a well, a base and the slider icon.
  161.  
  162.