home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / propclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  2.5 KB  |  88 lines
  1.  
  2.                File: propclass.doc
  3.         Description: Propclass 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. propclass/--background--
  13. propclass/Methods
  14. propclass/Attributes
  15.  
  16. propclass/--background--                              propclass/--background--
  17.  
  18.     NAME
  19.         Class:          propclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  BGUI compatible extention of the system propgclass. In
  25.         addition   to   the   normal  propgclass  functionality  you  get  the
  26.         possibility  to  add  arrow  gadgets  to the object. Objects from this
  27.         class sends out the following attribute pairs in notification events:
  28.  
  29.         GA_ID           - Gadget object ID.
  30.         PGA_Top         - Top position of the prop knob.
  31.  
  32. propclass/Methods                                            propclass/Methods
  33.  
  34.     NEW METHODS
  35.         None.
  36.  
  37.     CHANGED METHODS
  38.         None.
  39.  
  40. propclass/Attributes                                      propclass/Attributes
  41.  
  42.     NAME
  43.         PGA_Arrows -- ( BOOL )
  44.  
  45.     FUNCTION
  46.         To  determine  wether  or not the create object will get arrow gadgets
  47.         attached to the proportional gadget.
  48.  
  49.         Default is TRUE. Applicability is (I).
  50.  
  51.     SEE ALSO
  52.         PGA_ArrowSize
  53.  
  54.     NAME
  55.         PGA_ArrowSize -- ( ULONG )
  56.  
  57.     FUNCTION
  58.         To  determine  the size of the arrows. The size affected is the height
  59.         of  the  arrows in vertical prop objects or the width of the arrows in
  60.         horizontal prop objects.
  61.  
  62.         Defaults are 10 horizontal and 9 vertical. Applicability is (I).
  63.  
  64.     SEE ALSO
  65.         PGA_Arrows
  66.  
  67.     NAME
  68.         PGA_ThinFrame -- ( BOOL )
  69.  
  70.     FUNCTION
  71.         To make  all  sroller  object framing appear as thin frames. This will
  72.         help you to make an aspect-ratio dependant GUI.
  73.  
  74.         Default is FALSE. Applicability is (I).
  75.  
  76.     NAME
  77.         PGA_XenFrame -- ( BOOL )
  78.  
  79.     FUNCTION
  80.         To make all scroller object framing appear as Xen style framing.
  81.  
  82.         Default is FALSE. Applicability is (I).
  83.  
  84.     NOTE
  85.         All system propgclass attributes are also valid for this class. Please
  86.         refer  to  the documentation on the propgclass for more information on
  87.         these attributes.
  88.