home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / separatorclass.doc < prev    next >
Encoding:
Text File  |  1995-05-24  |  2.8 KB  |  95 lines
  1.  
  2.                File: separatorclass.doc
  3.         Description: Separatorclass 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. separatorclass/--background--
  13. separatorclass/Methods
  14. separatorclass/Attributes
  15.  
  16. separatorclass/--background--                    separatorclass/--background--
  17.  
  18.     NAME
  19.         Class:          separatorclass
  20.         Superclass:     GADGETCLASS
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  you  with  a  simple  way to seperate different groups of
  25.         objects with a single 3D line with or without a descriptive title.  As
  26.         this class is read-only it will not send out any form of notification.
  27.  
  28. separatorclass/Methods                                  separatorclass/Methods
  29.  
  30.     NEW METHODS
  31.         None.
  32.  
  33.     CHANGED METHODS
  34.         None.
  35.  
  36. separatorclass/Attributes                            separatorclass/Attributes
  37.  
  38.     NAME
  39.         SEP_Horiz -- ( BOOL )
  40.  
  41.     FUNCTION
  42.         To  make  the  separator a horizontal one. By default the separator is
  43.         vertical.  Vertical  separators  must be used in horizontal groups and
  44.         horizontal separators in vertical groups.
  45.  
  46.         Default is FALSE. Applicability is (I).
  47.  
  48.     NAME
  49.         SEP_Title -- ( STRPTR )
  50.  
  51.     FUNCTION
  52.         To  give  the  separator  a  descriptive  title. Please note that this
  53.         attribute is only useful and processed for horizontal separators.
  54.  
  55.         Default is NULL. Applicability is (I).
  56.  
  57.     NAME
  58.         SEP_Thin -- ( BOOL )
  59.  
  60.     FUNCTION
  61.         To  make  the  separator thin which means that the width of the bar is
  62.         reduced  to two pixels. Please note that this attribute is only useful
  63.         and processed for vertical separators.
  64.  
  65.         Default is FALSE. Applicability is (I).
  66.  
  67.     NAME
  68.         SEP_Highlight -- ( BOOL )
  69.  
  70.     FUNCTION
  71.         To  render  the  separator title using the HIGHLIGHTTEXTPEN instead of
  72.         the  default  TEXTPEN  color.  Please note that this attribute is only
  73.         useful and processed for horizontal separators.
  74.  
  75.         Default is FALSE. Applicability is (I).
  76.  
  77.     NAME
  78.         SEP_CenterTitle -- ( BOOL )
  79.  
  80.     FUNCTION
  81.         To  render  the  separator  title  in  the center of the separator bar
  82.         instead  of  the  text  baseline on the separator bar. Please not that
  83.         this attribute is only useful and processed for horizontal separators.
  84.  
  85.  
  86.         Default is FALSE. Applicability is (I).
  87.  
  88.     NAME
  89.         SEP_Recessed -- ( BOOL ) ** V39 **
  90.  
  91.     FUNCTION
  92.         To make the separator appear recessed.
  93.  
  94.         Default is FALSE. Applicability is (I).
  95.