/*
 * Java-Gnome Bindings Library
 *
 * Copyright 1998-2004 the Java-Gnome Team, all rights reserved.
 *
 * The Java-Gnome bindings library is free software distributed under
 * the terms of the GNU Library General Public License version 2.
 */

package org.gnu.gtk;

import org.gnu.gdk.Pixbuf;
import org.gnu.gdk.Screen;
import org.gnu.glib.GObject;
import org.gnu.glib.Handle;

/**
 */
public class IconTheme extends GObject {
	
	public IconTheme() {
		super(gtk_icon_theme_new());
	}
	
	private IconTheme(Handle handle) {
		super(handle);
	}
	
	static public IconTheme getDefault(){
		return new IconTheme(gtk_icon_theme_get_default()); 
	}
	
	static public IconTheme getForSceen(Screen screen) {
		return new IconTheme(gtk_icon_theme_get_for_screen(screen.getHandle()));
	}
	
	public void setScreen(Screen screen) {
		gtk_icon_theme_set_screen(getHandle(), screen.getHandle());
	}
	
	public void setSearchPath(String[] path) {
		gtk_icon_theme_set_search_path(getHandle(), path, path.length);
	}
	
	public String[] getSearchPath() {
		return gtk_icon_theme_get_search_path(getHandle());
	}
	
	public void appendSearchPath(String path) {
		gtk_icon_theme_append_search_path(getHandle(), path);
	}
	
	public void prependSearchPath(String path) {
		gtk_icon_theme_prepend_search_path(getHandle(), path);
	}
	
	public void setCustomtTheme(String name) {
		gtk_icon_theme_set_custom_theme(getHandle(), name);
	}
	
	public boolean hasIcon(String iconName) {
		return gtk_icon_theme_has_icon(getHandle(), iconName);
	}
	
	public IconInfo lookupIcon(String name, int size, IconLookupFlags flags) {
		return new IconInfo(gtk_icon_theme_lookup_icon(getHandle(), name, size, flags.getValue()));
	}
	
	/**
	 * Looks up an icon in an icon theme, scales it to the given 
	 * size and renders it into a pixbuf.  If the icons is not found
	 * this method will return null.
	 * @param name
	 * @param size
	 * @param flags
	 * @return
	 */
	public Pixbuf loadIcon(String name, int size, IconLookupFlags flags) {
		Handle error = GObject.getNullHandle();
		Handle hndl = gtk_icon_theme_load_icon(getHandle(), name, size, flags.getValue(), error);
		if (!error.isNull())
			return null;
		if (null == hndl)
			return null;
		return new Pixbuf(hndl);
	}
	
	public String[] listIcons(String context) {
		return gtk_icon_theme_list_icons(getHandle(), context);
	}
	
	public boolean rescanIfNeeded() {
		return gtk_icon_theme_rescan_if_needed(getHandle());
	}
	
	public static void addBuiltinIcon(String name, int size, Pixbuf pixbuf) {
		gtk_icon_theme_add_builtin_icon(name, size, pixbuf.getHandle());
	}
	
    /**
     * Returns an array of {@link org.gnu.gtk.IconSize} describing the
     * sizes at which the icon is available without scaling. A size of
     * -1 means that the icon is available in a scalable format.
     */
    public IconSize[] getIconSizes( String iconName ) {
        int sizes[] = gtk_icon_theme_get_icon_sizes( getHandle(), iconName );
        IconSize ret[] = new IconSize[ sizes.length ];
        for( int i = 0; i < sizes.length; i++ ) {
            ret[i] = IconSize.intern( sizes[i] );
        }
        return ret;
    }

	native static final protected int gtk_icon_theme_get_type ();
	native static final protected Handle gtk_icon_theme_new();
	native static final protected Handle gtk_icon_theme_get_default();
	native static final protected Handle gtk_icon_theme_get_for_screen(Handle screen);
	native static final protected void gtk_icon_theme_set_screen(Handle itheme, Handle screen);
	native static final protected void gtk_icon_theme_set_search_path(Handle itheme, String[] path, int pathlen);
	native static final protected String[] gtk_icon_theme_get_search_path(Handle itheme);
	native static final protected void gtk_icon_theme_append_search_path(Handle itheme, String path);
	native static final protected void gtk_icon_theme_prepend_search_path(Handle itheme, String path);
	native static final protected void gtk_icon_theme_set_custom_theme(Handle itheme, String name);
	native static final protected boolean gtk_icon_theme_has_icon(Handle itheme, String iconName);
	native static final protected Handle gtk_icon_theme_lookup_icon(Handle itheme, String iconName, int size, int iconLookupFlags);
	native static final protected Handle gtk_icon_theme_load_icon(Handle itheme, String iconName, int size, int iconLookupflags, Handle error);
	native static final protected String[] gtk_icon_theme_list_icons(Handle itheme, String context);
	native static final protected String gtk_icon_theme_get_example_icon_name(Handle itheme);
	native static final protected boolean gtk_icon_theme_rescan_if_needed(Handle itheme);
	native static final protected void gtk_icon_theme_add_builtin_icon(String iconName, int size, Handle pixbuf);

    native static final private Handle gtk_icon_theme_error_quark();
    native static final private int[] gtk_icon_theme_get_icon_sizes(Handle icon_theme, String icon_name);
	
}