/*
 * 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.Atom;
import org.gnu.gdk.Display;
import org.gnu.gdk.Pixbuf;
import org.gnu.glib.Boxed;
import org.gnu.glib.Handle;
/**
 *  The Clipboard object represents a clipboard of data shared between
 *  different processes or between different widgets in the same process.
 *
 * <p>TODO: This requires gdk.Selections
 * <p>TODO: callback functions
 */
public class Clipboard extends Boxed 
{
	/**
	 */
	protected Clipboard(Handle handle){
		super(handle);
	}

	/**
	 * Clear the contents of the clipboard.
	 */
	public void clear() {
		gtk_clipboard_clear(getHandle());
	}
	
	/**
	 * Returns the clipboard object for the given selection. 
	 * See {@link Clipboard#getForDisplay(Display, Atom)} for complete details.
	 * @param atom  a {@link Atom} which identifies the clipboard to use
	 * @return  the appropriate clipboard object. If no clipboard already exists, 
	 * 			a new one will be created. Once a clipboard object has been created, 
	 * 			it is persistent for all time and cannot be freed.
	 */
	static public Clipboard get(Atom atom) {
		return new Clipboard(gtk_clipboard_get(atom.getHandle()));
	}
	
	/**
	 * 
	 * @param display the display for which the clipboard is to be retrieved or created
	 * @param atom a {@link Atom} which identifies the clipboard to use
	 * @return he appropriate clipboard object. If no clipboard already exists, 
	 * 			a new one will be created. Once a clipboard object has been created, 
	 * 			it is persistent for all time and cannot be freed.
	 * 
	 * TODO: write JNI
	 */
	static public Clipboard getForDisplay (Display display, Atom atom) {
		return null;
	}
	
	/**
	 * Gets the {@link Display} associated with clipboard.
	 *
	 * @return the {@link Display} associated with clipboard
	 */	
	public Display getDisplay() {
		return new Display(gtk_clipboard_get_display(getHandle()));
	}
	
	/**
	 * Requests the contents of the clipboard as {@link SelectionData}
	 * @param atom an {@link Atom} representing the form into which the 
	 * 			clipboard owner should convert the selection
	 * @return  a newly-allocated {@link SelectionData} object or <code>NULL</code>   
	 * 			if retrieving the given target failed
	 * 
	 * TODO: write the JNI
	 */
	public SelectionData getContents(Atom atom) {
		return null;
	}
	
	public boolean isTextAvailable() {
		return gtk_clipboard_wait_is_text_available(getHandle());
	}
	
	public boolean isImageAvailable() {
		return gtk_clipboard_wait_is_image_available(getHandle());
	}
	
	/**
	 * Set the contents of the clipboard.
	 */
	public void setText(String text) {
		gtk_clipboard_set_text(getHandle(), text, text.length());
	}
	
	/**
	 * Requests the contents of the clipboard as text.
	 */
	public String getText() {
		return gtk_clipboard_wait_for_text(getHandle());
	}
	
	public void setImage(Pixbuf pixbuf) {
		gtk_clipboard_set_image(getHandle(), pixbuf.getHandle());
	}
	
	public Pixbuf getImage() {
		return new Pixbuf(gtk_clipboard_wait_for_image(getHandle()));
	}
	
	public void setCanStore(TargetEntry[] targets) {
		if (null == targets)
			return;
		Handle[] hndls = new Handle[targets.length];
		for (int i = 0; i < targets.length; i++)
			hndls[i] = targets[i].getHandle();
		gtk_clipboard_set_can_store(getHandle(), hndls);
	}
	
	public void store() {
		gtk_clipboard_store(getHandle());
	}
	

    native static final protected Handle gtk_clipboard_get (Handle selection);
    native static final protected Handle gtk_clipboard_get_display(Handle clipboard);
    native static final protected Handle gtk_clipboard_get_owner (Handle clipboard);
    native static final protected void gtk_clipboard_clear (Handle clipboard);
    native static final protected void gtk_clipboard_set_text (Handle clipboard, String text, int len);
    native static final protected void gtk_clipboard_set_image(Handle clipboard, Handle pixbuf);
    native static final protected String gtk_clipboard_wait_for_text (Handle clipboard);
    native static final protected Handle gtk_clipboard_wait_for_image(Handle clipboard);
    native static final protected boolean gtk_clipboard_wait_is_text_available (Handle clipboard);
    native static final protected boolean gtk_clipboard_wait_is_image_available(Handle clipboard);
    native static final protected boolean gtk_clipboard_wait_is_target_available(Handle clipboard, Handle target);
    native static final protected void gtk_clipboard_set_can_store(Handle clipboard, Handle[] targets);
    native static final protected void gtk_clipboard_store(Handle clipboard);

}