rom/intuition/openwindowtaglist.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include <proto/utility.h>
   8 #include "intuition_intern.h"
   9 #include <utility/tagitem.h>
  10 #include <proto/exec.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/intuition.h>
  16
  17         AROS_LH2(struct Window *, OpenWindowTagList,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct NewWindow *, newWindow, A0),
  21         AROS_LHA(struct TagItem   *, tagList, A1),
  22
  23 /*  LOCATION */
  24         struct IntuitionBase *, IntuitionBase, 101, Intuition)
  25
  26 /*  FUNCTION
  27         Open a new window.
  28
  29     INPUTS
  30         NewWindow - structure with window specification. This is for
  31                     compatibility with OpenWindow() and usually set to NULL
  32         tagList   - tags which specify appearance and behaviour of the window
  33
  34     TAGS
  35         WA_Left      - Left edge of the window
  36         WA_Top       - Top edge of the window
  37         WA_Width     - Width of the window
  38         WA_Height    - Height of the window
  39         WA_DetailPen - Pen number for window details (obsolete)
  40         WA_BlockPen  - Pen number for filled blocks (obsolete)
  41         WA_IDCMP     - Define what events should send messages to your task
  42
  43         WA_Flags
  44             Initial values for various boolean window properties. Can be
  45             overwritten by WA_... tags.
  46
  47         WA_Gadgets (struct Gadget *)
  48             Pointer to a linked list of gadgets
  49
  50         WA_Title (STRPTR) - Window title string
  51
  52         WA_CustomScreen (struct Screen *)
  53             Open window on the given screen
  54
  55         WA_SuperBitMap (struct BitMap *)
  56             Create window with superbitmap refreshing
  57
  58         WA_MinWidth           - Minimum width of the window
  59         WA_MinHeight          - Minimum height of the window
  60         WA_MaxWidth           - Maximum width of the window
  61         WA_MaxHeight          - Maximum height of the window
  62             Use 0 to keep the current size as limit. The maximums can be
  63             set to -1 or ~0 to limit size only to screen dimension.
  64
  65         WA_SizeGadget (BOOL)  - Make window resizeable
  66         WA_DragBar (BOOL)     - Make window dragable
  67         WA_DepthGadget (BOOL) - Add a depth gadget
  68         WA_CloseGadget (BOOL) - Add a close gadget
  69
  70         WA_Backdrop (BOOL)
  71             Create a window which is placed behind other windows
  72
  73         WA_ReportMouse (BOOL) - Store mouse position in struct Window
  74
  75         WA_NoCareRefresh (BOOL)
  76             Use this if you don't want to be responsible for calling
  77             BeginRefresh()/EndRefresh().
  78
  79         WA_Borderless (BOOL) - Create borderless window
  80
  81         WA_Activate (BOOL)
  82             Make this window the active one, i.e. it
  83             receives the input from mouse and keyboard.
  84
  85         WA_RMBTrap (BOOL)
  86             Set to TRUE if you want to get button events
  87             events for the right mouse button.
  88
  89         WA_SimpleRefresh (BOOL)
  90             Enable simplerefresh mode. Only specify if TRUE.
  91
  92         WA_SmartRefresh (BOOL)
  93             Enable smartrefresh mode. Only specify if TRUE.
  94
  95         WA_SizeBRight (BOOL)    - Place size gadget in right window border
  96         WA_SizeBBottom (BOOL)   - Place size gadget in bottom window border
  97
  98         WA_GimmeZeroZero (BOOL)
  99             Create a GimmeZeroZero window. The window borders have their own
 100             layer, so you can't overdraw it. The coordinate 0,0 is related to
 101             the inner area of the window. This makes handling of windows
 102             easier, but it slows down the system.
 103
 104         WA_NewLookMenus (BOOL)
 105             Use DrawInfo colors for rendering the menu bar.
 106
 107         WA_ScreenTitle (STRPTR)
 108             Screen title which is shown when window is active.
 109
 110         WA_AutoAdjust (BOOL)
 111             TRUE means that Intuition can move or shrink the window
 112             to fit on the screen, within the limits given with
 113             WA_MinWidth and WA_MinHeight. This attribute defaults
 114             to TRUE when you call OpenWindowTags() with a NULL pointer
 115             for NewWindow.
 116
 117         WA_InnerWidth
 118         WA_InnerHeight
 119             Dimensions of the interior region of the window.
 120
 121             Note that this restricts border gadgets:
 122             - GACT_LEFTBORDER gadgets can't be GFLG_RELWIDTH if
 123               WA_InnerWidth is used.
 124             - GACT_RIGHTBORDER gadgets must be GFLG_RELRIGHT if
 125               WA_InnerWidth is used.
 126             - GACT_TOPBORDER gadgets can't be GFLG_RELHEIGHT if
 127               WA_InnerHeight is used.
 128             - GACT_BOTTOMBORDER gadgets must be GFLG_RELBOTTOM if
 129               WA_InnerHeight is used.
 130
 131         WA_PubScreen (struct Screen *)
 132             Open the window on the public screen with the given address.
 133             An address of NULL means default public screen. You're
 134             responsible that the screen stays open until OpenWindowTags()
 135             has finished, i.e.
 136             you're the owner of the screen,
 137             you have already a window open on the screen
 138             or you use LockPubScreen()
 139
 140         WA_PubScreenName (STRPTR)
 141             Open the window on the public screen with the given name.
 142
 143         WA_PubScreenFallBack (BOOL)
 144             TRUE means that the default public screen can be used if
 145             the specified named public screen is not available.
 146
 147         WA_Zoom (WORD *)
 148             4 WORD's define the initial Left/Top/Width/Height of the
 149             alternative zoom position/dimension. This adds a zoom
 150             gadget to the window. If both left and top are set to ~0
 151             the window will only be resized.
 152
 153         WA_MouseQueue
 154             Limits the number of possible mousemove messages. Can
 155             be changed with SetMouseQueue().
 156
 157         WA_RptQueue
 158             Limits the number of possible repeated IDCMP_RAWKEY,
 159             IDCMP_VANILLAKEY and IDCMP_IDCMPUPDATE messages.
 160
 161         WA_BackFill (struct Hook *)
 162             Function to be called for backfilling
 163
 164         WA_MenuHelp (BOOL)
 165             Enables menuhelp. Pressing the help key during menu handling
 166             sends IDCMP_MENUHELP messages.
 167
 168         WA_NotifyDepth (BOOL)
 169             If TRUE send IDCMP_CHANGEWINDOW events when window is
 170             depth arranged. Code field will be CWCODE_DEPTH.
 171
 172         WA_Checkmark (struct Image *)
 173             Image to use as a checkmark in menus.
 174
 175         WA_AmigaKey (struct Image *)
 176             Image to use as the Amiga-key symbol in menus.
 177
 178         WA_Pointer (APTR)
 179             The pointer to associate with the window. Use NULL
 180             for the Preferences default pointer. You can create
 181             custom pointers with NewObject() on "pointerclass".
 182             Default: NULL.
 183
 184         WA_BusyPointer (BOOL)
 185             Enable the Preferences busy-pointer.
 186             Default: FALSE.
 187
 188         WA_PointerDelay (BOOL)
 189             Set this to TRUE to delay change of the pointer image.
 190             This avoids flickering of the mouse pointer when it's
 191             changed for short times.
 192
 193         WA_HelpGroup (ULONG)
 194             Get IDCMP_GADGETHELP messages not only from the active
 195             window, but from all its windows.
 196             You have to get a help ID with utility.library/GetUniqueID()
 197             and use it as data for WA_HelpGroup for all windows.
 198
 199         WA_HelpGroupWindow (struct Window *)
 200             Alternative for WA_HelpGroup. Use the helpgroup of
 201             another window.
 202
 203         WA_TabletMessages (BOOL)
 204             Request extended tablet data.
 205             Default: FALSE
 206
 207         WA_ToolBox (BOOL)
 208             Make this window a toolbox window
 209
 210         WA_Parent (struct Window *)
 211             Make the window a child of the given window.
 212
 213         WA_Visible (BOOL)
 214             Make window visible.
 215             Default: TRUE
 216
 217         WA_ShapeRegion (struct Region *)
 218
 219         WA_ShapeHook (struct Hook *)
 220
 221     RESULT
 222         A pointer to the new window or NULL if it couldn't be
 223         opened. Reasons for this might be lack of memory or illegal
 224         attributes.
 225
 226     NOTES
 227
 228     EXAMPLE
 229
 230     BUGS
 231
 232     SEE ALSO
 233
 234     INTERNALS
 235
 236 *****************************************************************************/
 237 {
 238     AROS_LIBFUNC_INIT
 239
 240     struct ExtNewWindow  nw =
 241     {
 242         0, 0,           /* Left, Top */
 243         ~0, ~0,         /* Width, Height */
 244         0xFF, 0xFF,     /* DetailPen, BlockPen */
 245         0L,             /* IDCMPFlags */
 246         0L,             /* Flags */
 247         NULL,           /* FirstGadget */
 248         NULL,           /* CheckMark */
 249         NULL,           /* Title */
 250         NULL,           /* Screen */
 251         NULL,           /* BitMap */
 252         0, 0,           /* MinWidth, MinHeight */
 253         0, 0,           /* MaxWidth, MaxHeight */
 254         WBENCHSCREEN,   /* Type */
 255         NULL            /* Extension (taglist) */
 256     };
 257     struct TagItem tags[2] =
 258     {
 259         {WA_AutoAdjust, TRUE    },
 260         {TAG_END,       0       }
 261     };
 262     struct Window       *window;
 263
 264     DEBUG_OPENWINDOWTAGLIST(dprintf("OpenWindowTagList: NewWindow 0x%lx TagList 0x%lx\n",
 265                                     newWindow, tagList));
 266
 267     if (newWindow)
 268     {
 269         ASSERT_VALID_PTR_ROMOK(newWindow);
 270
 271         CopyMem (newWindow, &nw, (newWindow->Flags & WFLG_NW_EXTENDED) ? sizeof (struct ExtNewWindow) :
 272                  sizeof (struct NewWindow));
 273
 274         if (tagList)
 275         {
 276             ASSERT_VALID_PTR_ROMOK(tagList);
 277
 278             nw.Extension = tagList;
 279             nw.Flags |= WFLG_NW_EXTENDED;
 280         }
 281     }
 282     else
 283     {
 284         nw.Extension = tags;
 285         nw.Flags |= WFLG_NW_EXTENDED;
 286
 287         if (tagList)
 288         {
 289             ASSERT_VALID_PTR_ROMOK(tagList);
 290
 291             tags[1].ti_Tag = TAG_MORE;
 292             tags[1].ti_Data = (IPTR)tagList;
 293         }
 294     }
 295
 296
 297     window = OpenWindow ((struct NewWindow *)&nw);
 298
 299     return window;
 300
 301     AROS_LIBFUNC_EXIT
 302
 303 } /* OpenWindowTagList */