home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / clib / progs / haswinlib / info / general < prev    next >
Encoding:
Text File  |  1991-02-04  |  5.3 KB  |  109 lines
  1.                       The HASWIN window library.
  2.                      ===========================
  3.                       Copyright H.A. Shaw 1990.
  4.                      ===========================
  5.  
  6. General facilities provided by HASWIN.
  7. ---------------------------------------
  8.  
  9.         In order to work correctly and to provide a uniform interface to
  10. the user the include file, "haswin.h" has to contain items internal to
  11. HASWIN, but available to the user program as well.  Under normal
  12. circumstances the user program will not have to make use of these items, but
  13. they will be explained here.
  14.  
  15. HASWIN_WIMP_Swi         - This #defined constant is the base number for
  16.                           WIMP SWIs.
  17. HASWIN_HASWIN_Swi       - This #defined constant is the base number for
  18.                           HASWINs own SWIs.  At present it is unused.
  19.  
  20.         The following #defined constants provide the SWI numbers for direct
  21. calls to the WIMP SWIs.  The user program should have no need to ever use
  22. direct calls to WIMP SWIs, but they are provided just in case.
  23.  
  24. HASWIN_Initialise, HASWIN_Create_window, HASWIN_Create_icon,
  25. HASWIN_Delete_window, HASWIN_Delete_icon, HASWIN_Open_window,
  26. HASWIN_Close_window, HASWIN_Poll, HASWIN_Redraw_window, HASWIN_Update_window,
  27. HASWIN_Get_rectangle, HASWIN_Get_window_state, HASWIN_Get_window_info,
  28. HASWIN_Set_icon_state, HASWIN_Get_icon_state, HASWIN_Get_pointer_info,
  29. HASWIN_Drag_box, HASWIN_Force_redraw, HASWIN_Set_caret, HASWIN_Get_caret,
  30. HASWIN_Create_menu, HASWIN_Decode_menu, HASWIN_Which_icon, HASWIN_Set_extent,
  31. HASWIN_Set_pointer_shape, HASWIN_Open_template, HASWIN_Close_template,
  32. HASWIN_Load_template, HASWIN_Process_key, HASWIN_Closedown,
  33. HASWIN_Start_task, HASWIN_Report_error, HASWIN_Get_window_outline,
  34. HASWIN_Poll_idle, HASWIN_Plot_icon, HASWIN_Set_mode, HASWIN_Set_palette,
  35. HASWIN_Read_palette, HASWIN_Set_colour, HASWIN_Send_message,
  36. HASWIN_Create_sub_menu, HASWIN_Sprite_operation, HASWIN_Base_of_sprites,
  37. HASWIN_Block_copy, HASWIN_Slot_size, HASWIN_Read_pix_trans,
  38. HASWIN_Claim_free_memory, HASWIN_Command_window, HASWIN_Text_colour,
  39. HASWIN_Transfer_block, HASWIN_Read_sys_info, HASWIN_Set_font_colours,
  40.  
  41.         The following #defined constants provide the SWI numbers for direct
  42. calls to the HourGlass SWIs.  The user program should have no need to ever
  43. use direct calls to HourGlass SWIs, but they are provided just in case.
  44.  
  45. HASWIN_Hourglass_on, HASWIN_Hourglass_off
  46.  
  47.         The following #defined constants provide useful values for use with
  48. HASWIN programs.
  49.  
  50. HASWIN_UNKNOWN          - returned by some HASWIN routines.
  51. HASWIN_FALSE            - returned by some HASWIN routines.
  52. HASWIN_TRUE             - returned by some HASWIN routines.
  53.  
  54. TASK_MAXNAME            - maximun length of a task name for a user program
  55. HASWIN_ACTIVEMAX        - maximum number of active windows.  This is greater
  56.                           than the number of windows the underlying WIMP will
  57.                           allow on the screen at a time.
  58. HASWIN_SPRITEFILE       - name of file containing HASWINs sprites.
  59. HASWIN_TEMPLATEFILE     - name of file containing HASWINs templates.
  60.  
  61. haswin_bell()           - this macro rings the terminal bell by sending a
  62.                           CONTROL+G to the standard output stream.
  63.  
  64. char    *haswin_getcommandline();
  65.                         - this routine returns the commandline the program
  66.                           was started with.
  67.  
  68. int     haswin_getflags();
  69.                         - this routine returns the global HASWIN flags as
  70.                           passed to haswin_initialise() and modified with
  71.                           haswin_setflags() and haswin_clearflags().
  72.  
  73. int     haswin_clearflags(int flags);
  74.                         - this routine clears the global HASWIN flags given
  75.                           in the parameter "flags".
  76.  
  77. int     haswin_setflags(int flags);
  78.                         - this routine sets the global HASWIN flags given in
  79.                           the parameter "flags".
  80.  
  81. int     *haswin_getstarttime();
  82.                         - this routine returns a pointer to a five byte time
  83.                           block which contains the time at which the program
  84.                           was started.
  85.  
  86. int     haswin_getversion();
  87.                         - this routine returns the current version number of
  88.                           the HASWIN library (*100).
  89.  
  90.  
  91. int     haswin_setinfowindow(char *title, char *purpose, char *author, char *version);
  92.                         - this routine creates a "standard" info window and
  93.                           adds it to the menu of any icons this program has
  94.                           (or will put in the future) on the icon bar.  The
  95.                           parameters should be self explainatory to anyone
  96.                           who has seen an Info window before.
  97.                           If a window called "information" exists then it is
  98.                           used and the four parameters are placed into the
  99.                           first four icons in the icon definition (icon
  100.                           handles 0-3).  If no window is found any currently
  101.                           open template file is searched for a window called
  102.                           "information", and only if no window is found is
  103.                           the HASWIN default window used.
  104.  
  105. int     haswin_helpreply(char *, buffer *);
  106. int     haswin_openfiler(char *, char *);
  107. int     haswin_swi(int, _kernel_swi_regs *);
  108.  
  109.