1 /* Monolith text label class.
2 * - by Richard W.M. Jones <rich@annexia.org>
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.
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.
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.
18 * $Id: ml_text_label.h,v 1.4 2003/01/11 16:39:10 rich Exp $
21 #ifndef ML_TEXT_LABEL_H
22 #define ML_TEXT_LABEL_H
24 #include <ml_widget.h>
27 typedef struct ml_text_label *ml_text_label;
29 /* Function: new_ml_text_label - monolith text label widget
31 * Text labels are simple strings or paragraphs of text. Unlike
32 * the @code{ml_label} widget, HTML sequences are escaped before
33 * being sent to the browser, so @code{ml_text_label}s can contain
34 * @code{<}, @code{>}, @code{&} and so on and these will be displayed
37 * Text labels allow control over the style, size and other aspects
38 * of how the text appears.
40 * @code{new_ml_text_label} creates a new text label widget.
42 * The following properties can be changed on text labels (see
43 * @code{ml_widget_set_property(3)}):
45 * @code{text}: The text displayed on the label.
47 * @code{text.align}: The text-align style
48 * of the text label. Common alignments are @code{"left"}, @code{"right"}
49 * and @code{"justify"}.
51 * @code{color}: The color style (text color).
53 * @code{font.weight}: The font-weight style
54 * of the text label. Common weights are @code{"normal"} and @code{"bold"}.
56 * @code{font.size}: The font-size style
57 * of the text label. Common sizes are @code{"small"}, @code{"medium"}
60 * See also: @ref{new_ml_widget(3)}, W3C CSS2 recommendation.
62 extern ml_text_label new_ml_text_label (pool, const char *text);
64 #endif /* ML_TEXT_LABEL_H */