workbench/libs/gadtools/gadtools_intern.h

   1 #ifndef GADTOOLS_INTERN_H
   2 #define GADTOOLS_INTERN_H
   3
   4 /*
   5     Copyright © 1995-2006, The AROS Development Team. All rights reserved.
   6     $Id$
   7
   8     Desc: Internal definitions for gadtools.library.
   9     Lang: english
  10 */
  11
  12 #ifndef EXEC_LIBRARIES_H
  13 #   include <exec/libraries.h>
  14 #endif
  15 #ifndef EXEC_SEMAPHORES_H
  16 #   include <exec/semaphores.h>
  17 #endif
  18 #ifndef DOS_DOS_H
  19 #   include <dos/dos.h>
  20 #endif
  21 #ifndef PROTO_GRAPHICS_H
  22 #   include <proto/graphics.h>
  23 #endif
  24 #ifndef GRAPHICS_GFXBASE_H
  25 #   include <graphics/gfxbase.h>
  26 #endif
  27 #ifndef PROTO_INTUITION_H
  28 #   include <proto/intuition.h>
  29 #endif
  30 #ifndef INTUITION_CLASSES_H
  31 #   include <intuition/classes.h>
  32 #endif
  33 #ifndef INTUITION_INTUITIONBASE_H
  34 #   include <intuition/intuitionbase.h>
  35 #endif
  36 #ifndef INTUITION_SCREENS_H
  37 #   include <intuition/screens.h>
  38 #endif
  39 #ifndef PROTO_UTILITY_H
  40 #   include <proto/utility.h>
  41 #endif
  42 #ifndef LIBRARIES_GADTOOLS_H
  43 #   include <libraries/gadtools.h>
  44 #endif
  45 #ifndef GADGETS_AROSMX_H
  46 #   include <gadgets/arosmx.h>
  47 #endif
  48
  49 /* Needed for aros_print_not_implemented macro */
  50 #include <aros/debug.h>
  51 #include <aros/libcall.h>
  52 #include <aros/asmcall.h>
  53
  54 /****************************************************************************************/
  55
  56 struct VisualInfo;
  57
  58 /* Some external stuff (gadtools_init.c) */
  59 struct GadToolsBase_intern; /* prerefrence */
  60
  61 /* Internal prototypes */
  62 struct IntuiText *makeitext(struct GadToolsBase_intern *GadToolsBase,
  63                             struct NewGadget *ng,
  64                             struct TagItem *taglist);
  65 void freeitext(struct GadToolsBase_intern *GadToolsBase,
  66                struct IntuiText *itext);
  67
  68 BOOL renderlabel(struct GadToolsBase_intern *GadToolsBase,
  69                  struct Gadget *gad, struct RastPort *rport, LONG labelplace);
  70 void DoDisabledPattern(struct RastPort *rp, WORD x1, WORD y1, WORD x2, WORD y2,
  71                        WORD pen, struct GadToolsBase_intern *GadToolsBase);
  72
  73 /****************************************************************************************/
  74
  75 struct Gadget *makebutton(struct GadToolsBase_intern *GadToolsBase,
  76                           struct TagItem stdgadtags[],
  77                           struct VisualInfo *vi,
  78                           struct TagItem *taglist);
  79
  80 struct Gadget *makecheckbox(struct GadToolsBase_intern *GadToolsBase,
  81                             struct TagItem stdgadtags[],
  82                             struct VisualInfo *vi,
  83                             struct TagItem *taglist);
  84
  85 struct Gadget *makecycle(struct GadToolsBase_intern *GadToolsBase,
  86                          struct TagItem stdgadtags[],
  87                          struct VisualInfo *vi,
  88                          struct TextAttr *tattr,
  89                          struct TagItem *taglist);
  90
  91 struct Gadget *makemx(struct GadToolsBase_intern *GadToolsBase,
  92                       struct TagItem stdgadtags[],
  93                       struct VisualInfo *vi,
  94                       struct TextAttr *tattr,
  95                       struct TagItem *taglist);
  96
  97 struct Gadget *makepalette(struct GadToolsBase_intern *GadToolsBase,
  98                       struct TagItem stdgadtags[],
  99                       struct VisualInfo *vi,
 100                       struct TagItem *taglist);
 101
 102 struct Gadget *maketext(struct GadToolsBase_intern *GadToolsBase,
 103                         struct TagItem stdgadtags[],
 104                         struct VisualInfo *vi,
 105                         struct TextAttr *tattr,
 106                         struct TagItem *taglist);
 107
 108 struct Gadget *makenumber(struct GadToolsBase_intern *GadToolsBase,
 109                           struct TagItem stdgadtags[],
 110                           struct VisualInfo *vi,
 111                           struct TextAttr *tattr,
 112                           struct TagItem *taglist);
 113
 114
 115 struct Gadget *makeslider(struct GadToolsBase_intern *GadToolsBase,
 116                           struct TagItem stdgadtags[],
 117                           struct VisualInfo *vi,
 118                           struct TextAttr *tattr,
 119                           struct TagItem *taglist);
 120
 121 struct Gadget *makescroller(struct GadToolsBase_intern *GadToolsBase,
 122                           struct TagItem stdgadtags[],
 123                           struct VisualInfo *vi,
 124                           struct TagItem *taglist);
 125
 126 struct Gadget *makestring(struct GadToolsBase_intern *GadToolsBase,
 127                           struct TagItem stdgadtags[],
 128                           struct VisualInfo *vi,
 129                           struct TextAttr *tattr,
 130                           struct TagItem *taglist);
 131
 132 struct Gadget *makeinteger(struct GadToolsBase_intern *GadToolsBase,
 133                           struct TagItem stdgadtags[],
 134                           struct VisualInfo *vi,
 135                           struct TextAttr *tattr,
 136                           struct TagItem *taglist);
 137
 138 struct Gadget *makelistview(struct GadToolsBase_intern *GadToolsBase,
 139                           struct TagItem stdgadtags[],
 140                           struct VisualInfo *vi,
 141                           struct TextAttr *tattr,
 142                           struct TagItem *taglist);
 143
 144 struct Gadget *makegeneric(struct GadToolsBase_intern *GadToolsBase,
 145                           struct TagItem stdgadtags[],
 146                           struct VisualInfo *vi,
 147                           struct TextAttr *tattr,
 148                           struct TagItem *taglist);
 149
 150 /****************************************************************************************/
 151
 152 /* Tags for the private gadtools classes */
 153
 154 #define GT_Dummy                        (TAG_USER)
 155
 156 #define GTA_Text_DispFunc               (GT_Dummy + 1)
 157 #define GTA_Text_Format                 (GT_Dummy + 2)
 158 #define GTA_Arrow_Type                  (GT_Dummy + 3)
 159 #define GTA_Arrow_Pulse                 (GT_Dummy + 4)
 160 #define GTA_Arrow_Scroller              (GT_Dummy + 5)
 161 #define GTA_Scroller_Dec                (GT_Dummy + 6)
 162 #define GTA_Scroller_Inc                (GT_Dummy + 7)
 163 #define GTA_Listview_Scroller           (GT_Dummy + 8)
 164 #define GTA_GadgetKind                  (GT_Dummy + 9)
 165 #define GTA_ChildGadgetKind             (GT_Dummy + 10)
 166 #define GTA_Scroller_ScrollerKind       (GT_Dummy + 11)
 167 #define GTA_Scroller_ArrowKind          (GT_Dummy + 12)
 168 #define GTA_Scroller_Arrow1             (GT_Dummy + 13)
 169 #define GTA_Scroller_Arrow2             (GT_Dummy + 14)
 170
 171 /****************************************************************************************/
 172
 173 /* private gadget kinds */
 174
 175 #define _ARROW_KIND                     100
 176
 177 /****************************************************************************************/
 178
 179 /* Some listview specific constants */
 180 #define LV_BORDER_X                     4
 181 #define LV_BORDER_Y                     3
 182
 183 #define LV_DEF_INTERNAL_SPACING         0
 184
 185 /****************************************************************************************/
 186
 187 /* Private MX tags */
 188
 189 #define GTMX_TickLabelPlace AROSMX_TickLabelPlace
 190 #define GTMX_TickHeight     AROSMX_TickHeight
 191
 192 /****************************************************************************************/
 193
 194 #define NEWMENUCODE     TRUE
 195
 196 #if NEWMENUCODE
 197 struct Menu * makemenutitle(struct NewMenu * newmenu,
 198                             UBYTE               **MyMenuMemPtr,
 199                             struct TagItem * taglist);
 200
 201 struct MenuItem * makemenuitem(struct NewMenu * newmenu,
 202                             UBYTE               **MyMenuMemPtr,
 203                             struct Image        ***MyBarTablePtr,
 204                                BOOL is_image,
 205                                struct TagItem * taglist,
 206                                struct GadToolsBase_intern * GadToolsBase);
 207
 208 ULONG   getmenutitlesize(struct NewMenu * newmenu,
 209                           struct TagItem * taglist);
 210 ULONG   getmenuitemsize(struct NewMenu * newmenu,
 211                                    BOOL is_image,
 212                                    struct TagItem * taglist,
 213                                    struct GadToolsBase_intern * GadToolsBase);
 214
 215 #else
 216
 217 struct Menu * makemenutitle(struct NewMenu * newmenu,
 218                             struct TagItem * taglist);
 219
 220 struct MenuItem * makemenuitem(struct NewMenu * newmenu,
 221                                BOOL is_image,
 222                                struct TagItem * taglist,
 223                                struct GadToolsBase_intern * GadToolsBase);
 224 #endif
 225 void appendmenu(struct Menu * firstmenu,
 226                 struct Menu * lastmenu);
 227
 228 void appenditem(struct Menu * curmenu,
 229                 struct MenuItem * item);
 230
 231 void appendsubitem(struct MenuItem * curitem,
 232                    struct MenuItem * subitem);
 233
 234 void freeitems(struct MenuItem * mi, struct GadToolsBase_intern * GadToolsBase);
 235
 236 BOOL layoutmenuitems(struct MenuItem * menuitem,
 237                      struct VisualInfo * vi,
 238                      struct TagItem * taglist,
 239                      struct GadToolsBase_intern * GadToolsBase);
 240
 241 BOOL layoutsubitems(struct MenuItem * motheritem,
 242                     struct VisualInfo * vi,
 243                     struct TagItem * taglist,
 244                     struct GadToolsBase_intern * GadToolsBase);
 245
 246 BOOL is_menubarlabelclass_image(struct Image *im,
 247                                 struct GadToolsBase_intern *GadToolsBase);
 248
 249 /****************************************************************************************/
 250
 251 struct GadToolsBase_intern
 252 {
 253     struct Library                lib;
 254
 255     Class                       * buttonclass;
 256     Class                       * textclass;
 257     Class                       * sliderclass;
 258     Class                       * scrollerclass;
 259     Class                       * arrowclass;
 260     Class                       * stringclass;
 261     Class                       * listviewclass;
 262     Class                       * checkboxclass;
 263     Class                       * cycleclass;
 264     Class                       * mxclass;
 265     Class                       * paletteclass;
 266
 267     /* Semaphore to protect the bevel object. */
 268     struct SignalSemaphore      bevelsema;
 269     /* Actually an Object *. The image used for bevel boxes. */
 270     struct Image                * bevel;
 271
 272     /* RenderHook for GTListView class */
 273     struct Hook                 lv_RenderHook;
 274 };
 275
 276 /* extended intuimsg as used by GT_GetIMsg, GT_FilterIMsg, ... */
 277
 278 struct GT_IntuiMessage
 279 {
 280     struct ExtIntuiMessage      imsg;
 281     struct IntuiMessage         * origmsg;
 282     BOOL                        wasalloced;
 283 };
 284
 285 #define VI(x)                   ((struct VisualInfo *)x)
 286
 287 struct VisualInfo
 288 {
 289     struct Screen               * vi_screen;
 290     struct DrawInfo             * vi_dri;
 291 };
 292
 293 /* dummy gadget created by CreateContext */
 294
 295 struct GT_ContextGadget
 296 {
 297     struct ExtGadget            gad;
 298     IPTR                        magic;
 299     IPTR                        magic2;
 300     struct GT_IntuiMessage      gtmsg;
 301     struct Gadget               *activegadget;
 302     struct Gadget               *parentgadget;
 303     IPTR                        gadget_value;
 304     IPTR                        gadgetkind;
 305     IPTR                        childgadgetkind;
 306     IPTR                        childinfo;
 307     ULONG                       getattrtag;
 308     ULONG                       setattrtag;
 309     WORD                        scrollticker;
 310 };
 311
 312 struct GT_GenericGadget
 313 {
 314     struct ExtGadget            gad;
 315     IPTR                        magic;
 316     IPTR                        magic2;
 317     struct IntuiText            *itext;
 318 };
 319
 320 /****************************************************************************************/
 321
 322 #define CONTEXT_MAGIC           ((IPTR)0x11223344)
 323 #define CONTEXT_MAGIC2          ((IPTR)0x44332211)
 324
 325 #define GENERIC_MAGIC           ((IPTR)0x11335577)
 326 #define GENERIC_MAGIC2          ((IPTR)0x77553311)
 327
 328 /****************************************************************************************/
 329
 330 #define TAG_Left                0
 331 #define TAG_Top                 1
 332 #define TAG_Width               2
 333 #define TAG_Height              3
 334 #define TAG_IText               4
 335 #define TAG_LabelPlace          5
 336 #define TAG_Previous            6
 337 #define TAG_ID                  7
 338 #define TAG_DrawInfo            8
 339 #define TAG_UserData            9
 340 #define TAG_Num                 10
 341
 342
 343 #define TAG_Menu                0
 344 #define TAG_TextAttr            1
 345 #define TAG_NewLookMenus        2
 346 #define TAG_CheckMark           3
 347 #define TAG_AmigaKey            4
 348 #define TAG_FrontPen            5
 349
 350 #define BORDERPROPSPACINGX      4
 351 #ifdef __MORPHOS__
 352 #define BORDERPROPSPACINGY      2
 353 #else
 354 #define BORDERPROPSPACINGY      4
 355 #endif
 356
 357 #define BORDERSTRINGSPACINGX    4
 358 #define BORDERSTRINGSPACINGY    2
 359
 360 #define LV_SHOWSELECTED_NONE    ((struct Gadget *)~0)
 361
 362 /****************************************************************************************/
 363
 364 #define GTB(gtb)                ((struct GadToolsBase_intern *)gtb)
 365
 366 #ifdef __MORPHOS__
 367 #define DeinitRastPort(x) ((void)0)
 368
 369 #define DoMethod(MyObject, tags...) \
 370         ({ULONG _tags[] = { tags }; DoMethodA((MyObject), (APTR)_tags);})
 371
 372 #define CoerceMethod(MyClass, MyObject, tags...) \
 373         ({ULONG _tags[] = { tags }; CoerceMethodA((MyClass), (MyObject), (APTR)_tags);})
 374
 375 #define DoSuperMethod(MyClass, MyObject, tags...) \
 376         ({ULONG _tags[] = { tags }; DoSuperMethodA((MyClass), (MyObject), (APTR)_tags);})
 377
 378 /********************************************************************************/
 379 /* imageclass.h AROS extensions */
 380
 381 #define SYSIA_WithBorder  IA_FGPen      /* default: TRUE */
 382 #define SYSIA_Style       IA_BGPen      /* default: SYSISTYLE_NORMAL */
 383
 384 #define SYSISTYLE_NORMAL   0
 385 #define SYSISTYLE_GADTOOLS 1            /* to get arrow images in gadtools look */
 386
 387 /********************************************************************************/
 388 /* gadgetclass.h AROS extenstions */
 389
 390 /* This method is invoked to learn about the sizing requirements of your class,
 391    before an object is created. This is AROS specific. */
 392 #define GM_DOMAIN 7
 393 struct gpDomain
 394 {
 395     STACKED ULONG          MethodID;   /* GM_DOMAIN */
 396     STACKED struct GadgetInfo * gpd_GInfo;  /* see <intuition/cghooks.h> */
 397     STACKED struct RastPort   * gpd_RPort;  /* RastPort to calculate dimensions for. */
 398     STACKED LONG           gpd_Which;  /* see below */
 399     STACKED struct IBox         gpd_Domain; /* Resulting domain. */
 400     STACKED struct TagItem    * gpd_Attrs;  /* Additional attributes. None defined,
 401                                        yet. */
 402 };
 403
 404 /********************************************************************************/
 405
 406 /* gpd_Which */
 407 #define GDOMAIN_MINIMUM 0 /* Calculate minimum size. */
 408 #define GDOMAIN_NOMINAL 1 /* Calculate nominal size. */
 409 #define GDOMAIN_MAXIMUM 2 /* Calculate maximum size. */
 410
 411 /********************************************************************************/
 412
 413   /* [IS.] (struct TextAttr *) TextAttr structure (see <graphics/text.h>) to
 414      use for gadget rendering. This attribute is not directly supported by
 415      GadgetClass. */
 416 #define GA_TextAttr      (GA_Dummy + 40)
 417
 418   /* [I..] (LONG) Choose the placing of the label. GadgetClass does not support
 419      this directly. Its subclasses have to take care of that. For possible
 420      values see below. */
 421 #define GA_LabelPlace    (GA_Dummy + 100)
 422
 423
 424 /* Placetext values for GA_LabelPlace. */
 425 #define GV_LabelPlace_In    1
 426 #define GV_LabelPlace_Left  2
 427 #define GV_LabelPlace_Right 3
 428 #define GV_LabelPlace_Above 4
 429 #define GV_LabelPlace_Below 5
 430
 431 /********************************************************************************/
 432
 433 #define MENUBARLABELCLASS "menubarlabelclass"
 434
 435 #define GTYP_GADTOOLS 0x0100
 436
 437 #define CORRECT_LISTVIEWHEIGHT  TRUE
 438
 439 #else /*MorphOS*/
 440
 441 #define CORRECT_LISTVIEWHEIGHT  FALSE
 442
 443 #endif
 444
 445 #define DEBUG_CREATECONTEXT(x)  ;
 446 #define DEBUG_CREATEGADGETA(x)  ;
 447 #define DEBUG_CREATEMENUSA(x)   ;
 448 #define DEBUG_CREATELISTVIEW(x) ;
 449 #define DEBUG_CREATESCROLLER(x) ;
 450 #define DEBUG_FREEGADGETS(x)    ;
 451 #define DEBUG_DUMPMENUS(x)      ;
 452 #define DEBUG_ALLOCMENUS(x)     ;
 453 #define DEBUG_FREEMENUS(x)      ;
 454 #define DEBUG_REFRESHWINDOW(x)  ;
 455
 456 void    DumpMenu(struct Menu *menu);
 457
 458 /* Structures for the class private data */
 459
 460 /* GTButton class */
 461 struct ButtonData
 462 {
 463     struct DrawInfo     *dri;
 464     struct Image        *frame;
 465 };
 466
 467 /* GTText class */
 468 struct TextData
 469 {
 470     struct DrawInfo     *dri;
 471     Object              *frame;
 472     STRPTR              format;
 473     IPTR                toprint;
 474     UBYTE               frontpen;
 475     UBYTE               backpen;
 476     UBYTE               justification;
 477     UBYTE               flags;
 478     struct TextFont     *font;
 479     UWORD               maxnumberlength;
 480     WORD                gadgetkind;
 481     LONG                (*dispfunc)(struct Gadget *, WORD);
 482     UBYTE               labelplace;
 483
 484 };
 485
 486 /* GTSlider class */
 487 struct SliderData
 488 {
 489     Object      *frame;
 490     WORD        min;
 491     WORD        max;
 492     WORD        level;
 493     WORD        freedom;
 494     UBYTE       labelplace;
 495 };
 496
 497 /* GTScroller class */
 498 struct ScrollerData
 499 {
 500     Object              *frame;
 501     struct Gadget       *arrow1;
 502     struct Gadget       *arrow2;
 503     WORD                gadgetkind;
 504     UBYTE               labelplace;
 505 };
 506
 507 /* GTArrow class */
 508 struct ArrowData
 509 {
 510     Object      *arrowimage;
 511     Object      *frame;
 512     Object      *scroller;
 513     WORD        gadgetkind;
 514     WORD        arrowtype;
 515 };
 516
 517 /* GTString class */
 518 struct StringData
 519 {
 520     Object              *frame;
 521     struct TextFont     *font;
 522     WORD                gadgetkind;
 523     UBYTE               labelplace;
 524 };
 525
 526 /* GTListView class */
 527 struct LVData
 528 {
 529     struct Hook         *ld_CallBack;
 530     struct List         *ld_Labels;
 531     struct DrawInfo     *ld_Dri;
 532     struct TextFont     *ld_Font;
 533     Object              *ld_Frame;
 534     Object              *ld_Scroller;
 535     struct Gadget       *ld_ShowSelected;
 536     WORD                ld_Top;
 537     WORD                ld_Selected;
 538     WORD                ld_Spacing;
 539     WORD                ld_ItemHeight;
 540
 541     /* The number of first damaged entry, counting from first visible.
 542     ** A value o -1 means "nothing has to be redrawn"
 543     */
 544     WORD                ld_FirstDamaged;
 545     UWORD               ld_NumDamaged;
 546
 547     /* Number of entries the listview should scroll in GM_RENDER.
 548     ** Negative valu means scroll up.
 549     */
 550     WORD                ld_ScrollEntries;
 551     WORD                ld_NumEntries;
 552
 553     UBYTE               ld_Flags;
 554     UBYTE               ld_LabelPlace;
 555 };
 556
 557 /* GTCheckBox class */
 558 struct CheckBoxData
 559 {
 560     struct DrawInfo *dri;
 561     LONG            labelplace;
 562     LONG            flags;
 563 };
 564
 565 /* GTCycle class */
 566 struct CycleData
 567 {
 568     struct TextFont *font;
 569     STRPTR          *labels;
 570     UWORD           active;
 571     UWORD           numlabels;
 572     UWORD           labelplace;
 573 };
 574
 575 /* GTMX class */
 576 struct MXData
 577 {
 578     struct DrawInfo     *dri;
 579     struct TextAttr     *tattr;
 580     struct Image        *mximage;
 581     struct TextFont     *font;
 582     struct Rectangle    bbox;
 583     STRPTR              *labels;
 584     ULONG               active, newactive;          /* The active tick and the tick to be activated */
 585     ULONG               numlabels;                  /* The number of labels */
 586     LONG                labelplace, ticklabelplace;
 587     UWORD               fontheight;
 588     UWORD               spacing;
 589     UWORD               maxtextwidth;
 590 };
 591
 592 /* GTPalette class */
 593 struct PaletteData
 594 {
 595     UWORD               pd_NumColors;
 596     UBYTE               *pd_ColorTable;
 597     UBYTE               pd_Color;
 598     /* For state info, to know what selected entry to delete in GM_RENDER, GREDRAW_UPDATE */
 599     UBYTE               pd_OldColor;
 600
 601     UBYTE               pd_ColorOffset;
 602     UWORD               pd_IndWidth;
 603     UWORD               pd_IndHeight;
 604
 605     struct IBox         pd_GadgetBox;    /* Box surrounding whole palette       */
 606     struct IBox         pd_PaletteBox;   /* Box surrounding palette             */
 607     struct IBox         pd_IndicatorBox; /* Box surrounding indicator           */
 608
 609     UWORD               pd_ColWidth;
 610     UWORD               pd_RowHeight;
 611     UBYTE               pd_NumCols;
 612     UBYTE               pd_NumRows;
 613
 614     /* This one is used to backup pd_Color if left is clicked. This
 615     ** way the old state can be restored if the left is released
 616     ** outside the gadget.
 617     */
 618     UBYTE               pd_ColorBackup;
 619     struct TextAttr     *pd_TAttr;
 620     LONG                pd_LabelPlace;
 621     Object              *pd_Frame;
 622 };
 623
 624
 625 #endif /* GADTOOLS_INTERN_H */