home *** CD-ROM | disk | FTP | other *** search
/ Mega CD-ROM 1 / megacd_rom_1.zip / megacd_rom_1 / DESQVIEW / API_EXAM.ZIP / C.DOC < prev    next >
Text File  |  1988-09-30  |  11KB  |  256 lines
  1.                      C Interfaces
  2.  
  3. Listed below are the DESQview API C interfaces available with the
  4. DESQview API C Library.
  5.  
  6.  
  7. General Functions
  8.  
  9. api_beginc      begin critical region
  10. api_cancel      cancel current Window Mgr operation
  11. api_endc        end critical region
  12. api_exit        exit API interface
  13. api_freebit     disconnect 2nd level interrupt handler
  14. api_getbit      define 2nd level interrupt handler
  15. api_getmem      get system memory buffer
  16. api_init        initialize API interface
  17. api_isobj       determine if a given handle is valid
  18. api_justify     enable/disable automatic justification of window
  19. api_kmouse      turn keyboard mouse on and off
  20. api_level       define API revision level required by application
  21. api_pause       give other tasks a chance to run
  22. api_poke        display debug information/bottomline of screen
  23. api_putmem      return system memory buffer
  24. api_pushkey     push key into input stream
  25. api_setbit      schedule 2nd level interrupt handler
  26. api_shadow      get task's logical window buffer& start shadowing
  27. api_sound       make a sound
  28. api_update      redraw portion of logical window and     stop shadowing
  29.  
  30.  
  31. Application Management Functions
  32.  
  33. app_foreonly    indicate whether a task can run in background
  34. app_free        free an application and its window
  35. app_goback      force an application into background
  36. app_gofore      force an application into foreground
  37. app_hide        hide all windows of an application
  38. app_new         create a new application in the current process
  39. app_number      get current applications SWITCH number
  40. app_show        display all windows of an application
  41. app_start       start a new application in a new process
  42. app_suspend     suspend & hide all application's tasks
  43.  
  44.  
  45. Field Management Functions
  46.  
  47. fld_altmode     set Alternate field processing mode
  48. fld_attr        fill a field with a given attribute
  49. fld_char        fill a field with a given character
  50. fld_clear       clear a field
  51. fld_cursor      move cursor to a field
  52. fld_entry       change field table entry
  53. fld_header      change field table header
  54. fld_marker      define selected field marker character
  55. fld_point       move pointer to given position in field
  56. fld_reset       reset selected and modified bits
  57. fld_scroll      scroll a field
  58. fld_swrite      write a string into a field
  59. fld_type        change the type of a field
  60. fld_write       write characters into a field
  61.  
  62.  
  63. Keyboard Management Functions
  64.  
  65. key_addto       set keyboard behavior flags
  66. key_close       disconnect keyboard from its window
  67. key_erase       discard pending keyboard input
  68. key_free        free a keyboard object
  69. key_getc        wait for next key (keystroke mode)
  70. key_me          get current tasks keyboard handle
  71. key_new         create a new keyboard object
  72. key_of          get handle of a given task's keyboard
  73. key_open        attach keyboard to a given window
  74. key_read        read input from keyboard
  75. key_setesc      define function to filter keys in field mode
  76. key_sizeof      get # keyboard messages pending
  77. key_status      get status of last keyboard message
  78. key_subfrom     clear keyboard behavior flags
  79. key_write       write data to keyboard
  80.  
  81.  
  82. Mailbox Management Functions
  83.  
  84. mal_addr        return sender of last message
  85. mal_addto       send message by value with given status
  86. mal_close       close a mailbox
  87. mal_erase       erase all pending messages
  88. mal_find        find a mailbox by name
  89. mal_free        free a mailbox object
  90. mal_lock        lock access to a resource
  91. mal_me          get handle of MAILME mailbox
  92. mal_name        assign a global name to a mailbox
  93. mal_new         create a new mailbox
  94. mal_of          get handle of a given task's mailbox
  95. mal_open        open a mailbox
  96. mal_read        wait for next message
  97. mal_sizeof      get # messages pending
  98. mal_status      get status of last message received
  99. mal_subfrom     send message by reference with given status
  100. mal_unlock      unlock access to a resource
  101. mal_write       send a message by value with status zero
  102.  
  103.  
  104. Objectq Management Functions
  105.  
  106. obq_close       close the task's objectq
  107. obq_erase       erase contents of the task's objectq
  108. obq_open        open the task's objectq
  109. obj_read        wait for any object to have input
  110. obq_sizeof      get # of objectq entries pending
  111. obq_status      determine if the task's objectq is open
  112. obq_subfrom     remove an object from the task's obectq
  113.  
  114.  
  115. Panel Management Functions
  116.  
  117. pan_apply       display a named panel & prepare for input
  118. pan_close       close a panel file
  119. pan_dir         get list of panels in the panel file
  120. pan_free        free a panel object
  121. pan_new         create a panel object
  122. pan_open        open a panel file
  123. pan_sizeof      get # panels in the panel file
  124. pan_status      get status of last pan_open or pan_apply
  125.  
  126.  
  127. Pointer Management Functions
  128.  
  129. ptr_addto       set pointer control flags
  130. ptr_close       close a pointer object
  131. ptr_erase       erase pending pointer messages
  132. ptr_free        free a pointer object
  133. ptr_getscale    get current scaling factors
  134. ptr_new         create a new pointer object
  135. ptr_open        open pointer and assign to a window
  136. ptr_read        wait for next pointer message
  137. ptr_setscale    set current scaling factors
  138. ptr_sizeof      get # messages pending
  139. ptr_status      get button state from last message received
  140. ptr_subfrom     clear pointer control flags
  141. ptr_write       move the pointer to a given position
  142.  
  143.  
  144. Query Functions
  145.  
  146. qry_atread      TRUE if win_read and win_readn reads attributes
  147. qry_attr        get current output attribute
  148. qry_color       get physical attribute for given logical attribute
  149. qry_ctrl        TRUE if processing control codes
  150. qry_cursor      get current cursor position
  151. qry_entry       get field table entry
  152. qry_field       get contents of a field
  153. qry_frame       TRUE if the window has a frame
  154. qry_frattr      get current frame attribute
  155. qry_header      get field table header
  156. qry_hidden      TRUE if the window is hidden
  157. qry_kmouse      TRUE if using a keyboard mouse
  158. qry_leave       TRUE if leaving attribute untouched when writing
  159. qry_lsize       get size of logical window buffer
  160. qry_logattr     TRUE if using logical attributes
  161. qry_origin      get origin of physical window relative to logical
  162. qry_position    get position of physical window
  163. qry_size        get size of physical window
  164. qry_title       get window's title
  165. qry_type        get type of field
  166.  
  167.  
  168. Timer Management Functions
  169.  
  170. tim_addto       start a timer for a given interval
  171. tim_close       close a timer object
  172. tim_erase       stop a running timer
  173. tim_free        free a timer object
  174. tim_len         get time remaining until timer expires
  175. tim_new         create a new timer object
  176. tim_open        open a timer object
  177. tim_read        wait for timer to expire
  178. tim_sizeof      get time since a timer started running
  179. tim_status      determine if a timer is running
  180. tim_write       start a timer for a given time of day
  181.  
  182.  
  183. Task Management Functions
  184.  
  185. tsk_free        free a task and its window
  186. tsk_me          get handle of current task
  187. tsk_new         create a new task
  188. tsk_pgmint      software interrupt another task
  189. tsk_post        restart a task and post its Objectq
  190. tsk_start       restart a stopped task
  191. tsk_stop        temporarily stop a task
  192.  
  193.  
  194. Window Management Functions
  195.  
  196. win_addto       write characters and attributes to a window
  197. win_adopt       adopt a window
  198. win_allow       specify which DESQview commands are allowed for a window
  199. win_async       define asynchronous notify function
  200. win_atread      sets read mode to read either charaters or attributes
  201. win_attach      attach window to its parent task window
  202. win_attr        set current output attribute
  203. win_blanks      write blanks to a window
  204. win_bottom      make window bottommost in its application
  205. win_buffer      get pointer to window's logical window     buffer
  206. win_cancel      cancel notification on a given event
  207. win_color       change logical attribute mapping
  208. win_ctrl        enable/disable interpretation of control characters
  209. win_cursor      move window's logical cursor
  210. win_dflt        change default notify window
  211. win_disallow    specify which DESQview commands are not allowed for a window
  212. win_disperor    display an error message window
  213. win_eof         TRUE if logical cursor is beyond end of window
  214. win_erase       clear window
  215. win_frame       enable/disable display of a window's frame
  216. win_frattr      define window frame attribute
  217. win_free        remove a window from the screen and free its handle
  218. win_hcur        display hardware cursor at logical cursor position
  219. win_hide        marks a window as hidden
  220. win_leave       leave existing attribute when writing to a window
  221. win_len         return width of logical window
  222. win_locate      return which window is visible at the given screen row/col
  223. win_logattr     use logical/physical attributes
  224. win_lsize       set windows logical dimensions
  225. win_maxsize     set windows maximum physical dimensions
  226. win_me          get current task's window handle
  227. win_minsize     set windows minimum physical dimensions
  228. win_move        move physical window
  229. win_new         create a new window
  230. win_notify      enable notification on a given event
  231. win_nread       read n characters from a window
  232. win_open        fill a window with a given character
  233. win_origin      define portion of logical window viewed in the physical window
  234. win_orphan      orphan a window
  235. win_paste       define window as current clipboard window
  236. win_point       jump mouse to logical cursor position
  237. win_poswin      position window relative to another window
  238. win_printf      write formatted data to a window
  239. win_putc        write a character/attribute pair to a window
  240. win_read        read rest of current line from window
  241. win_redraw      redraw a window
  242. win_reorder     reorder an applications windows
  243. win_repattr     write an attribute to a window n times
  244. win_repchar     write a character to a window n times
  245. win_resize      set physical dimensions of window
  246. win_scroll      scroll all or part of a window
  247. win_sizeof      get total number of characters in logical window
  248. win_stream      write a stream to a window
  249. win_subfrom     write attributes to a window
  250. win_swrite      write a zero terminated string to a window
  251. win_title       change a windows title
  252. win_top         make window topmost in application
  253. win_topsys      make window topmost in system
  254. win_unhide      marks a window as not hidden
  255. win_write       write characters to a window
  256.