src/ml_image.h

   1 /* Monolith image 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_image.h,v 1.2 2002/10/30 21:03:03 rich Exp $
  19  */
  20
  21 #ifndef ML_IMAGE_H
  22 #define ML_IMAGE_H
  23
  24 #include "monolith.h"
  25
  26 struct ml_image;
  27 typedef struct ml_image *ml_image;
  28
  29 /* Function: new_ml_image - monolith image widget
  30  *
  31  * An image widget displays a graphical image, taken from a
  32  * particular source (in fact, it corresponds almost exactly
  33  * to the HTML @code{<img/>} element).
  34  *
  35  * The current implementation of @code{ml_image} is rather
  36  * immature. In future we will support image sizes, alt, title,
  37  * longdesc, and so on.
  38  *
  39  * @code{new_ml_image} creates a new image. You should supply
  40  * the @code{src} (source) for the image, which is an absolute or
  41  * relative link. If @code{src} is set to @code{NULL} then no
  42  * image is displayed.
  43  *
  44  * The following properties can be changed on images (see
  45  * @ref{ml_widget_set_property(3)}):
  46  *
  47  * @code{image}: The source of the image. You may set this to
  48  * @code{NULL} to display no image at all.
  49  */
  50 extern ml_image new_ml_image (pool pool, const char *image);
  51
  52 #endif /* ML_IMAGE_H */