home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / cycleclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  2.6 KB  |  82 lines
  1.  
  2.                File: cycleclass.doc
  3.         Description: Cycleclass 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. cycleclass/--background--
  13. cycleclass/Methods
  14. cycleclass/Attributes
  15.  
  16. cycleclass/--background--                            cycleclass/--background--
  17.  
  18.     NAME
  19.         Class:          cycleclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a gadget simular to the gadtools.library it's cycle kind.
  25.         Objects from  this  class  will  send the following  attributes  pairs
  26.         in it's notification events:
  27.  
  28.         GA_ID           - Gadget object ID.
  29.         CYC_Active      - Gadget object active label number.
  30.  
  31. cycleclass/Methods                                          cycleclass/Methods
  32.  
  33.     NEW METHODS
  34.         None.
  35.  
  36.     CHANGED METHODS
  37.         None.
  38.  
  39. cycleclass/Attributes                                    cycleclass/Attributes
  40.  
  41.     NAME
  42.         CYC_Labels -- ( STRPTR * )
  43.  
  44.     FUNCTION
  45.         Set an array of string pointers which will be the cycle gadget labels.
  46.         The  array  must  point to a valid NULL-terminated array or the object
  47.         will fail to create.
  48.  
  49.         Default is NULL. Applicability is (I).
  50.  
  51.     NAME
  52.         CYC_Active -- ( ULONG )
  53.  
  54.     FUNCTION
  55.         Set  or  get  the  number of the currently active label where 0 is the
  56.         first label in the array.
  57.  
  58.         Default is 0. Applicability is (ISGNU).
  59.  
  60.     NAME
  61.         CYC_Popup -- ( BOOL )
  62.  
  63.     FUNCTION
  64.         To make  the  cycle object into a popup menu. When this is set to TRUE
  65.         and you click inside the label area of the cycle gadget a menu appears
  66.         in which all choises are visible. Selecting the wanted item is simular
  67.         to normal  menu-selection. Pressing the right mouse-button will cancel
  68.         the selection.
  69.  
  70.         When this  option  is  on  and you press inside the cycle-image of the
  71.         object the old selection method is used.
  72.  
  73.         Please note  that  when  the  popup  option is turned on and the cycle
  74.         object has  more  entries  than  can be made visible on the screen the
  75.         list will be truncated.
  76.  
  77.         On OS  3.0  systems  or  better  (V39++)  the menu will always use the
  78.         NewLook-menu coloring.  On  systems running less than OS 3.0 the menus
  79.         will appear in the BlockPen and DetailPen.
  80.  
  81.         Default is FALSE. Applicability is (I).
  82.