home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Misc / TRSICAT.LZX / CATS_CD2_TRSI / Inc&AD1.3 / Includes / intuition / intuition.h next >
Encoding:
C/C++ Source or Header  |  1992-09-12  |  39.3 KB  |  1,028 lines
  1. #ifndef INTUITION_INTUITION_H
  2. #define INTUITION_INTUITION_H
  3. /*
  4. **    $Filename: intuition/intuition.h $
  5. **    $Release: 1.3 $
  6. **
  7. **    main intuition include 
  8. **
  9. **    (C) Copyright 1985,1986,1987,1988 Commodore-Amiga, Inc.
  10. **        All Rights Reserved
  11. */
  12.  
  13. #ifndef EXEC_TYPES_H
  14. #include "exec/types.h"
  15. #endif
  16.  
  17. #ifndef GRAPHICS_GFX_H
  18. #include "graphics/gfx.h"
  19. #endif
  20.  
  21. #ifndef GRAPHICS_CLIP_H
  22. #include "graphics/clip.h"
  23. #endif
  24.  
  25. #ifndef GRAPHICS_VIEW_H
  26. #include "graphics/view.h"
  27. #endif
  28.  
  29. #ifndef GRAPHICS_RASTPORT_H
  30. #include "graphics/rastport.h"
  31. #endif
  32.  
  33. #ifndef GRAPHICS_LAYERS_H
  34. #include "graphics/layers.h"
  35. #endif
  36.  
  37. #ifndef GRAPHICS_TEXT_H
  38. #include "graphics/text.h"
  39. #endif
  40.  
  41. #ifndef EXEC_PORTS_H
  42. #include "exec/ports.h"
  43. #endif
  44.  
  45. #ifndef DEVICES_TIMER_H
  46. #include "devices/timer.h"
  47. #endif
  48.  
  49. #ifndef DEVICES_INPUTEVENT_H
  50. #include "devices/inputevent.h"
  51. #endif
  52.  
  53.  
  54. /* ======================================================================== */
  55. /* === Menu =============================================================== */
  56. /* ======================================================================== */
  57. struct Menu
  58. {
  59.     struct Menu *NextMenu;    /* same level */
  60.     SHORT LeftEdge, TopEdge;    /* position of the select box */
  61.     SHORT Width, Height;    /* dimensions of the select box */
  62.     USHORT Flags;        /* see flag definitions below */
  63.     BYTE *MenuName;        /* text for this Menu Header */
  64.     struct MenuItem *FirstItem; /* pointer to first in chain */
  65.  
  66.     /* these mysteriously-named variables are for internal use only */
  67.     SHORT JazzX, JazzY, BeatX, BeatY;
  68. };
  69.  
  70.  
  71. /* FLAGS SET BY BOTH THE APPLIPROG AND INTUITION */
  72. #define MENUENABLED 0x0001    /* whether or not this menu is enabled */
  73.  
  74. /* FLAGS SET BY INTUITION */
  75. #define MIDRAWN 0x0100        /* this menu's items are currently drawn */
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82. /* ======================================================================== */
  83. /* === MenuItem =========================================================== */
  84. /* ======================================================================== */
  85. struct MenuItem 
  86. { 
  87.     struct MenuItem *NextItem;    /* pointer to next in chained list */ 
  88.     SHORT LeftEdge, TopEdge;    /* position of the select box */ 
  89.     SHORT Width, Height;    /* dimensions of the select box */ 
  90.     USHORT Flags;        /* see the defines below */ 
  91.  
  92.     LONG MutualExclude;        /* set bits mean this item excludes that */ 
  93.  
  94.     APTR ItemFill;        /* points to Image, IntuiText, or NULL */ 
  95.  
  96.     /* when this item is pointed to by the cursor and the items highlight 
  97.      *    mode HIGHIMAGE is selected, this alternate image will be displayed 
  98.      */ 
  99.     APTR SelectFill;        /* points to Image, IntuiText, or NULL */
  100.  
  101.     BYTE Command;        /* only if appliprog sets the COMMSEQ flag */
  102.  
  103.     struct MenuItem *SubItem;    /* if non-zero, DrawMenu shows "->" */
  104.  
  105.     /* The NextSelect field represents the menu number of next selected 
  106.      *    item (when user has drag-selected several items)
  107.      */
  108.     USHORT NextSelect;
  109. };
  110.  
  111.  
  112. /* FLAGS SET BY THE APPLIPROG */ 
  113. #define CHECKIT        0x0001    /* whether to check this item if selected */ 
  114. #define ITEMTEXT    0x0002    /* set if textual, clear if graphical item */ 
  115. #define COMMSEQ        0x0004    /* set if there's an command sequence */ 
  116. #define MENUTOGGLE    0x0008    /* set to toggle the check of a menu item */ 
  117. #define ITEMENABLED    0x0010    /* set if this item is enabled */ 
  118.  
  119. /* these are the SPECIAL HIGHLIGHT FLAG state meanings */ 
  120. #define HIGHFLAGS    0x00C0    /* see definitions below for these bits */ 
  121. #define HIGHIMAGE    0x0000    /* use the user's "select image" */ 
  122. #define HIGHCOMP    0x0040    /* highlight by complementing the selectbox */
  123. #define HIGHBOX        0x0080    /* highlight by "boxing" the selectbox */ 
  124. #define HIGHNONE    0x00C0    /* don't highlight */ 
  125.  
  126. /* FLAGS SET BY BOTH APPLIPROG AND INTUITION */ 
  127. #define CHECKED        0x0100    /* if CHECKIT, then set this when selected */ 
  128.  
  129. /* FLAGS SET BY INTUITION */ 
  130. #define ISDRAWN        0x1000    /* this item's subs are currently drawn */ 
  131. #define HIGHITEM    0x2000    /* this item is currently highlighted */ 
  132. #define MENUTOGGLED    0x4000    /* this item was already toggled */ 
  133.  
  134.  
  135.  
  136.  
  137.  
  138. /* ======================================================================== */
  139. /* === Requester ========================================================== */
  140. /* ======================================================================== */
  141. struct Requester
  142. {
  143.     /* the ClipRect and BitMap and used for rendering the requester */
  144.     struct Requester *OlderRequest;
  145.     SHORT LeftEdge, TopEdge;        /* dimensions of the entire box */
  146.     SHORT Width, Height;        /* dimensions of the entire box */
  147.     SHORT RelLeft, RelTop;        /* for Pointer relativity offsets */
  148.  
  149.     struct Gadget *ReqGadget;        /* pointer to a list of Gadgets */
  150.     struct Border *ReqBorder;        /* the box's border */
  151.     struct IntuiText *ReqText;        /* the box's text */
  152.     USHORT Flags;            /* see definitions below */
  153.  
  154.     /* pen number for back-plane fill before draws */
  155.     UBYTE BackFill;
  156.     /* Layer in place of clip rect    */
  157.     struct Layer *ReqLayer;
  158.  
  159.     UBYTE ReqPad1[32];
  160.  
  161.     /* If the BitMap plane pointers are non-zero, this tells the system 
  162.      * that the image comes pre-drawn (if the appliprog wants to define 
  163.      * it's own box, in any shape or size it wants!);  this is OK by 
  164.      * Intuition as long as there's a good correspondence between 
  165.      * the image and the specified Gadgets
  166.      */
  167.     struct BitMap *ImageBMap;    /* points to the BitMap of PREDRAWN imagery */
  168.     struct Window *RWindow;    /* added.  points back to Window */
  169.     UBYTE ReqPad2[36];
  170. };
  171.  
  172.  
  173. /* FLAGS SET BY THE APPLIPROG */
  174. #define POINTREL 0x0001     /* if POINTREL set, TopLeft is relative to pointer*/
  175. #define PREDRAWN 0x0002     /* if ReqBMap points to predrawn Requester imagery */
  176. #define NOISYREQ 0x0004     /* if you don't want requester to filter input       */
  177. /* FLAGS SET BY BOTH THE APPLIPROG AND INTUITION */
  178.  
  179. /* FLAGS SET BY INTUITION */
  180. #define REQOFFWINDOW    0x1000    /* part of one of the Gadgets was offwindow */
  181. #define REQACTIVE    0x2000    /* this requester is active */
  182. #define SYSREQUEST    0x4000    /* this requester caused by system */
  183. #define DEFERREFRESH    0x8000    /* this Requester stops a Refresh broadcast */
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190. /* ======================================================================== */
  191. /* === Gadget ============================================================= */
  192. /* ======================================================================== */
  193. struct Gadget
  194. {
  195.     struct Gadget *NextGadget;    /* next gadget in the list */
  196.  
  197.     SHORT LeftEdge, TopEdge;    /* "hit box" of gadget */
  198.     SHORT Width, Height;    /* "hit box" of gadget */
  199.  
  200.     USHORT Flags;        /* see below for list of defines */
  201.  
  202.     USHORT Activation;        /* see below for list of defines */
  203.  
  204.     USHORT GadgetType;        /* see below for defines */
  205.  
  206.     /* appliprog can specify that the Gadget be rendered as either as Border
  207.      * or an Image.  This variable points to which (or equals NULL if there's
  208.      * nothing to be rendered about this Gadget)
  209.      */
  210.     APTR GadgetRender;
  211.  
  212.     /* appliprog can specify "highlighted" imagery rather than algorithmic
  213.      * this can point to either Border or Image data
  214.      */
  215.     APTR SelectRender;
  216.  
  217.     struct IntuiText *GadgetText;   /* text for this gadget */
  218.  
  219.     /* by using the MutualExclude word, the appliprog can describe 
  220.      * which gadgets mutually-exclude which other ones.     The bits 
  221.      * in MutualExclude correspond to the gadgets in object containing 
  222.      * the gadget list.     If this gadget is selected and a bit is set 
  223.      * in this gadget's MutualExclude and the gadget corresponding to 
  224.      * that bit is currently selected (e.g. bit 2 set and gadget 2 
  225.      * is currently selected) that gadget must be unselected.  
  226.      * Intuition does the visual unselecting (with checkmarks) and 
  227.      * leaves it up to the program to unselect internally
  228.      */
  229.     LONG MutualExclude;     /* set bits mean this gadget excludes that gadget */
  230.  
  231.     /* pointer to a structure of special data required by Proportional, 
  232.      * String and Integer Gadgets 
  233.      */
  234.     APTR SpecialInfo;
  235.  
  236.     USHORT GadgetID;    /* user-definable ID field */
  237.     APTR UserData;    /* ptr to general purpose User data (ignored by In) */
  238. };
  239.  
  240.  
  241. /* --- FLAGS SET BY THE APPLIPROG ----------------------------------------- */
  242. /* combinations in these bits describe the highlight technique to be used */
  243. #define GADGHIGHBITS    0x0003
  244. #define GADGHCOMP    0x0000    /* Complement the select box */
  245. #define GADGHBOX    0x0001    /* Draw a box around the image */
  246. #define GADGHIMAGE    0x0002    /* Blast in this alternate image */
  247. #define GADGHNONE    0x0003    /* don't highlight */
  248.  
  249. /* set this flag if the GadgetRender and SelectRender point to Image imagery, 
  250.  * clear if it's a Border 
  251.  */
  252. #define GADGIMAGE 0x0004 
  253.  
  254. /* combinations in these next two bits specify to which corner the gadget's
  255.  *  Left & Top coordinates are relative.  If relative to Top/Left,
  256.  *  these are "normal" coordinates (everything is relative to something in
  257.  *  this universe)
  258.  */
  259. #define GRELBOTTOM    0x0008    /* set if rel to bottom, clear if rel top */
  260. #define GRELRIGHT    0x0010    /* set if rel to right, clear if to left */
  261. /* set the RELWIDTH bit to spec that Width is relative to width of screen */
  262. #define GRELWIDTH    0x0020
  263. /* set the RELHEIGHT bit to spec that Height is rel to height of screen */
  264. #define GRELHEIGHT    0x0040
  265.  
  266. /* the SELECTED flag is initialized by you and set by Intuition.  It 
  267.  * specifies whether or not this Gadget is currently selected/highlighted
  268.  */
  269. #define SELECTED    0x0080
  270.  
  271.  
  272. /* the GADGDISABLED flag is initialized by you and later set by Intuition
  273.  * according to your calls to On/OffGadget().  It specifies whether or not 
  274.  * this Gadget is currently disabled from being selected
  275.  */
  276. #define GADGDISABLED    0x0100
  277.  
  278.  
  279. /* --- These are the Activation flag bits --------------------------------- */
  280. /* RELVERIFY is set if you want to verify that the pointer was still over
  281.  *  the gadget when the select button was released
  282.  */
  283. #define RELVERIFY    0x0001
  284.  
  285. /* the flag GADGIMMEDIATE, when set, informs the caller that the gadget
  286.  *  was activated when it was activated.  this flag works in conjunction with
  287.  *  the RELVERIFY flag
  288.  */
  289. #define GADGIMMEDIATE    0x0002
  290.  
  291. /* the flag ENDGADGET, when set, tells the system that this gadget, when
  292.  * selected, causes the Requester or AbsMessage to be ended.  Requesters or
  293.  *  AbsMessages that are ended are erased and unlinked from the system */
  294. #define ENDGADGET    0x0004
  295.  
  296. /* the FOLLOWMOUSE flag, when set, specifies that you want to receive
  297.  * reports on mouse movements (ie, you want the REPORTMOUSE function for
  298.  * your Window).  When the Gadget is deselected (immediately if you have
  299.  * no RELVERIFY) the previous state of the REPORTMOUSE flag is restored
  300.  * You probably want to set the GADGIMMEDIATE flag when using FOLLOWMOUSE,
  301.  * since that's the only reasonable way you have of learning why Intuition
  302.  * is suddenly sending you a stream of mouse movement events.  If you don't
  303.  * set RELVERIFY, you'll get at least one Mouse Position event.
  304.  */
  305. #define FOLLOWMOUSE    0x0008
  306.  
  307. /* if any of the BORDER flags are set in a Gadget that's included in the
  308.  * Gadget list when a Window is opened, the corresponding Border will
  309.  * be adjusted to make room for the Gadget
  310.  */
  311. #define RIGHTBORDER    0x0010
  312. #define LEFTBORDER    0x0020
  313. #define TOPBORDER    0x0040
  314. #define BOTTOMBORDER    0x0080
  315.  
  316. #define TOGGLESELECT    0x0100    /* this bit for toggle-select mode */
  317.  
  318. #define STRINGCENTER    0x0200    /* should be a StringInfo flag, but it's OK */
  319. #define STRINGRIGHT    0x0400    /* should be a StringInfo flag, but it's OK */
  320.  
  321. #define LONGINT        0x0800    /* this String Gadget is actually LONG Int */
  322.  
  323. #define ALTKEYMAP    0x1000    /* this String has an alternate keymap */
  324.  
  325. #define BOOLEXTEND    0x2000    /* this Boolean Gadget has a BoolInfo    */
  326.  
  327.  
  328. /* --- GADGET TYPES ------------------------------------------------------- */
  329. /* These are the Gadget Type definitions for the variable GadgetType
  330.  * gadget number type MUST start from one.  NO TYPES OF ZERO ALLOWED.
  331.  * first comes the mask for Gadget flags reserved for Gadget typing
  332.  */
  333. #define GADGETTYPE    0xFC00    /* all Gadget Global Type flags (padded) */
  334. #define SYSGADGET    0x8000    /* 1 = SysGadget, 0 = AppliGadget */
  335. #define SCRGADGET    0x4000    /* 1 = ScreenGadget, 0 = WindowGadget */
  336. #define GZZGADGET    0x2000    /* 1 = Gadget for GIMMEZEROZERO borders */
  337. #define REQGADGET    0x1000    /* 1 = this is a Requester Gadget */
  338. /* system gadgets */
  339. #define SIZING        0x0010
  340. #define WDRAGGING    0x0020
  341. #define SDRAGGING    0x0030
  342. #define WUPFRONT    0x0040
  343. #define SUPFRONT    0x0050
  344. #define WDOWNBACK    0x0060
  345. #define SDOWNBACK    0x0070
  346. #define CLOSE        0x0080
  347. /* application gadgets */
  348. #define BOOLGADGET    0x0001
  349. #define GADGET0002    0x0002
  350. #define PROPGADGET    0x0003
  351. #define STRGADGET    0x0004
  352.  
  353.  
  354. /* ======================================================================== */
  355. /* === BoolInfo======================================================= */
  356. /* ======================================================================== */
  357. /* This is the special data needed by an Extended Boolean Gadget
  358.  * Typically this structure will be pointed to by the Gadget field SpecialInfo
  359.  */
  360. struct BoolInfo
  361. {
  362.     USHORT Flags;    /* defined below */
  363.     UWORD  *Mask;    /* bit mask for highlighting and selecting
  364.              * mask must follow the same rules as an Image
  365.              * plane.  It's width and height are determined
  366.              * by the width and height of the gadget's 
  367.              * select box. (i.e. Gadget.Width and .Height).
  368.              */
  369.     ULONG  Reserved;    /* set to 0    */
  370. };
  371.  
  372. /* set BoolInfo.Flags to this flag bit.
  373.  * in the future, additional bits might mean more stuff hanging
  374.  * off of BoolInfo.Reserved.
  375.  */
  376. #define BOOLMASK    0x0001    /* extension is for masked gadget */
  377.  
  378. /* ======================================================================== */
  379. /* === PropInfo =========================================================== */
  380. /* ======================================================================== */
  381. /* this is the special data required by the proportional Gadget
  382.  * typically, this data will be pointed to by the Gadget variable SpecialInfo
  383.  */
  384. struct PropInfo
  385. {
  386.     USHORT Flags;    /* general purpose flag bits (see defines below) */
  387.  
  388.     /* You initialize the Pot variables before the Gadget is added to 
  389.      * the system.  Then you can look here for the current settings 
  390.      * any time, even while User is playing with this Gadget.  To 
  391.      * adjust these after the Gadget is added to the System, use 
  392.      * ModifyProp();  The Pots are the actual proportional settings, 
  393.      * where a value of zero means zero and a value of MAXPOT means 
  394.      * that the Gadget is set to its maximum setting.  
  395.      */
  396.     USHORT HorizPot;    /* 16-bit FixedPoint horizontal quantity percentage */
  397.     USHORT VertPot;    /* 16-bit FixedPoint vertical quantity percentage */
  398.  
  399.     /* the 16-bit FixedPoint Body variables describe what percentage of 
  400.      * the entire body of stuff referred to by this Gadget is actually 
  401.      * shown at one time.  This is used with the AUTOKNOB routines, 
  402.      * to adjust the size of the AUTOKNOB according to how much of 
  403.      * the data can be seen.  This is also used to decide how far 
  404.      * to advance the Pots when User hits the Container of the Gadget.    
  405.      * For instance, if you were controlling the display of a 5-line 
  406.      * Window of text with this Gadget, and there was a total of 15 
  407.      * lines that could be displayed, you would set the VertBody value to 
  408.      *       (MAXBODY / (TotalLines / DisplayLines)) = MAXBODY / 3.
  409.      * Therefore, the AUTOKNOB would fill 1/3 of the container, and 
  410.      * if User hits the Cotainer outside of the knob, the pot would 
  411.      * advance 1/3 (plus or minus) If there's no body to show, or 
  412.      * the total amount of displayable info is less than the display area, 
  413.      * set the Body variables to the MAX.  To adjust these after the 
  414.      * Gadget is added to the System, use ModifyProp();     
  415.      */
  416.     USHORT HorizBody;        /* horizontal Body */ 
  417.     USHORT VertBody;        /* vertical Body */
  418.  
  419.     /* these are the variables that Intuition sets and maintains */
  420.     USHORT CWidth;    /* Container width (with any relativity absoluted) */
  421.     USHORT CHeight;    /* Container height (with any relativity absoluted) */
  422.     USHORT HPotRes, VPotRes; /* pot increments */
  423.     USHORT LeftBorder;        /* Container borders */
  424.     USHORT TopBorder;        /* Container borders */
  425. };
  426.  
  427.  
  428. /* --- FLAG BITS ---------------------------------------------------------- */
  429. #define AUTOKNOB    0x0001    /* this flag sez:  gimme that old auto-knob */
  430. #define FREEHORIZ    0x0002    /* if set, the knob can move horizontally */
  431. #define FREEVERT    0x0004    /* if set, the knob can move vertically */
  432. #define PROPBORDERLESS    0x0008    /* if set, no border will be rendered */
  433. #define KNOBHIT        0x0100    /* set when this Knob is hit */
  434.  
  435. #define KNOBHMIN    6    /* minimum horizontal size of the Knob */
  436. #define KNOBVMIN    4    /* minimum vertical size of the Knob */
  437. #define MAXBODY        0xFFFF    /* maximum body value */
  438. #define MAXPOT        0xFFFF    /* maximum pot value */
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445. /* ======================================================================== */
  446. /* === StringInfo ========================================================= */
  447. /* ======================================================================== */
  448. /* this is the special data required by the string Gadget
  449.  * typically, this data will be pointed to by the Gadget variable SpecialInfo
  450.  */
  451. struct StringInfo
  452. {
  453.     /* you initialize these variables, and then Intuition maintains them */
  454.     UBYTE *Buffer;    /* the buffer containing the start and final string */
  455.     UBYTE *UndoBuffer;    /* optional buffer for undoing current entry */
  456.     SHORT BufferPos;    /* character position in Buffer */
  457.     SHORT MaxChars;    /* max number of chars in Buffer (including NULL) */
  458.     SHORT DispPos;    /* Buffer position of first displayed character */
  459.  
  460.     /* Intuition initializes and maintains these variables for you */
  461.     SHORT UndoPos;    /* character position in the undo buffer */
  462.     SHORT NumChars;    /* number of characters currently in Buffer */
  463.     SHORT DispCount;    /* number of whole characters visible in Container */
  464.     SHORT CLeft, CTop;    /* topleft offset of the container */
  465.     struct Layer *LayerPtr;    /* the RastPort containing this Gadget */
  466.  
  467.     /* you can initialize this variable before the gadget is submitted to
  468.      * Intuition, and then examine it later to discover what integer 
  469.      * the user has entered (if the user never plays with the gadget, 
  470.      * the value will be unchanged from your initial setting)
  471.      */
  472.     LONG LongInt;
  473.  
  474.     /* If you want this Gadget to use your own Console keymapping, you
  475.      * set the ALTKEYMAP bit in the Activation flags of the Gadget, and then
  476.      * set this variable to point to your keymap.  If you don't set the
  477.      * ALTKEYMAP, you'll get the standard ASCII keymapping.
  478.      */
  479.     struct KeyMap *AltKeyMap;
  480. };
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487. /* ======================================================================== */
  488. /* === IntuiText ========================================================== */
  489. /* ======================================================================== */
  490. /* IntuiText is a series of strings that start with a screen location
  491.  *  (always relative to the upper-left corner of something) and then the
  492.  *  text of the string.     The text is null-terminated.
  493.  */
  494. struct IntuiText
  495. {
  496.     UBYTE FrontPen, BackPen;    /* the pen numbers for the rendering */
  497.     UBYTE DrawMode;        /* the mode for rendering the text */
  498.     SHORT LeftEdge;        /* relative start location for the text */
  499.     SHORT TopEdge;        /* relative start location for the text */
  500.     struct TextAttr *ITextFont; /* if NULL, you accept the default */
  501.     UBYTE *IText;        /* pointer to null-terminated text */
  502.     struct IntuiText *NextText; /* continuation to TxWrite another text */
  503. };
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510. /* ======================================================================== */
  511. /* === Border ============================================================= */
  512. /* ======================================================================== */
  513. /* Data type Border, used for drawing a series of lines which is intended for
  514.  *  use as a border drawing, but which may, in fact, be used to render any
  515.  *  arbitrary vector shape.
  516.  *  The routine DrawBorder sets up the RastPort with the appropriate
  517.  *  variables, then does a Move to the first coordinate, then does Draws
  518.  *  to the subsequent coordinates.
  519.  *  After all the Draws are done, if NextBorder is non-zero we call DrawBorder
  520.  *  recursively
  521.  */
  522. struct Border
  523. {
  524.     SHORT LeftEdge, TopEdge;    /* initial offsets from the origin */
  525.     UBYTE FrontPen, BackPen;    /* pens numbers for rendering */
  526.     UBYTE DrawMode;        /* mode for rendering */
  527.     BYTE Count;            /* number of XY pairs */
  528.     SHORT *XY;            /* vector coordinate pairs rel to LeftTop*/
  529.     struct Border *NextBorder;    /* pointer to any other Border too */
  530. };
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537. /* ======================================================================== */
  538. /* === Image ============================================================== */
  539. /* ======================================================================== */
  540. /* This is a brief image structure for very simple transfers of 
  541.  * image data to a RastPort
  542.  */
  543. struct Image
  544. {
  545.     SHORT LeftEdge;        /* starting offset relative to some origin */
  546.     SHORT TopEdge;        /* starting offsets relative to some origin */
  547.     SHORT Width;        /* pixel size (though data is word-aligned) */
  548.     SHORT Height, Depth;    /* pixel sizes */
  549.     USHORT *ImageData;        /* pointer to the actual word-aligned bits */
  550.  
  551.     /* the PlanePick and PlaneOnOff variables work much the same way as the
  552.      * equivalent GELS Bob variables.  It's a space-saving 
  553.      * mechanism for image data.  Rather than defining the image data
  554.      * for every plane of the RastPort, you need define data only 
  555.      * for the planes that are not entirely zero or one.  As you 
  556.      * define your Imagery, you will often find that most of the planes 
  557.      * ARE just as color selectors.  For instance, if you're designing 
  558.      * a two-color Gadget to use colors two and three, and the Gadget 
  559.      * will reside in a five-plane display, bit plane zero of your 
  560.      * imagery would be all ones, bit plane one would have data that 
  561.      * describes the imagery, and bit planes two through four would be 
  562.      * all zeroes.  Using these flags allows you to avoid wasting all 
  563.      * that memory in this way:     first, you specify which planes you 
  564.      * want your data to appear in using the PlanePick variable.  For 
  565.      * each bit set in the variable, the next "plane" of your image 
  566.      * data is blitted to the display.    For each bit clear in this 
  567.      * variable, the corresponding bit in PlaneOnOff is examined.  
  568.      * If that bit is clear, a "plane" of zeroes will be used.    
  569.      * If the bit is set, ones will go out instead.  So, for our example:
  570.      *     Gadget.PlanePick = 0x02;
  571.      *     Gadget.PlaneOnOff = 0x01;
  572.      * Note that this also allows for generic Gadgets, like the 
  573.      * System Gadgets, which will work in any number of bit planes.  
  574.      * Note also that if you want an Image that is only a filled 
  575.      * rectangle, you can get this by setting PlanePick to zero 
  576.      * (pick no planes of data) and set PlaneOnOff to describe the pen 
  577.      * color of the rectangle.    
  578.      */
  579.     UBYTE PlanePick, PlaneOnOff;
  580.  
  581.     /* if the NextImage variable is not NULL, Intuition presumes that 
  582.      * it points to another Image structure with another Image to be 
  583.      * rendered
  584.      */
  585.     struct Image *NextImage;
  586. };
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593. /* ======================================================================== */
  594. /* === IntuiMessage ======================================================= */
  595. /* ======================================================================== */
  596. struct IntuiMessage
  597. {
  598.     struct Message ExecMessage;
  599.  
  600.     /* the Class bits correspond directly with the IDCMP Flags, except for the
  601.      * special bit LONELYMESSAGE (defined below)
  602.      */
  603.     ULONG Class;
  604.  
  605.     /* the Code field is for special values like MENU number */
  606.     USHORT Code;
  607.  
  608.     /* the Qualifier field is a copy of the current InputEvent's Qualifier */
  609.     USHORT Qualifier;
  610.  
  611.     /* IAddress contains particular addresses for Intuition functions, like
  612.      * the pointer to the Gadget or the Screen
  613.      */
  614.     APTR IAddress;
  615.  
  616.     /* when getting mouse movement reports, any event you get will have the
  617.      * the mouse coordinates in these variables.  the coordinates are relative
  618.      * to the upper-left corner of your Window (GIMMEZEROZERO notwithstanding)
  619.      */
  620.     SHORT MouseX, MouseY; 
  621.  
  622.     /* the time values are copies of the current system clock time.  Micros
  623.      * are in units of microseconds, Seconds in seconds.
  624.      */
  625.     ULONG Seconds, Micros;
  626.  
  627.     /* the IDCMPWindow variable will always have the address of the Window of 
  628.      * this IDCMP 
  629.      */
  630.     struct Window *IDCMPWindow;
  631.  
  632.     /* system-use variable */
  633.     struct IntuiMessage *SpecialLink;
  634. };
  635.  
  636.  
  637. /* --- IDCMP Classes ------------------------------------------------------ */
  638. #define SIZEVERIFY        0x00000001  /*    See the Programmer's Guide  */
  639. #define NEWSIZE            0x00000002  /*    See the Programmer's Guide  */
  640. #define REFRESHWINDOW        0x00000004  /*    See the Programmer's Guide  */
  641. #define MOUSEBUTTONS        0x00000008  /*    See the Programmer's Guide  */
  642. #define MOUSEMOVE        0x00000010  /*    See the Programmer's Guide  */
  643. #define GADGETDOWN        0x00000020  /*    See the Programmer's Guide  */
  644. #define GADGETUP        0x00000040  /*    See the Programmer's Guide  */
  645. #define REQSET            0x00000080  /*    See the Programmer's Guide  */
  646. #define MENUPICK        0x00000100  /*    See the Programmer's Guide  */
  647. #define CLOSEWINDOW        0x00000200  /*    See the Programmer's Guide  */
  648. #define RAWKEY            0x00000400  /*    See the Programmer's Guide  */
  649. #define REQVERIFY        0x00000800  /*    See the Programmer's Guide  */
  650. #define REQCLEAR        0x00001000  /*    See the Programmer's Guide  */
  651. #define MENUVERIFY        0x00002000  /*    See the Programmer's Guide  */
  652. #define NEWPREFS        0x00004000  /*    See the Programmer's Guide  */
  653. #define DISKINSERTED        0x00008000  /*    See the Programmer's Guide  */
  654. #define DISKREMOVED        0x00010000  /*    See the Programmer's Guide  */
  655. #define WBENCHMESSAGE        0x00020000  /*    See the Programmer's Guide  */
  656. #define ACTIVEWINDOW        0x00040000  /*    See the Programmer's Guide  */
  657. #define INACTIVEWINDOW        0x00080000  /*    See the Programmer's Guide  */
  658. #define DELTAMOVE        0x00100000  /*    See the Programmer's Guide  */
  659. #define VANILLAKEY        0x00200000  /*    See the Programmer's Guide  */
  660. #define INTUITICKS        0x00400000  /*    See the Programmer's Guide  */
  661. /* NOTEZ-BIEN:            0x80000000 is reserved for internal use      */
  662.  
  663. /* the IDCMP Flags do not use this special bit, which is cleared when
  664.  * Intuition sends its special message to the Task, and set when Intuition
  665.  * gets its Message back from the Task.     Therefore, I can check here to
  666.  * find out fast whether or not this Message is available for me to send
  667.  */
  668. #define LONELYMESSAGE    0x80000000
  669.  
  670.  
  671. /* --- IDCMP Codes -------------------------------------------------------- */
  672. /* This group of codes is for the MENUVERIFY function */
  673. #define MENUHOT        0x0001    /* IntuiWants verification or MENUCANCEL    */
  674. #define MENUCANCEL    0x0002    /* HOT Reply of this cancels Menu operation */
  675. #define MENUWAITING    0x0003    /* Intuition simply wants a ReplyMsg() ASAP */
  676.  
  677. /* These are internal tokens to represent state of verification attempts
  678.  * shown here as a clue.
  679.  */
  680. #define OKOK        MENUHOT /* guy didn't care            */
  681. #define OKABORT        0x0004    /* window rendered question moot    */
  682. #define OKCANCEL    MENUCANCEL /* window sent cancel reply        */
  683.  
  684. /* This group of codes is for the WBENCHMESSAGE messages */
  685. #define WBENCHOPEN    0x0001
  686. #define WBENCHCLOSE    0x0002
  687.  
  688.  
  689.  
  690. /* ======================================================================== */
  691. /* === Window ============================================================= */
  692. /* ======================================================================== */
  693. struct Window
  694. {
  695.     struct Window *NextWindow;        /* for the linked list in a screen */
  696.  
  697.     SHORT LeftEdge, TopEdge;        /* screen dimensions of window */
  698.     SHORT Width, Height;        /* screen dimensions of window */
  699.  
  700.     SHORT MouseY, MouseX;        /* relative to upper-left of window */
  701.  
  702.     SHORT MinWidth, MinHeight;        /* minimum sizes */
  703.     USHORT MaxWidth, MaxHeight;        /* maximum sizes */
  704.  
  705.     ULONG Flags;            /* see below for defines */
  706.  
  707.     struct Menu *MenuStrip;        /* the strip of Menu headers */
  708.  
  709.     UBYTE *Title;            /* the title text for this window */
  710.  
  711.     struct Requester *FirstRequest;    /* all active Requesters */
  712.  
  713.     struct Requester *DMRequest;    /* double-click Requester */
  714.  
  715.     SHORT ReqCount;            /* count of reqs blocking Window */
  716.  
  717.     struct Screen *WScreen;        /* this Window's Screen */
  718.     struct RastPort *RPort;        /* this Window's very own RastPort */
  719.  
  720.     /* the border variables describe the window border.     If you specify
  721.      * GIMMEZEROZERO when you open the window, then the upper-left of the
  722.      * ClipRect for this window will be upper-left of the BitMap (with correct
  723.      * offsets when in SuperBitMap mode; you MUST select GIMMEZEROZERO when
  724.      * using SuperBitMap).  If you don't specify ZeroZero, then you save
  725.      * memory (no allocation of RastPort, Layer, ClipRect and associated
  726.      * Bitmaps), but you also must offset all your writes by BorderTop,
  727.      * BorderLeft and do your own mini-clipping to prevent writing over the
  728.      * system gadgets
  729.      */
  730.     BYTE BorderLeft, BorderTop, BorderRight, BorderBottom;
  731.     struct RastPort *BorderRPort;
  732.  
  733.  
  734.     /* You supply a linked-list of Gadgets for your Window.
  735.      * This list DOES NOT include system gadgets.  You get the standard
  736.      * window system gadgets by setting flag-bits in the variable Flags (see
  737.      * the bit definitions below)
  738.      */
  739.     struct Gadget *FirstGadget;
  740.  
  741.     /* these are for opening/closing the windows */
  742.     struct Window *Parent, *Descendant;
  743.  
  744.     /* sprite data information for your own Pointer
  745.      * set these AFTER you Open the Window by calling SetPointer()
  746.      */
  747.     USHORT *Pointer;    /* sprite data */
  748.     BYTE PtrHeight;    /* sprite height (not including sprite padding) */
  749.     BYTE PtrWidth;    /* sprite width (must be less than or equal to 16) */
  750.     BYTE XOffset, YOffset;    /* sprite offsets */
  751.  
  752.     /* the IDCMP Flags and User's and Intuition's Message Ports */
  753.     ULONG IDCMPFlags;    /* User-selected flags */
  754.     struct MsgPort *UserPort, *WindowPort;
  755.     struct IntuiMessage *MessageKey;
  756.  
  757.     UBYTE DetailPen, BlockPen;    /* for bar/border/gadget rendering */
  758.  
  759.     /* the CheckMark is a pointer to the imagery that will be used when 
  760.      * rendering MenuItems of this Window that want to be checkmarked
  761.      * if this is equal to NULL, you'll get the default imagery
  762.      */
  763.     struct Image *CheckMark;
  764.  
  765.     UBYTE *ScreenTitle; /* if non-null, Screen title when Window is active */
  766.  
  767.     /* These variables have the mouse coordinates relative to the 
  768.      * inner-Window of GIMMEZEROZERO Windows.  This is compared with the
  769.      * MouseX and MouseY variables, which contain the mouse coordinates
  770.      * relative to the upper-left corner of the Window, GIMMEZEROZERO
  771.      * notwithstanding
  772.      */
  773.     SHORT GZZMouseX;
  774.     SHORT GZZMouseY;
  775.     /* these variables contain the width and height of the inner-Window of
  776.      * GIMMEZEROZERO Windows
  777.      */
  778.     SHORT GZZWidth;
  779.     SHORT GZZHeight;
  780.  
  781.     UBYTE *ExtData;
  782.  
  783.     BYTE *UserData;    /* general-purpose pointer to User data extension */
  784.  
  785.     /** jimm: NEW: 11/18/85: this pointer keeps a duplicate of what 
  786.      * Window.RPort->Layer is _supposed_ to be pointing at
  787.      */
  788.     struct Layer *WLayer;
  789.  
  790.     /* jimm: NEW 1.2: need to keep track of the font that
  791.      * OpenWindow opened, in case user SetFont's into RastPort
  792.      */
  793.     struct TextFont *IFont;
  794. };
  795.  
  796.  
  797. /* --- FLAGS REQUESTED (NOT DIRECTLY SET THOUGH) BY THE APPLIPROG --------- */
  798. #define WINDOWSIZING    0x0001      /* include sizing system-gadget? */
  799. #define WINDOWDRAG    0x0002      /* include dragging system-gadget? */
  800. #define WINDOWDEPTH    0x0004      /* include depth arrangement gadget? */
  801. #define WINDOWCLOSE    0x0008      /* include close-box system-gadget? */
  802.  
  803. #define SIZEBRIGHT    0x0010    /* size gadget uses right border */
  804. #define SIZEBBOTTOM    0x0020    /* size gadget uses bottom border */
  805.  
  806. /* --- refresh modes ------------------------------------------------------ */
  807. /* combinations of the REFRESHBITS select the refresh type */
  808. #define REFRESHBITS    0x00C0
  809. #define SMART_REFRESH    0x0000
  810. #define SIMPLE_REFRESH    0x0040
  811. #define SUPER_BITMAP    0x0080
  812. #define OTHER_REFRESH    0x00C0
  813.  
  814. #define BACKDROP    0x0100    /* this is an ever-popular BACKDROP window */
  815.  
  816. #define REPORTMOUSE    0x0200    /* set this to hear about every mouse move */
  817.  
  818. #define GIMMEZEROZERO    0x0400    /* make extra border stuff */
  819.  
  820. #define BORDERLESS    0x0800    /* set this to get a Window sans border */
  821.  
  822. #define ACTIVATE    0x1000    /* when Window opens, it's the Active one */
  823.  
  824. /* FLAGS SET BY INTUITION */
  825. #define WINDOWACTIVE  0x2000    /* this window is the active one */
  826. #define INREQUEST     0x4000    /* this window is in request mode */
  827. #define MENUSTATE     0x8000    /* this Window is active with its Menus on */
  828.  
  829. /* --- Other User Flags --------------------------------------------------- */
  830. #define RMBTRAP        0x00010000    /* Catch RMB events for your own */
  831. #define NOCAREREFRESH    0x00020000    /* not to be bothered with REFRESH */
  832.  
  833.  
  834. /* --- Other Intuition Flags ---------------------------------------------- */
  835. #define WINDOWREFRESH    0x01000000    /* Window is currently refreshing */
  836. #define WBENCHWINDOW    0x02000000    /* WorkBench tool ONLY Window */
  837. #define WINDOWTICKED    0x04000000    /* only one timer tick at a time */
  838.  
  839. #define SUPER_UNUSED    0xFCFC0000    /* bits of Flag unused yet */
  840.  
  841.  
  842. /* --- see struct IntuiMessage for the IDCMP Flag definitions ------------- */
  843.  
  844.  
  845.  
  846.  
  847. /* ======================================================================== */
  848. /* === NewWindow ========================================================== */
  849. /* ======================================================================== */
  850. struct NewWindow
  851. {
  852.     SHORT LeftEdge, TopEdge;        /* screen dimensions of window */
  853.     SHORT Width, Height;        /* screen dimensions of window */
  854.  
  855.     UBYTE DetailPen, BlockPen;        /* for bar/border/gadget rendering */
  856.  
  857.     ULONG IDCMPFlags;            /* User-selected IDCMP flags */
  858.  
  859.     ULONG Flags;            /* see Window struct for defines */
  860.  
  861.     /* You supply a linked-list of Gadgets for your Window.
  862.      *    This list DOES NOT include system Gadgets.  You get the standard
  863.      *    system Window Gadgets by setting flag-bits in the variable Flags (see
  864.      *    the bit definitions under the Window structure definition)
  865.      */
  866.     struct Gadget *FirstGadget;
  867.  
  868.     /* the CheckMark is a pointer to the imagery that will be used when 
  869.      * rendering MenuItems of this Window that want to be checkmarked
  870.      * if this is equal to NULL, you'll get the default imagery
  871.      */
  872.     struct Image *CheckMark;
  873.  
  874.     UBYTE *Title;              /* the title text for this window */
  875.     
  876.     /* the Screen pointer is used only if you've defined a CUSTOMSCREEN and
  877.      * want this Window to open in it.    If so, you pass the address of the
  878.      * Custom Screen structure in this variable.  Otherwise, this variable
  879.      * is ignored and doesn't have to be initialized.
  880.      */
  881.     struct Screen *Screen;
  882.     
  883.     /* SUPER_BITMAP Window?  If so, put the address of your BitMap structure
  884.      * in this variable.  If not, this variable is ignored and doesn't have 
  885.      * to be initialized
  886.      */
  887.     struct BitMap *BitMap;
  888.  
  889.     /* the values describe the minimum and maximum sizes of your Windows.
  890.      * these matter only if you've chosen the WINDOWSIZING Gadget option,
  891.      * which means that you want to let the User to change the size of 
  892.      * this Window.  You describe the minimum and maximum sizes that the
  893.      * Window can grow by setting these variables.  You can initialize
  894.      * any one these to zero, which will mean that you want to duplicate
  895.      * the setting for that dimension (if MinWidth == 0, MinWidth will be
  896.      * set to the opening Width of the Window).
  897.      * You can change these settings later using SetWindowLimits().
  898.      * If you haven't asked for a SIZING Gadget, you don't have to
  899.      * initialize any of these variables.
  900.      */
  901.     SHORT MinWidth, MinHeight;         /* minimums */
  902.     USHORT MaxWidth, MaxHeight;          /* maximums */
  903.  
  904.     /* the type variable describes the Screen in which you want this Window to
  905.      * open.  The type value can either be CUSTOMSCREEN or one of the
  906.      * system standard Screen Types such as WBENCHSCREEN.  See the
  907.      * type definitions under the Screen structure
  908.      */
  909.     USHORT Type;
  910. };
  911.  
  912.  
  913. #ifndef INTUITION_SCREENS_H
  914. #include "intuition/screens.h"
  915. #endif
  916.  
  917. #ifndef INTUITION_PREFERENCES_H
  918. #include "intuition/preferences.h"
  919. #endif
  920.  
  921. /* ======================================================================== */
  922. /* === Remember =========================================================== */
  923. /* ======================================================================== */
  924. /* this structure is used for remembering what memory has been allocated to
  925.  * date by a given routine, so that a premature abort or systematic exit
  926.  * can deallocate memory cleanly, easily, and completely
  927.  */
  928. struct Remember
  929. {
  930.     struct Remember *NextRemember;
  931.     ULONG RememberSize;
  932.     UBYTE *Memory;
  933. };
  934.  
  935.  
  936.  
  937.  
  938.  
  939. /* ======================================================================== */
  940. /* === Miscellaneous ====================================================== */
  941. /* ======================================================================== */
  942.  
  943. /* = MACROS ============================================================== */
  944. #define MENUNUM(n) (n & 0x1F)
  945. #define ITEMNUM(n) ((n >> 5) & 0x003F)
  946. #define SUBNUM(n) ((n >> 11) & 0x001F)
  947.  
  948. #define SHIFTMENU(n) (n & 0x1F)
  949. #define SHIFTITEM(n) ((n & 0x3F) << 5)
  950. #define SHIFTSUB(n) ((n & 0x1F) << 11)
  951.  
  952.  
  953. #define SRBNUM(n)    (0x08 - (n >> 4))    /* SerRWBits -> read bits per char */
  954. #define SWBNUM(n)    (0x08 - (n & 0x0F))/* SerRWBits -> write bits per chr */
  955. #define SSBNUM(n)    (0x01 + (n >> 4))    /* SerStopBuf -> stop bits per chr */
  956. #define SPARNUM(n)   (n >> 4)        /* SerParShk -> parity setting      */
  957. #define SHAKNUM(n)   (n & 0x0F)        /* SerParShk -> handshake mode      */
  958.  
  959.  
  960. /* = MENU STUFF =========================================================== */
  961. #define NOMENU 0x001F
  962. #define NOITEM 0x003F
  963. #define NOSUB  0x001F
  964. #define MENUNULL 0xFFFF
  965.  
  966.  
  967. /* = =RJ='s peculiarities ================================================= */
  968. #define FOREVER for(;;)
  969. #define SIGN(x) ( ((x) > 0) - ((x) < 0) )
  970. #define NOT !
  971.  
  972. /* these defines are for the COMMSEQ and CHECKIT menu stuff.  If CHECKIT,
  973.  * I'll use a generic Width (for all resolutions) for the CheckMark.
  974.  * If COMMSEQ, likewise I'll use this generic stuff
  975.  */
  976. #define CHECKWIDTH    19
  977. #define COMMWIDTH    27
  978. #define LOWCHECKWIDTH    13
  979. #define LOWCOMMWIDTH    16
  980.  
  981.  
  982. /* these are the AlertNumber defines.  if you are calling DisplayAlert()
  983.  * the AlertNumber you supply must have the ALERT_TYPE bits set to one
  984.  * of these patterns
  985.  */
  986. #define ALERT_TYPE    0x80000000
  987. #define RECOVERY_ALERT    0x00000000    /* the system can recover from this */
  988. #define DEADEND_ALERT    0x80000000    /* no recovery possible, this is it */
  989.  
  990.  
  991. /* When you're defining IntuiText for the Positive and Negative Gadgets 
  992.  * created by a call to AutoRequest(), these defines will get you 
  993.  * reasonable-looking text.  The only field without a define is the IText
  994.  * field; you decide what text goes with the Gadget
  995.  */
  996. #define AUTOFRONTPEN    0
  997. #define AUTOBACKPEN    1
  998. #define AUTODRAWMODE    JAM2
  999. #define AUTOLEFTEDGE    6
  1000. #define AUTOTOPEDGE    3
  1001. #define AUTOITEXTFONT    NULL
  1002. #define AUTONEXTTEXT    NULL
  1003.  
  1004.  
  1005. /* --- RAWMOUSE Codes and Qualifiers (Console OR IDCMP) ------------------- */
  1006. #define SELECTUP    (IECODE_LBUTTON | IECODE_UP_PREFIX)
  1007. #define SELECTDOWN    (IECODE_LBUTTON)
  1008. #define MENUUP        (IECODE_RBUTTON | IECODE_UP_PREFIX)
  1009. #define MENUDOWN    (IECODE_RBUTTON)
  1010. #define ALTLEFT        (IEQUALIFIER_LALT)
  1011. #define ALTRIGHT    (IEQUALIFIER_RALT)
  1012. #define AMIGALEFT    (IEQUALIFIER_LCOMMAND)
  1013. #define AMIGARIGHT    (IEQUALIFIER_RCOMMAND)
  1014. #define AMIGAKEYS    (AMIGALEFT | AMIGARIGHT)
  1015.  
  1016. #define CURSORUP    0x4C
  1017. #define CURSORLEFT    0x4F
  1018. #define CURSORRIGHT    0x4E
  1019. #define CURSORDOWN    0x4D
  1020. #define KEYCODE_Q    0x10
  1021. #define KEYCODE_X    0x32
  1022. #define KEYCODE_N    0x36
  1023. #define KEYCODE_M    0x37
  1024. #define KEYCODE_V    0x34
  1025. #define KEYCODE_B    0x35
  1026.  
  1027. #endif    /* INTUITION_INTUITION_H */
  1028.