File: separatorclass.doc
        Description: Separatorclass documentation.
          Copyright: (C) Copyright 1994-1995 Jaba Development.
                     (C) Copyright 1994-1995 Jan van den Baard.
                     All Rights Reserved.

------------------------------------------------------------------------------

TABLE OF CONTENTS

separatorclass/--background--
separatorclass/Methods
separatorclass/Attributes

separatorclass/--background--                    separatorclass/--background--

    NAME
        Class:          separatorclass
        Superclass:     GADGETCLASS
        Include File:   <libraries/bgui.h>

    FUNCTION
        To  provide  you  with  a  simple  way to seperate different groups of
        objects with a single 3D line with or without a descriptive title.  As
        this class is read-only it will not send out any form of notification.

separatorclass/Methods                                  separatorclass/Methods

    NEW METHODS
        None.

    CHANGED METHODS
        None.

separatorclass/Attributes                            separatorclass/Attributes

    NAME
        SEP_Horiz -- ( BOOL )

    FUNCTION
        To  make  the  separator a horizontal one. By default the separator is
        vertical.  Vertical  separators  must be used in horizontal groups and
        horizontal separators in vertical groups.

        Default is FALSE. Applicability is (I).

    NAME
        SEP_Title -- ( STRPTR )

    FUNCTION
        To  give  the  separator  a  descriptive  title. Please note that this
        attribute is only useful and processed for horizontal separators.

        Default is NULL. Applicability is (I).

    NAME
        SEP_Thin -- ( BOOL )

    FUNCTION
        To  make  the  separator thin which means that the width of the bar is
        reduced  to two pixels. Please note that this attribute is only useful
        and processed for vertical separators.

        Default is FALSE. Applicability is (I).

    NAME
        SEP_Highlight -- ( BOOL )

    FUNCTION
        To  render  the  separator title using the HIGHLIGHTTEXTPEN instead of
        the  default  TEXTPEN  color.  Please note that this attribute is only
        useful and processed for horizontal separators.

        Default is FALSE. Applicability is (I).

    NAME
        SEP_CenterTitle -- ( BOOL )

    FUNCTION
        To  render  the  separator  title  in  the center of the separator bar
        instead  of  the  text  baseline on the separator bar. Please not that
        this attribute is only useful and processed for horizontal separators.


        Default is FALSE. Applicability is (I).

    NAME
        SEP_Recessed -- ( BOOL ) ** V39 **

    FUNCTION
        To make the separator appear recessed.

        Default is FALSE. Applicability is (I).