home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / buttonclass.doc < prev    next >
Encoding:
Text File  |  1995-06-11  |  2.6 KB  |  90 lines
  1.  
  2.            File: buttonclass.doc
  3.     Description: Buttonclass documentation.
  4.       Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.              (C) Copyright 1994-1995 Jan van den Baard.
  6.              All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. buttonclass/--background--
  13. buttonclass/Methods
  14. buttonclass/Attributes
  15.  
  16. buttonclass/--background--                buttonclass/--background--
  17.  
  18.     NAME
  19.     Class:        buttonclass
  20.     Superclass:    baseclass
  21.     Include File:    <llibraries/bgui.h>
  22.  
  23.     FUNCTION
  24.     To provide a gadget simular to the gadtools.library button  kind.  The
  25.     gadget can either be a normal button or a toggle button.   Vectorclass
  26.     attributes can be passed at create time to add imagery to the gadget.
  27.  
  28.     The  gadget  will  send  the following attributes in it's notification
  29.     events:
  30.  
  31.     GA_ID        - Gadget object ID.
  32.     GA_UserData    - Gadget object userdata contents.
  33.     GA_Selected    - Gadget object selected state.
  34.  
  35.     Please    note  that  the  gadget  will  send  out  interim notification
  36.     messages every single timer tick while the gadget is selected.
  37.  
  38. buttonclass/Methods                       buttonclass/Methods
  39.  
  40.     NEW METHODS
  41.     None.
  42.  
  43.     CHANGED METHODS
  44.     None.
  45.  
  46. buttonclass/Attributes                    buttonclass/Attributes
  47.  
  48.     NOTE: The  VIT_VectorArray, VIT_BuiltIn, VIT_Pen and VIT_DriPen attributes
  49.       are also settable with OM_SET or  OM_UPDATE  when  the button object
  50.       has a vector image attached to it.
  51.  
  52.     NAME
  53.     GA_Selected - ( BOOL )
  54.  
  55.     FUNCTION
  56.     This  attributes  has  an  extended  applicability.  It  has been made
  57.     get-able  to  make  it    easy to inquire about the selected state of an
  58.     object.
  59.  
  60.     Default is FALSE. Applicability is (ISGNU).
  61.  
  62.     NAME
  63.     BUTTON_Image, BUTTON_SelectedImage -- ( struct Image * )
  64.  
  65.     FUNCTION
  66.     To provide a button object width a standard Intuition or BOOPSI image.
  67.     The images will be centered  inside the object    it's hitbox.  You  can
  68.     supply a selected image which is  shown when  the gadget  is selected.
  69.     If no selected imagery is  specified  the normal  image is  also shown
  70.     when the gadget is selected.
  71.  
  72.     This attribute overides the creation of a VectorClass image.
  73.  
  74.     NOTE: Since V39 of the library the images can be  changed with    OM_SET
  75.           and OM_UPDATE. You are responsible to make the images you change
  76.           will still fit in the object.
  77.  
  78.     Defaults are NULL. Applicability is (ISU).
  79.  
  80.     NAME
  81.     BUTTON_EncloseImage -- ( BOOL ) ** V39 **
  82.  
  83.     FUNCTION
  84.     By default the buttonclass keeps a gap between the  actual  image  and
  85.     a frame which may be attached to the object. When you specify this tag
  86.     as  TRUE  this    gap  will  not be there and the frame will enclose the
  87.     image.
  88.  
  89.     Default is FALSE. Applicability is (I).
  90.