home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / evntshell / Docs / Fonts < prev    next >
Encoding:
Text File  |  1995-10-22  |  2.1 KB  |  78 lines
  1. FN_shell_Fonts_Init
  2. =>    None
  3.  
  4. <=    bool    TRUE if module initialised correctly
  5.          FALSE otherwise
  6.  
  7. Normally called automatically when the library file
  8. is loaded by FNshell_InstallLib. If the library
  9. code is appended to the main program instead it will
  10. need to be called to initialise the fonts module.
  11.  
  12. --------------------------------------------------------
  13.  
  14. FNshell_Fonts_GetDeskTopFont
  15. =>    None
  16.  
  17. <=    int    configured desktop font handle
  18.  
  19. This routine only returns a meaningful value under
  20. RISC OS 3.5 or higher. The font handle should be
  21. re-read before any redraw which might involve the
  22. desktop font as the font can be changed at any time
  23. by the user.
  24.  
  25. On older versions of RISC OS or if no DeskTop font
  26. is configured a value of 0 is returned to denote
  27. the 'system' font.
  28.  
  29. --------------------------------------------------------
  30.  
  31. FNshell_Fonts_FontIsAvailable()
  32. =>    str    font name i.e. 'Trinity.Medium'
  33.     real    font width in pts
  34.     real    font height in pts
  35.  
  36. <=    bool    TRUE font found, otherwise FALSE
  37.  
  38. --------------------------------------------------------
  39.  
  40. PROCshell_Fonts_FindFont()
  41. =>    str    font name i.e. 'Trinity.Medium'
  42.     real    font width in pts
  43.     real    font height in pts
  44.     int    font handle (updated on return)
  45.     
  46. This routine returns a handle for the specified
  47. font at the given size. It also causes the font
  48. to be cached for later use. If the font cannot
  49. be found the font handle is set to 0.
  50.  
  51. Taken from BLibII library 'Draw' by Tom Hughes.
  52.  
  53. --------------------------------------------------------
  54.  
  55. PROCshell_Fonts_ForgetFont()
  56. =>    int    font handle
  57.  
  58. This routine should be called when a program
  59. has finished with a font. It tells the font
  60. manager that it may uncache the font if it
  61. wishes, as it is no longer being used.
  62.  
  63. Taken from BLibII library 'Draw' by Tom Hughes.
  64.  
  65. --------------------------------------------------------
  66.  
  67. PROCshell_Fonts_SetColour()
  68. =>    int    foreground colour
  69.     int    background colour
  70.  
  71. This procedure sets the colours used for
  72. plotting outline fonts. Each of the
  73. specified colours is given as a word of
  74. the form &BBRRGG00. 
  75.  
  76. Taken from BLibII library 'Draw' by Tom Hughes.
  77.  
  78. --------------------------------------------------------