home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / utility / system / winx21 / winxprog.eng < prev    next >
Text File  |  1993-09-09  |  10KB  |  208 lines
  1. IMPORTANT NOTES FOR WINX PROGRAMMERS (WINX 2.1 [9/9/1993])
  2.  
  3. - For the time of testing your own programs, WINX will be a helpful
  4.   tool and should always configured to display wrong parameters
  5.   for calls of the window library.
  6.   The only wind_xxx function which may be called with an invalid window
  7.   handle without getting an error report is wind_get(WF_OWNER).
  8.  
  9. - wind_get()/wind_set()
  10.   Both function now return 0 in case of an error, otherwise 1.
  11.   (up to now, the return value was ALWAYS 1)
  12.   An error is reported for example in the case, that a mode
  13.   WF_xxxx is not implemented or the call has been made with
  14.   an illegal window handle. If you start a program, you should
  15.   ALWAYS check, if wind_get() return a sensible value. This could
  16.   be done by using the following:
  17.     #define WF_RETURN 1
  18.     retok = (wind_get( 0, WF_RETURN, &ign, &ign, &ign, &ign) == 0);
  19.   It is under all current GEM-Versions not critical to use an
  20.   unknown WF_-Mode, because it always has been ignored.
  21.  
  22. - wind_get( 0, WF_WINX(=22360), &version, &date, &rsv1, &rsv2)
  23.   Returns 1, if WINX is installed, otherwise 0.
  24.   version: Bit [15..12]  beta indicator
  25.            Bit [11.. 8]  major version number (actually 2)
  26.            Bit [ 7.. 4]  minor version number (actually 1)
  27.            Bit [ 3.. 0] internal identifier
  28.  
  29. - wind_get( 0, WF_WINXCFG(=22361), &gmask, &gflags, &lmask, &lflags)
  30.   Returns the application specific configuration switches of the
  31.   currently running application.
  32.   gmask:   mask of the GLOBAL switches, which are supported by the
  33.            currently installed version of WINX
  34.   gflags:  the current setting of the GLOBAL switches. Applicable are
  35.            only those switches, that are set in mask (bit 0 - switch 1)
  36.   gmask:   mask of the LOCAL switches, which are supported by the
  37.            currently installed version of WINX
  38.   gflags:  the current setting of the LOCAL switches. Applicable are
  39.            only those switches, that are set in mask (bit 0 - switch 1)
  40.  
  41. - wind_get( rsv0, 22362-22400, &rsv2, &rsv3, &rsv4, &rsv5)
  42.   wind_set( rsv0, 22362-22400, rsv2, rsv3, rsv4, rsv5)
  43.   Undocumented or reserved WINX extensions.
  44.  
  45. - wind_get( 0, WF_TOP, &topwin, &owner, &belowwin)
  46.   Always returns the handle of the topmost window. If no window is
  47.   open, topwin will be 0.
  48.  
  49. - wind_get( win, WF_OWNER(=20), &owner, &isopen, &abovewin, &belowwin)
  50.   delivers informations of a window. the window even can be closed
  51.   (this means, it is not in the window stack) or even not exist (then
  52.   the function return 0).
  53.  
  54. - wind_set( win, WF_BOTTOM, 0, 0, 0, 0)
  55.   WF_BOTTOM puts a window in the background in the window stack.
  56.   This must be an open window.
  57.  
  58. - wind_get( 0, WF_BOTTOM(=25), &bottomwin)
  59.   Returns the handle of the mostback window in the window stack.
  60.   If no window is open, bottomwin will contain -1 (NOWINDOW).
  61.  
  62. - wind_set( win WF_BEVENT(=24), 0/1, 0, 0, 0)
  63.   WF_BEVENT takes care, that the owner of a window will not get
  64.   a WM_TOPPED-message, if somebody clicks in the window, while the
  65.   window is not active. Instead of this, a MU_BUTTON event is generated,
  66.   if the window owner has requested such an event with evnt_multi().
  67.  
  68. - wind_get( win, WF_BEVENT, &v1, &v2, &v3, &v4)
  69.   Returns the BEVENT-state of the window in Bit 0 of v1.
  70.  
  71. - wind_get( win, WF_NEWDESK, &treehigh, &treelow, &treeroot)
  72.   Return the current background tree and its root object.
  73.   CAUTION: Up to now, it is not documented how this information
  74.   might be used.
  75.  
  76. - wind_get( win, WF_COLOR, &obj, &col1, &col2);
  77.   returns the colors of an objekts of the window frame.
  78.   CAUTION: obj must be passed in intin[ 2].
  79.  
  80. - wind_get( 0, WF_DCOLOR, &obj, &col1, &col2);
  81.   Returns the default color of an object of the window frame.
  82.   CAUTION: obj must be passed in intin[ 2].
  83.  
  84. - If you want to set an own background tree with wind_set( WF_NEWDESK )
  85.   you always should ask for position and dimension of its ROOT object
  86.   by calling
  87.     wind_get( 0, WF_WORKXYWH, &deskx, &desky, &deskw, &deskh)
  88.   (and NOT using WF_CURRXYWH)
  89.  
  90. - wind_set( win, WF_CURRXYWH, x, y,w, h), wind_open( win, x, y, w, h)
  91.   After these operations an application should always call
  92.     wind_get( win, WF_CURRXYWH, &currx, &curry, &currw, &currh)
  93.   to get the window rectangle, because there is a possibility that
  94.   the AES corrects the rectangle automatically.
  95.   
  96. - [WM_BOTTOMED(=33) apid 0 win 0 0 0 0]-message
  97.   This message is used by the WINX SCRENMGR to ask the application
  98.   to put its window in the background by calling
  99.     wind_set( win,WF_BOTTOM, 0,0,0,0).
  100.   After this action the application should NOT top one of its own
  101.   windows explicitly.
  102.   If an application has opened more than one window, and it doesn't
  103.   want to change the hierarchy of the windows, it should put ALL
  104.   windows in the background (it would be very practical, the AES
  105.   would have such a function...)
  106.  
  107. - programming an inverse 'change window' function
  108.   An application, which wants to give acess to such a funktion
  109.   should put its topmost window in the background with
  110.   WF_BOTTOM and then activate the now topmost window in its
  111.   own window list with WF_TOP (to make sure, that the application
  112.   always has full control of the keyboard input).
  113.  
  114. - inverse 'change window' function in applications
  115.   an application, which implements such a window should put its tomost
  116.   window to the back with WF_BOTTOM and then activate the topmost from
  117.   its own window list with WF_TOP (to make sure to still have the
  118.   key focus)
  119.  
  120. - [WM_UNTOPPED(=30) apid 0 win 0 0 0 0]-message
  121.   [WM_ONTOP(=31) apid 0 win 0 0 0 0]-message
  122.   Both messages are used to inform applications about changes in
  123.   the active window. WM_UNTOPPED is sent to the owner of the
  124.   previously active window after a window has been opened or
  125.   activated. WM_ONTOP is sent to the owner of the THEN (afterwards)
  126.   active window after closing or deactivating another window. At
  127.   the time where this message arrives, the window stack can
  128.   already have been again changed.
  129.  
  130. - wind_update() saved the list of applications waiting for update
  131.   control in a LIFO queue (this means the newest request for update
  132.   control will be fulfilled first.) WINX uses a FIFO.
  133.  
  134. - wind_update( BEG_UPDATE|0x100 );
  135.   wind_update( BEG_MCTRL|0x100 );
  136.   WINX implements the 'check and set' mode of MultiTOS AES 4.00.
  137.   This means, the control will only be taken, if not already another
  138.   application has control or is not owners of the application. If
  139.   control cannot be taken, the function returns 0.
  140.  
  141. - wind_update( END_xxxx) is now checked for underflow and generates an
  142.   alert on errors.
  143.  
  144. - wind_new() cleared all stacked update requests without any relief.
  145.   WINX sees wind_new() as a function to clear off after a crashed
  146.   application, so it only clears off THEIR update requests. The new
  147.   initialistion of the window management is performed under strict
  148.   UPDATE control, this guarantees, that windows do not disappear while
  149.   an accesory might have the update control.
  150.  
  151. - evnt_multi()
  152.   The realtime functions of WINX can only work, if with the usage of
  153.   MU_TIMER the timer value is set to a value greater than 0, because
  154.   evnt_multi() does not pass the requests to the kernal, but only reads
  155.   queued events.
  156.  
  157. - fill pattern base coordinate
  158.   If this switch is turned on WINX takes care that during the drawing
  159.   of a GEM-Object, the fill pattern will be drawn be relative to the left
  160.   topmost edge of the object (instead of being at 0/0 of the current
  161.   screen). Only THIS way, the redraw can be reduced to the parts of
  162.   the object, which have been invisible before a window has been
  163.   moved etc, so this is an elementary neccesity for realizing stuff
  164.   like realtime moving of filled objects and realtime scrolling.
  165.  
  166. - Redraw von Fenstern
  167.   Die Fensteroperationen wind_open(), wind_set( WF_CURR|WF_TOP), etc.
  168.   senden Redraws für die Bereiche des Fensters, die neu sichtbar
  169.   werden. Einige AES Version senden statt dieser Teilredraws Redraws
  170.   für das komplette Fenster (dies ist unter Umständen notwendig,
  171.   damit Füllmuster, etc. zusammenpassen). Will/muß man gleichzeitig
  172.   zur Fensteroperation den Fensterinhalt ändern, sollte man sich
  173.   selbst mit appl_write() ein Komplettredraw schicken, welches dann
  174.   mit den von der Fensterverwaltung erzeugten Redraws vereinigt wird.
  175.   Unter AES 4.00 werden die Redraws momentan nicht vereinigt, daher
  176.   kann man für dieses AES entweder eine Sonderbehandlung benutzen
  177.   oder hoffen, daß ATARI irgendwann zur alten Lösung zurückfindet.
  178.  
  179. - the value of the WINX cookie contains a pointer to a function, that
  180.   returns some information about some functionality of the current
  181.   version of WINX
  182.  
  183.     long cdecl winxfunc(short founcid,...);  /* PureC syntax) */
  184.  
  185.   The parameters are passed on the stack. The result is returned in
  186.   register D0. If not explicitly defined in a different way, a return
  187.   value of -1L means, that the function is not existing or is not
  188.   applicable in this moment.
  189.   Some functions are reserved for internal communication. No register
  190.   except D0 are changed after a function call.
  191.  
  192.   Some WINX internal variables can be accessed through TSR programs.
  193.   Detailed information can be supplied by the author.
  194.  
  195. - appl_getinfo()
  196.   WINX versions >= 2.1 offer the new AES call appl_getinfo().
  197.  
  198.     int has_appl_getinfo( void)
  199.     {
  200.       int winxversion, ign;
  201.       
  202.       if (aesversion >= 0x400) return( TRUE);
  203.       if (wind_get( 0, WF_WINX, &version, &ign, &ign, &ign) != 0) {
  204.         return( (version & 0x0FFF) >= 0x0210);
  205.       };
  206.       return( FALSE);
  207.     } /* has_appl_getinfo */
  208.