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


/**
 * The AttrIterator object is used to represent an iterator through a 
 * List. A new iterator is created with pango_attr_list_get_iterator(). Once
 * the iterator is created, it can be advanced through the style changes in the
 * text using pango_attr_iterator_next(). At each style change, the range of the
 * current style segment and the attributes currently in effect can be queried.
 *
 *
 * todo: is this needed?
 */
public class AttrIterator extends Boxed 
{
	public AttrIterator(Handle handle) {
		this.handle = handle;
	}
	
	/**
	 * Create a copy of the provided iterator.
	 * @param iter
	 */
	public AttrIterator(AttrIterator iter) {
	    super(pango_attr_iterator_copy(iter.getHandle()));
	}
	
	/**
	 * Advance the iterator until the next change of style.
	 * 
	 * @return false if the iterator is at the end of the list.
	 */
	public boolean next() {
		return pango_attr_iterator_next(handle);
	}
	
	/**
	 * Return the beginning of the current segment range.
	 */
	public int getRangeStart() {
	    int[] start = new int[1];
	    int[] end = new int[1];
	    pango_attr_iterator_range(getHandle(), start, end);
	    return start[0];
	}

	/**
	 * Return the end of the current segment range.
	 */
	public int getRangeEnd() {
	    int[] start = new int[1];
	    int[] end = new int[1];
	    pango_attr_iterator_range(getHandle(), start, end);
	    return end[0];
	}
	
	/**
	 * Find the current attribute of a particular type at the iterator location.
	 * When multiple attributes of the same type overlap, the attribute whose
	 * range starts closest to the current location is used. 
	 */
	public Attribute get(AttrType type) {
	    return new Attribute(pango_attr_iterator_get(getHandle(), type.getValue()));
	}
	
    protected void finalize() throws Throwable {
        super.finalize();
        pango_attr_iterator_destroy(getHandle());
    }

    
    native static final protected void pango_attr_iterator_range (Handle iterator, int [] start, int [] end);
    native static final protected boolean pango_attr_iterator_next (Handle iterator);
    native static final protected Handle pango_attr_iterator_copy (Handle iterator);
    native static final protected void pango_attr_iterator_destroy (Handle iterator);
    native static final protected Handle pango_attr_iterator_get (Handle iterator, int type);

}