src/ml_label.h

   1 /* Monolith label 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_label.h,v 1.2 2002/10/30 21:03:03 rich Exp $
  19  */
  20
  21 #ifndef ML_LABEL_H
  22 #define ML_LABEL_H
  23
  24 struct ml_label;
  25 typedef struct ml_label *ml_label;
  26
  27 /* Function: new_ml_label - monolith label widget
  28  *
  29  * A label widget is a generic piece of HTML.
  30  *
  31  * @code{new_ml_label} creates a new label widget.
  32  *
  33  * The following properties can be changed on labels (see
  34  * @ref{ml_widget_set_property(3)}):
  35  *
  36  * @code{text}: The HTML associated
  37  * with the label. Note that the text string must be either
  38  * static, or already allocated in the label's pool, or allocated
  39  * in a pool with a longer lifetime than the label. If the text
  40  * is set to @code{NULL} then this has the same effect as setting
  41  * the text to the empty string.
  42  */
  43 extern ml_label new_ml_label (pool pool, const char *text);
  44
  45 #endif /* ML_LABEL_H */