home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / datatypes / switchwindowal.lha / sw.buttonclass.c.doc < prev    next >
Encoding:
Text File  |  1996-03-18  |  2.9 KB  |  103 lines
  1. TABLE OF CONTENTS
  2.  
  3. switchwindow/buttonclass
  4. switchwindow/buttonclass                             switchwindow/buttonclass
  5.  
  6.    NAME
  7.        buttonclass -- button gadget with frame.
  8.  
  9.    FUNCTION
  10.        Class:        buttonclass
  11.        Superclass:   gadgetclass
  12.  
  13.    METHODS
  14.        OM_NEW -- Create a new object and attaches a new frameiclass
  15.            to it. If an image (GA_Text or GA_LabelImage) is given,
  16.            the object sets it's width and height round this object.
  17.  
  18.        OM_DISPOSE -- Dispose object amd frameiclass image.
  19.  
  20.        OM_SET
  21.        OM_UPDATE --
  22.  
  23.        OM_GET --
  24.  
  25.        GM_GOACTIVE --
  26.  
  27.        GM_HANDLEINPUT -- Handle incoming input
  28.  
  29.        GM_GOINACTIVE --
  30.  
  31.        GM_RENDER --
  32.  
  33.        GM_LAYOUT --
  34.  
  35.    TAGS
  36.        GA_Image (Object *) -- An image to display. This is used as the
  37.            button's frame. It must support IM_FRAMEBOX, otherwise the gadget
  38.            can't do any GA_Text/GA_LabelImage centering/framing.
  39.            Defaults to NULL.
  40.  
  41.            Applicability is (ISG).
  42.  
  43.        GA_IntuiText (struct IntuiText *) -- An (struct IntuiText *) to
  44.            render.
  45.            See GA_Text for details, the font used is got from IntuiText
  46.            structure.
  47.            NOT IMPLEMENTED YET.
  48.  
  49.            Applicability is (ISG).
  50.  
  51.        GA_LabelImage (Object *) -- An image to display. The buttons frame
  52.            will be used (using IM_FRAMEBOX) to center this image.
  53.            Defaults to NULL.
  54.  
  55.            Applicability is (ISG).
  56.  
  57.        GA_Text (STRPTR) -- Text to display. Like GA_LableImage, this text
  58.            will be centered.
  59.            The font used is got from BUTTONA_TextFont attribute.
  60.            If no BUTTONA_TextFont was given, the object can't render
  61.            any text.
  62.  
  63.            Defaults to NULL.
  64.  
  65.            Applicability is (ISGU).
  66.  
  67.        GA_FollowMouse (BOOL) -- Determine whether the gadget should send
  68.            continous msgs for each IECLASS_TIMER event (which comes every
  69.            1/10 seconds) or not. Toggleselect buttons ignores this.
  70.            Defaults to FALSE.
  71.  
  72.            Applicability is (ISGU).
  73.  
  74.        GA_Immediate (BOOL) -- If TRUE, toggleselect gadgets will set their
  75.            state with SELECTDOWN, not SELECTUP.
  76.            Defaults to FALSE.
  77.  
  78.            Applicability is (ISGU).
  79.  
  80.        GA_ToggleSelect (BOOL) -- Determine wheter the gadget should work
  81.            like a toogle-select gadget or not.
  82.            Changing this attribute will automatically clear the GA_Selected
  83.            flag.
  84.            Defaults to FALSE.
  85.  
  86.            Applicability is (ISGU).
  87.  
  88.        GA_Selected (BOOL) -- Determine if gadget if currently in selected
  89.            state or not. Mainly used in conjunction with GA_ToggleSelect.
  90.            Defaults to FALSE.
  91.  
  92.            Applicability is (ISGUN) when GA_ToggleSelect is TRUE,
  93.            otherwise (ISGU).
  94.  
  95.        BUTTONA_TextFont (struct TextFont *) -- Font to use when rendering
  96.            GA_Text strings.
  97.            Defaults to NULL.
  98.  
  99.            Applicability is (IS).
  100.  
  101.    BUGS
  102.  
  103.