/*
 * 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.glib.Handle;
import org.gnu.glib.Type;

/**
 * A widget that lists the available fonts, styles and sizes, allowing the
 * user to select a font.  It is used in the {@link FontSelectionDialog} 
 * widget to provide a dialog box for selecting fonts.
 * @see FontSelectionDialog
 */
public class FontSelection extends VBox {
	/**
	 * Creates a new font selection widget
	 */
	public FontSelection() {
		super(gtk_font_selection_new());
	}
	
	/**
	 * Construct a new FontSelection from a handle to a native resource.
	 */
	public FontSelection(Handle handle) {
	    super(handle);
	}
	
	/**
	 * Exception used when a request was made to set a font which is not
	 * available.
	 */
	class FontNotFoundException extends Exception {
	}

	/**
	 * Sets the currently-selected font.
	 * @param font The name of the font to be selected
	 */
	public void setFont(String font) throws FontNotFoundException {
		if (!gtk_font_selection_set_font_name(getHandle(), font)) {
			throw new FontNotFoundException();
		}
	}

	/**
	 * Returns the name of the currently selected font.
	 * @return The name of the selected font.
	 */
	public String getFont() {
		return gtk_font_selection_get_font_name(getHandle());
	}

	/**
	 * Returns the text which appears in the preview box.
	 */
	public String getPreviewText() {
		return gtk_font_selection_get_preview_text(getHandle());
	}

	/**
	 * Sets the text to appear in the preview box.
	 * @param previewText The text which should appear in the preview box
	 */
	public void getPreviewText(String previewText) {
		gtk_font_selection_set_preview_text(getHandle(), previewText);
	}

	/**
	 * Retrieve the runtime type used by the GLib library.
	 */
	public static Type getType() {
		return new Type(gtk_font_selection_get_type());
	}

	native static final protected int gtk_font_selection_get_type();
	native static final protected Handle gtk_font_selection_new();
	native static final protected String gtk_font_selection_get_font_name(Handle fontsel);
	native static final protected boolean gtk_font_selection_set_font_name(Handle fontsel, String fontname);
	native static final protected String gtk_font_selection_get_preview_text(Handle fontsel);
	native static final protected void gtk_font_selection_set_preview_text(Handle fontsel, String text);

    /* Deprecated functions.
    native static final private Handle gtk_font_selection_get_font(Handle fontsel);
    */

}