gee/bidirmapiterator.vala

   1 /* bidiriterator.vala
   2  *
   3  * Copyright (C) 2009  Didier Villevalois, Maciej Piechotka
   4  * Copyright (C) 2011  Maciej Piechotka
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  19  *
  20  * Author:
  21  *      Maciej Piechotka <uzytkownik2@gmail.com>
  22  */
  23
  24 /**
  25  * A bi-directional Map iterator.
  26  */
  27 [GenericAccessors]
  28 public interface Gee.BidirMapIterator<K,V> : Gee.MapIterator<K,V> {
  29         /**
  30          * Rewinds to the previous element in the iteration.
  31          *
  32          * @return `true` if the iterator has a previous element
  33          */
  34         public abstract bool previous ();
  35
  36         /**
  37          * Checks whether there is a previous element in the iteration.
  38          *
  39          * @return `true` if the iterator has a previous element
  40          */
  41         public abstract bool has_previous ();
  42
  43         /**
  44          * Goes back to the first element.
  45          *
  46          * @return `true` if the iterator has a first element
  47          */
  48         public abstract bool first ();
  49
  50         /**
  51          * Advances to the last element in the iteration.
  52          *
  53          * @return `true` if the iterator has a last element
  54          */
  55         public abstract bool last ();
  56 }