Add to git.
[monolith.git] / doc / ml_image_get_src.3.html
1 <html>
2 <head>
3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>new_ml_image</title>
6 </head>
7 <body>
8
9 <h1 align=center>new_ml_image</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#AUTHOR">AUTHOR</a><br>
14 <a href="#LICENSE">LICENSE</a><br>
15 <a href="#VERSION">VERSION</a><br>
16
17 <hr>
18 <!-- Creator     : groff version 1.17.2 -->
19 <!-- CreationDate: Sat Aug 31 18:06:03 2002 -->
20 <a name="NAME"></a>
21 <h2>NAME</h2>
22 <table width="100%" border=0 rules="none" frame="void"
23        cols="2" cellspacing="0" cellpadding="0">
24 <tr valign="top" align="left">
25 <td width="10%"></td><td width="90%">
26 new_ml_image, ml_image_set_src, ml_image_get_src - monolith image widget</td></table>
27 <a name="SYNOPSIS"></a>
28 <h2>SYNOPSIS</h2>
29
30 <table width="100%" border=0 rules="none" frame="void"
31        cols="2" cellspacing="0" cellpadding="0">
32 <tr valign="top" align="left">
33 <td width="10%"></td><td width="90%">
34 <pre><b>#include &lt;ml_image.h&gt;
35
36 ml_image new_ml_image (pool pool, const char *src);
37 void ml_image_set_src (ml_image, const char *src);
38 const char *ml_image_get_src (ml_image);
39 </b></pre></td></table>
40 <a name="DESCRIPTION"></a>
41 <h2>DESCRIPTION</h2>
42
43 <table width="100%" border=0 rules="none" frame="void"
44        cols="2" cellspacing="0" cellpadding="0">
45 <tr valign="top" align="left">
46 <td width="10%"></td><td width="90%">
47 An image widget displays a graphical image, taken from a
48 particular source (in fact, it corresponds almost exactly to
49 the HTML <b>&lt;img/&gt;</b> element).</td></table>
50
51 <table width="100%" border=0 rules="none" frame="void"
52        cols="2" cellspacing="0" cellpadding="0">
53 <tr valign="top" align="left">
54 <td width="10%"></td><td width="90%">
55 The current implementation of <b>ml_image</b> is rather
56 immature. In future we will support image sizes, alt, title,
57 longdesc, and so on.</td></table>
58
59 <table width="100%" border=0 rules="none" frame="void"
60        cols="2" cellspacing="0" cellpadding="0">
61 <tr valign="top" align="left">
62 <td width="10%"></td><td width="90%">
63 <b>new_ml_image</b> creates a new image. You should supply
64 the <b>src</b> (source) for the image, which is an absolute
65 or relative link. If <b>src</b> is set to <b>NULL</b> then
66 no image is displayed.</td></table>
67
68 <table width="100%" border=0 rules="none" frame="void"
69        cols="2" cellspacing="0" cellpadding="0">
70 <tr valign="top" align="left">
71 <td width="10%"></td><td width="90%">
72 <b>ml_image_(set|get)_src</b> updates the source of the
73 image. You may set the source to <b>NULL</b> to display no
74 image at all.</td></table>
75 <a name="AUTHOR"></a>
76 <h2>AUTHOR</h2>
77
78 <table width="100%" border=0 rules="none" frame="void"
79        cols="2" cellspacing="0" cellpadding="0">
80 <tr valign="top" align="left">
81 <td width="10%"></td><td width="90%">
82 Richard Jones &lt;rich@annexia.org&gt;</td></table>
83 <a name="LICENSE"></a>
84 <h2>LICENSE</h2>
85
86 <table width="100%" border=0 rules="none" frame="void"
87        cols="2" cellspacing="0" cellpadding="0">
88 <tr valign="top" align="left">
89 <td width="10%"></td><td width="90%">
90 GNU LGPL (see http://www.gnu.org/)</td></table>
91 <a name="VERSION"></a>
92 <h2>VERSION</h2>
93
94 <table width="100%" border=0 rules="none" frame="void"
95        cols="2" cellspacing="0" cellpadding="0">
96 <tr valign="top" align="left">
97 <td width="10%"></td><td width="90%">
98 monolith-1.0.0</td></table>
99 <hr>
100 </body>
101 </html>