home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 2 / DATAFILE_PDCD2.iso / utilities2 / desklib / Docs / QuickRefs / WindowData < prev   
Text File  |  1993-05-15  |  6KB  |  152 lines
  1. Quick-reference Window-data chart
  2. =================================
  3.  
  4. (version 1.00, 6/4/92 - Jason Williams)
  5.  
  6. Window data for various Wimp_ window-based calls.
  7. Note that some of the data presented here are actually unions, so where you
  8. see (e.g.) "flagword.data." and "flagword.value", they are not two seperate
  9. items... The main purpose of this is to give you the naming structure to
  10. save you thrashing through the header files to figure it out for yourself.
  11.  
  12. ---
  13.  
  14. window_outline (as returned by Wimp_GetWindowOutline)
  15. outline->window
  16. outline->screenrect.min.x                          ; screen rect of window
  17.                    .min.y
  18.                    .max.x
  19.                    .max.y
  20.  
  21. ---
  22.  
  23. window_redrawblock
  24. -as used for redraws: RedrawWindow, UpdateWindow, GetRectangle,
  25.                       ForceRedraw, and as returned by Wimp_Poll for redraw
  26.                       request events
  27.  
  28. redraw->window
  29.       ->rect.min.x             Rectangle to be redrawn (in workarea or screen
  30.             .min.y             coordinates depending on context)
  31.             .max.x
  32.             .max.y
  33.       ->scroll.x               Scroll offsets of window
  34.               .y
  35.       ->cliprect.min.x         Clip rectangle (graphics "viewport")
  36.                 .min.y         -Screen coordinates of rectangle limiting
  37.                 .max.x         drawing operations. All output should be clipped
  38.                 .max.y         to be plotted only within this area
  39.  
  40. ---
  41.  
  42. window_state
  43. -as returned by Wimp_GetWindowState
  44.  
  45. wstate->openblock.window       a window_openblock
  46.             .screenrect.min.x  The screen rect of the visible workarea region
  47.                        .min.y
  48.                        .max.x
  49.                        .max.y
  50.                  .scroll.x     The current scrollbar positions
  51.                         .y
  52.                  .behind       The handle of the window this one is behind
  53.       ->flags.value
  54.              .data.            window flags: choose from:
  55.                   .hastitle
  56.                   .moveable
  57.                   .hasvscroll
  58.                   .hashscroll
  59.                   .autoredraw
  60.                   .pane
  61.                   .nobounds
  62.                   .nobackclose
  63.                   .scrollrq
  64.                   .scrollrqdebounced
  65.                   .realcolours
  66.                   .backwindow
  67.                   .hotkeys
  68.                   .open
  69.                   .top
  70.                   .fullsize
  71.                   .istoggling
  72.                   .focus
  73.                   .backicon
  74.                   .closeicon
  75.                   .titlebar
  76.                   .toggleicon
  77.                   .vscroll
  78.                   .adjusticon
  79.                   .hscroll
  80.                   .newflags
  81. ---
  82.  
  83. window_info
  84. -as used for creating windows: Wimp_CreateWindow, Wimp_GetWindowInfo
  85.  
  86. winfo->window
  87.      ->block.screenrect.min.x                Screen position of window
  88.                        .min.y
  89.                        .max.x
  90.                        .max.y
  91.             .scroll.x                        Scrollbar offsets
  92.             .scroll.y
  93.             .behind                          Handle of window this is behind
  94.                                              (-1 == window is at front)
  95.             .flags.value }                   window flag word value
  96.                   .data. }                   window flags: choose from:
  97.                        .hastitle
  98.                        .moveable
  99.                        .hasvscroll
  100.                        .hashscroll
  101.                        .autoredraw
  102.                        .pane
  103.                        .nobounds
  104.                        .nobackclose
  105.                        .scrollrq
  106.                        .scrollrqdebounced
  107.                        .realcolours
  108.                        .backwindow
  109.                        .hotkeys
  110.                        .open
  111.                        .top
  112.                        .fullsize
  113.                        .istoggling
  114.                        .focus
  115.                        .backicon
  116.                        .closeicon
  117.                        .titlebar
  118.                        .toggleicon
  119.                        .vscroll
  120.                        .adjusticon
  121.                        .hscroll
  122.                        .newflags
  123.             .colours[8]                      WIMP colours for the window
  124.             .workarearect.min.x              Work area extent of the window
  125.                          .min.y
  126.                          .max.x
  127.                          .max.y
  128.             .titleflags. ...                 } icon flag words for title and
  129.             .workflags. ...                  } work area defaults
  130.                                                - see QuickRefs.IconData
  131.  
  132.             .spritearea                      pointer to window's sprite area
  133.             .minsize.x                       min. width (0 == limit to title)
  134.                     .y                       min. height (0 == default)
  135.             .title.
  136.                   .text                      ; 12-char text string
  137.                   .spritename                ; 12-char sprite name
  138.  
  139.                   .indirecttext.buffer       ; ptr to text buffer
  140.                   .indirecttext.validstring  ; ptr to validation string
  141.                                              ; (-1 == none)
  142.                   .indirecttext.bufflen      ; length of buffer (including
  143.                                              ; terminating character)
  144.  
  145.                   .indirectsprite.name       ; ptr to sprite-name/sprite-data
  146.                   .indirectsprite.spritearea ; ptr to sprite area sprite in
  147.                   .indirectsprite.nameisname ; flag: TRUE means name points to
  148.                                              ; string, FALSE means it points to
  149.                                              ; the actual sprite data.
  150.             .numicons                        number of icons in window
  151.  
  152.