src/ml_heading.h

   1 /* Monolith heading class.
   2  * - by Richard W.M. Jones <rich@annexia.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the Free
  16  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *
  18  * $Id: ml_heading.h,v 1.2 2003/01/11 16:39:10 rich Exp $
  19  */
  20
  21 #ifndef ML_HEADING_H
  22 #define ML_HEADING_H
  23
  24 #include <ml_widget.h>
  25
  26 struct ml_heading;
  27 typedef struct ml_heading *ml_heading;
  28
  29 /* Function: new_ml_heading - monolith heading widget
  30  *
  31  * Headings are simple text strings which are displayed as headings
  32  * for sections of a document or page. There are six levels of
  33  * heading, from 1 to 6, with 1 being the top level.
  34  *
  35  * @code{new_ml_heading} creates a new heading widget. The
  36  * @code{level} parameter is the heading level (a number from
  37  * 1 to 6). The @code{text} parameter is the text which will
  38  * be displayed in the heading.
  39  *
  40  * The following properties can be changed on heading widgets (see
  41  * @code{ml_widget_set_property(3)}):
  42  *
  43  * @code{text}: The text displayed in the heading.
  44  *
  45  * @code{heading.level}: The level.
  46  */
  47 extern ml_heading new_ml_heading (pool, int level, const char *text);
  48
  49 #endif /* ML_HEADING_H */