gimpthumb-enums.h 3.49 KB
Newer Older
1 2 3 4
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * Thumbnail handling according to the Thumbnail Managing Standard.
5
 * https://specifications.freedesktop.org/thumbnail-spec/
6 7 8 9
 *
 * Copyright (C) 2001-2003  Sven Neumann <sven@gimp.org>
 *                          Michael Natterer <mitch@gimp.org>
 *
10
 * This library is free software: you can redistribute it and/or
11 12
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
13
 * version 3 of the License, or (at your option) any later version.
14 15 16 17 18 19 20
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
21
 * License along with this library.  If not, see
22
 * <https://www.gnu.org/licenses/>.
23 24 25 26 27
 */

#ifndef __GIMP_THUMB_ENUMS_H__
#define __GIMP_THUMB_ENUMS_H__

28 29
G_BEGIN_DECLS

30

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/**
 * SECTION: gimpthumb-enums
 * @title: GimpThumb-enums
 * @short_description: Enumerations used by libgimpthumb
 *
 * Enumerations used by libgimpthumb
 **/


/**
 * GimpThumbFileType:
 * @GIMP_THUMB_FILE_TYPE_NONE:    file does not exist
 * @GIMP_THUMB_FILE_TYPE_REGULAR: a regular file
 * @GIMP_THUMB_FILE_TYPE_FOLDER:  a directory
 * @GIMP_THUMB_FILE_TYPE_SPECIAL: a special file (device node, fifo, socket, ...)
 *
 * File types as returned by gimp_thumb_file_test().
 **/
49 50 51 52 53 54 55 56 57 58 59 60 61
#define GIMP_TYPE_THUMB_FILE_TYPE (gimp_thumb_file_type_get_type ())

GType gimp_thumb_file_type_get_type (void) G_GNUC_CONST;

typedef enum
{
  GIMP_THUMB_FILE_TYPE_NONE,
  GIMP_THUMB_FILE_TYPE_REGULAR,
  GIMP_THUMB_FILE_TYPE_FOLDER,
  GIMP_THUMB_FILE_TYPE_SPECIAL
} GimpThumbFileType;


62 63 64 65 66 67 68
/**
 * GimpThumbSize:
 * @GIMP_THUMB_SIZE_FAIL:   special size used to indicate a thumbnail
 *                          creation failure
 * @GIMP_THUMB_SIZE_NORMAL: normal thumbnail size (128 pixels)
 * @GIMP_THUMB_SIZE_LARGE:  large thumbnail size (256 pixels)
 *
69
 * Possible thumbnail sizes as defined by the Thumbnail Managing
70 71
 * Standard.
 **/
72 73 74 75 76 77 78 79 80 81 82 83
#define GIMP_TYPE_THUMB_SIZE (gimp_thumb_size_get_type ())

GType gimp_thumb_size_get_type (void) G_GNUC_CONST;

typedef enum
{
  GIMP_THUMB_SIZE_FAIL   = 0,
  GIMP_THUMB_SIZE_NORMAL = 128,
  GIMP_THUMB_SIZE_LARGE  = 256
} GimpThumbSize;


84 85 86 87
/**
 * GimpThumbState:
 * @GIMP_THUMB_STATE_UNKNOWN:   nothing is known about the file/thumbnail
 * @GIMP_THUMB_STATE_REMOTE:    the file is on a remote file system
88 89
 * @GIMP_THUMB_STATE_FOLDER:    the file is a directory
 * @GIMP_THUMB_STATE_SPECIAL:   the file is a special file
90 91 92 93 94 95 96 97
 * @GIMP_THUMB_STATE_NOT_FOUND: the file/thumbnail doesn't exist
 * @GIMP_THUMB_STATE_EXISTS:    the file/thumbnail exists
 * @GIMP_THUMB_STATE_OLD:       the thumbnail may be outdated
 * @GIMP_THUMB_STATE_FAILED:    the thumbnail couldn't be created
 * @GIMP_THUMB_STATE_OK:        the thumbnail exists and matches the image
 *
 * Possible image and thumbnail file states used by libgimpthumb.
 **/
98 99 100 101 102 103 104 105
#define GIMP_TYPE_THUMB_STATE (gimp_thumb_state_get_type ())

GType gimp_thumb_state_get_type (void) G_GNUC_CONST;

typedef enum
{
  GIMP_THUMB_STATE_UNKNOWN,
  GIMP_THUMB_STATE_REMOTE,
106 107
  GIMP_THUMB_STATE_FOLDER,
  GIMP_THUMB_STATE_SPECIAL,
108 109
  GIMP_THUMB_STATE_NOT_FOUND,
  GIMP_THUMB_STATE_EXISTS,
110 111 112
  GIMP_THUMB_STATE_OLD,
  GIMP_THUMB_STATE_FAILED,
  GIMP_THUMB_STATE_OK
113 114 115
} GimpThumbState;


116 117
G_END_DECLS

118
#endif  /* __GIMP_THUMB_ENUMS_H__ */