git.maemo.org Git - modest/blob - src/modest-icon-factory.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 /* modest-icon-factory.h */
  32
  33 #ifndef __MODEST_ICON_FACTORY_H__
  34 #define __MODEST_ICON_FACTORY_H__
  35
  36 #include <gdk/gdkpixbuf.h>
  37
  38 /**
  39  * modest_icon_factory_get_icon:
  40  * @name: the filename of a certain icon
  41  *
  42  * Returns: a GdkPixBuf for this icon, or NULL in case of error
  43  * You should NOT unref or modify the pixbuf in any way
  44  */
  45 GdkPixbuf* modest_icon_factory_get_icon (const gchar *name);
  46
  47 /**
  48  * modest_icon_factory_get_icon_at_size:
  49  * @name: the filename of a certain icon
  50  * @width: the desired width of the icon
  51  * @height: the desired height of the icon
  52  *
  53  * Returns: a GdkPixBuf for this icon, or NULL in case of error
  54  * You should NOT unref or modify the pixbuf in any way
  55  */
  56 GdkPixbuf* modest_icon_factory_get_icon_at_size (const gchar *name, guint width, guint height);
  57
  58 /* FIXME */
  59 #define modest_icon_factory_get_small_icon(n) modest_icon_factory_get_icon_at_size(n,16,16)
  60 #define modest_icon_factory_get_big_icon(n)   modest_icon_factory_get_icon_at_size(n,24,24)
  61
  62
  63 #endif /*__MODEST_ICON_FACTORY_H__ */