demos/spiv/image_list.h

   1 /*****************************************************************************
   2  * This file is part of gfxprim library.                                     *
   3  *                                                                           *
   4  * Gfxprim is free software; you can redistribute it and/or                  *
   5  * modify it under the terms of the GNU Lesser General Public                *
   6  * License as published by the Free Software Foundation; either              *
   7  * version 2.1 of the License, or (at your option) any later version.        *
   8  *                                                                           *
   9  * Gfxprim is distributed in the hope that it will be useful,                *
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  12  * Lesser General Public License for more details.                           *
  13  *                                                                           *
  14  * You should have received a copy of the GNU Lesser General Public          *
  15  * License along with gfxprim; if not, write to the Free Software            *
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor,                        *
  17  * Boston, MA  02110-1301  USA                                               *
  18  *                                                                           *
  19  * Copyright (C) 2009-2013 Cyril Hrubis <metan@ucw.cz>                       *
  20  *                                                                           *
  21  *****************************************************************************/
  22
  23  /*
  24
  25    Image list.
  26
  27   */
  28
  29 #ifndef __IMAGE_LIST_H__
  30 #define __IMAGE_LIST_H__
  31
  32 struct image_list;
  33
  34 /*
  35  * Takes NULL-terminated array of paths as parameter
  36  */
  37 struct image_list *image_list_create(const char *args[]);
  38
  39
  40 void image_list_destroy(struct image_list *self);
  41
  42 /*
  43  * Returns path to the current image.
  44  */
  45 const char *image_list_img_path(struct image_list *self);
  46
  47 /*
  48  * Moves the current image direction images and returns pointer to current
  49  * path.
  50  */
  51 const char *image_list_move(struct image_list *self, int direction);
  52
  53 /*
  54  * If we are in directory:
  55  *  if direction > 0: move to its end and if allready there, to the next arg
  56  *  if direction < 0: move to its begining and if allready there, to the previous arg
  57  *
  58  * If we aren't in directory move by one in corresponding direction.
  59  */
  60 const char *image_list_dir_move(struct image_list *self, int direction);
  61
  62 /*
  63  * Move to the first image in the list.
  64  */
  65 const char *image_list_first(struct image_list *self);
  66
  67 /*
  68  * Move to the last image in the list.
  69  */
  70 const char *image_list_last(struct image_list *self);
  71
  72 /*
  73  * Counts images int the list.
  74  */
  75 unsigned int image_list_count(struct image_list *self);
  76
  77 /*
  78  * Returns current position in list, i.e. number between 0 and count - 1.
  79  */
  80 unsigned int image_list_pos(struct image_list *self);
  81
  82 /*
  83  * Returns numbe of images in current dir or 0 if current arg is file.
  84  */
  85 unsigned int image_list_dir_count(struct image_list *self);
  86
  87 /*
  88  * Returns current position in current dir or 0 if current arg is file.
  89  */
  90 unsigned int image_list_dir_pos(struct image_list *self);
  91
  92 #endif /* __IMAGE_LIST_H__ */