openbox/obrender/imagecache.h
Kadlcik Libor 0352abfa88 This patch implements support for icons in user-defined menus into Openbox
Image loading is done using the Imlib2 library.
I chose Imlib2 because it's pretty fast, it's easy to use, supports many file
formats (tested xpm, gif, jpeg, png) and doesn't introduce too much bloat (it
depends :)).

I ported the patch to 3.4.7-pre3 and added some enhancements. Caching is much
better now, and icons can be disabled at compile time using --disable-imlib2
option.

What's new?
Syntax of configuration files (namely rc.xml and menu.xml) has been changed
slightly to allow users to associate icons to menu entries. This is done by
specifying path to icon file in the new "icon" attribute in "<item>" element,
e.g:
<item label="Vim" icon="/usr/share/pixmaps/vim-32.xpm">
  <action name="Execute"><execute>x-terminal-emulator -T Vim -e
vim</execute></action>
</item>

If user doesn't want to display any icons in his user-defined menus, he/she can
disable icons in rc.xml, inside "<menu>" section:
<menu>
 ...
  <showIcons>no</showIcons>
 ...
</menu>
Default value is "yes".
(New boolean variable "config_menu_user_show_icons" has been added to source
code.)

An icon is loaded (using menu_item_attach_icon()) when a new entry of menu is
created. Fortunately, I haven't notice any performance problems because of this
:).
2010-01-08 17:55:19 -05:00

55 lines
2 KiB
C

/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
imagecache.h for the Openbox window manager
Copyright (c) 2008 Dana Jansens
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
See the COPYING file for a copy of the GNU General Public License.
*/
#ifndef __imagecache_h
#define __imagecache_h
#include <glib.h>
struct _RrImagePic;
guint RrImagePicHash(const struct _RrImagePic *p);
/*! Create a new image cache. An image cache is basically a hash table to look
up RrImages. Each RrImage in the cache may contain one or more Pictures,
that is one or more actual copies of image data at various sizes. For eg,
for a window, all of its various icons are loaded into the same RrImage.
When an RrImage is drawn and a picture inside it needs to be resized, that
is also saved within the RrImage.
For each picture that an RrImage has, the picture is hashed and that is used
as a key to find the RrImage. So, given any picture in any RrImage in the
cache, if you hash it, you will find the RrImage.
*/
struct _RrImageCache {
gint ref;
/*! When an original picture is resized for an RrImage, the resized picture
is saved in the RrImage. This specifies how many pictures should be
saved at a time. When this is exceeded, the least recently used
"resized" picture is deleted.
*/
gint max_resized_saved;
GHashTable *table;
/* Used to find out if an image file has already been loaded.
Quick file_name -> RrImage lookup. */
GHashTable *file_name_table;
};
#endif