workbench/libs/reqtools/rtpaletterequesta.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 #include <exec/types.h>
  10 #include <proto/exec.h>
  11 #include <proto/reqtools.h>
  12 #include <proto/intuition.h>
  13 #include <exec/libraries.h>
  14 #include <exec/memory.h>
  15 #include <aros/libcall.h>
  16
  17 #include "reqtools_intern.h"
  18
  19 /*****************************************************************************
  20
  21     NAME */
  22
  23     AROS_LH3(LONG, rtPaletteRequestA,
  24
  25 /*  SYNOPSIS */
  26
  27         AROS_LHA(char *, title, A2),
  28         AROS_LHA(struct rtReqInfo *, reqinfo, A3),
  29         AROS_LHA(struct TagItem *, taglist, A0),
  30
  31 /*  LOCATION */
  32
  33         struct ReqToolsBase *, ReqToolsBase, 17, ReqTools)
  34
  35 /*  FUNCTION
  36         Put up a palette requester so the user can change the screen's
  37         colors.
  38
  39         The colors are changed in the viewport of the screen the requester
  40         will appear on, so that is where you will find them after the
  41         palette requester returns.
  42
  43         The selected color is returned, so you can also use this requester
  44         to let the user select a color.
  45
  46         'reqinfo' can be used to customize the requester. For greater
  47         control use the tags listed below. The advantage of the rtReqInfo
  48         structure is that it is global, where tags have to be specified
  49         each function call. See libraries/reqtools.[hi] for a description
  50         of the rtReqInfo structure.
  51
  52     INPUTS
  53         title - pointer to requester window title (null terminated).
  54         reqinfo - pointer to a rtReqInfo structure allocated with
  55             rtAllocRequest() or NULL.
  56         taglist - pointer to a TagItem array.
  57
  58     TAGS
  59         RT_Window - see rtEZRequestA()
  60
  61         RT_ReqPos - see rtEZRequestA()
  62
  63         RT_LeftOffset - see rtEZRequestA()
  64
  65         RT_TopOffset - see rtEZRequestA()
  66
  67         RT_PubScrName - see rtEZRequestA()
  68
  69         RT_Screen - see rtEZRequestA()
  70
  71         RT_ReqHandler - see rtEZRequestA()
  72
  73         RT_WaitPointer - see rtEZRequestA()
  74
  75         RT_LockWindow - [V38] see rtEZRequestA()
  76
  77         RT_ScreenToFront - [V38] see rtEZRequestA()
  78
  79         RT_ShareIDCMP - [V38] see rtEZRequestA()
  80
  81         RT_Locale - [V38] see rtEZRequestA()
  82
  83         RT_IntuiMsgFunc - [V38] see rtEZRequestA()
  84
  85         RT_DefaultFont - (struct TextFont *) This tag allows you to specify
  86             the font to be used in the requester when the screen font is
  87             proportional. Default is GfxBase->DefaultFont. This tag is
  88             obsolete in ReqTools 2.2 and higher, when running OS 3.0 or
  89             higher!
  90
  91         RT_TextAttr - [V38] see rtFileRequestA() If the font is
  92             proportional on Kickstart 2.04 or below ReqTools will use the
  93             system default font or the font supplied with RT_DefaultFont.
  94             On Kickstart 3.0 or higher the proportional font is used.
  95
  96         RTPA_Color - (ULONG) Initially selected color of palette. Default
  97             is 1.
  98
  99     RESULT
 100         color - the color number of the selected color or -1 if the user
 101             canceled the requester.
 102
 103     NOTES
 104         Automatically adjusts the requester to the screen font. On
 105         Kickstart 2.04 or lower, if the screen font is proportional the
 106         default font will be used.
 107
 108         If the requester got too big for the screen because of a very large
 109         font, the topaz.font will be used.
 110
 111         rtPaletteRequestA() checks the pr_WindowPtr of your process to find
 112         the screen to put the requester on.
 113
 114     EXAMPLE
 115
 116     BUGS
 117         none known
 118
 119     SEE ALSO
 120
 121     INTERNALS
 122
 123     HISTORY
 124
 125 ******************************************************************************/
 126 {
 127     AROS_LIBFUNC_INIT
 128
 129     return PaletteRequestA(title, reqinfo, taglist); /* in palettereq.c */
 130
 131     AROS_LIBFUNC_EXIT
 132
 133 } /* rtPaletteRequestA */