home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / mxclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  2.9 KB  |  101 lines
  1.  
  2.                File: mxclass.doc
  3.         Description: Mxclass 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. mxclass/--background--
  13. mxclass/Methods
  14. mxclass/Attributes
  15.  
  16. mxclass/--background--                                  mxclass/--background--
  17.  
  18.     NAME
  19.         Class:          mxclass
  20.         Superclass:     groupclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  gadget  object simular to the gadtools.library it's mx
  25.         kind.  Objects  from this class send out the following attribute pairs
  26.         in their notification events:
  27.  
  28.         GA_ID           - Gadget object ID.
  29.         MX_Active       - Currently selected label.
  30.  
  31. mxclass/Methods                                                mxclass/Methods
  32.  
  33.     NEW METHODS
  34.         None.
  35.  
  36.     CHANGED METHODS
  37.         None.
  38.  
  39. mxclass/Attributes                                          mxclass/Attributes
  40.  
  41.     NAME
  42.         MX_Labels -- ( STRPTR * )
  43.  
  44.     FUNCTION
  45.         Set  the  labels  used  by  the  radio-buttons.  This  must point to a
  46.         NULL-terminated  array  of  string  pointers.  The strings will be the
  47.         labels of the buttons created by the class.   This  attribute  must be
  48.         valid.
  49.  
  50.         Default is NULL. Applicability is (I).
  51.  
  52.     NAME
  53.         MX_Active -- ( ULONG )
  54.  
  55.     FUNCTION
  56.         Set or get the currently active (selected) button.
  57.  
  58.         Default is 0. Applicability is (ISGNU).
  59.  
  60.     NAME
  61.         MX_LabelPlace -- ( ULONG )
  62.  
  63.     FUNCTION
  64.         Set  the place at which the labels of the button are placed. There are
  65.         two possibilities:
  66.  
  67.         PLACE_LEFT -- The labels are placed left of the buttons.
  68.         PLACE_RIGHT -- The labels are placed right of the buttons.
  69.  
  70.         Default is PLACE_RIGHT. Applicability is (I).
  71.  
  72.     NAME
  73.         MX_DisabledButton, MX_EnableButton -- ( ULONG )
  74.  
  75.     FUNCTION
  76.         Disable  or enable a single button in the mx object. The data of these
  77.         tags must be the number of the button you wish to enable or disable.
  78.  
  79.         No default. Applicability is (ISU).
  80.  
  81.     NAME
  82.         MX_TabsObject -- ( BOOL )
  83.  
  84.     FUNCTION
  85.         To make the object a tabs object. A tabs object is an object  which is
  86.         rendered simular  to  tabs in a book.   When this attribute is set you
  87.         will  get  an object which is perfect to select pages from a pageclass
  88.         object.
  89.  
  90.         Default is FALSE. Applicability is (I).
  91.  
  92.     NAME
  93.         MX_TabsTextAttr -- ( struct TextAttr * )
  94.  
  95.     FUNCTION
  96.         To determine the font  in  which  the labels of the tabs are rendered.
  97.         NULL means that the font is the same as  the  font  used  by the other
  98.         objects in the window.
  99.  
  100.         Default is NULL. Applicability is (I).
  101.