← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpthumb/xml/gimpthumb-enums.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpthumb/xml/gimpthumb-enums.xml
12
12
<refnamediv>
13
13
<refname>gimpthumb-enums</refname>
14
14
<refpurpose>Enumerations used by libgimpthumb</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpthumb-gimpthumb-enums.synopsis" role="synopsis">
36
35
<refsect1 id="libgimpthumb-gimpthumb-enums.description" role="desc">
37
36
<title role="desc.title">Description</title>
38
37
<para>
39
 
 
40
38
</para>
41
39
</refsect1>
42
40
 
44
42
<title role="details.title">Details</title>
45
43
<refsect2 id="GimpThumbFileType" role="enum">
46
44
<title>enum GimpThumbFileType</title>
47
 
<indexterm zone="GimpThumbFileType"><primary>GimpThumbFileType</primary></indexterm><programlisting>typedef enum
 
45
<indexterm zone="GimpThumbFileType"><primary sortas="GimpThumbFileType">GimpThumbFileType</primary></indexterm><programlisting>typedef enum
48
46
{
49
47
  GIMP_THUMB_FILE_TYPE_NONE,
50
48
  GIMP_THUMB_FILE_TYPE_REGULAR,
55
53
<para>
56
54
File types as returned by <link linkend="gimp-thumb-file-test"><function>gimp_thumb_file_test()</function></link>.
57
55
</para><variablelist role="enum">
58
 
<varlistentry id="GIMP-THUMB-FILE-TYPE-NONE:CAPS" role="constant">
 
56
<varlistentry id="GIMP-THUMB-FILE-TYPE-NONE--CAPS" role="constant">
59
57
<term><literal>GIMP_THUMB_FILE_TYPE_NONE</literal></term>
60
58
<listitem><simpara>    file does not exist
61
59
</simpara></listitem>
62
60
</varlistentry>
63
 
<varlistentry id="GIMP-THUMB-FILE-TYPE-REGULAR:CAPS" role="constant">
 
61
<varlistentry id="GIMP-THUMB-FILE-TYPE-REGULAR--CAPS" role="constant">
64
62
<term><literal>GIMP_THUMB_FILE_TYPE_REGULAR</literal></term>
65
63
<listitem><simpara> a regular file
66
64
</simpara></listitem>
67
65
</varlistentry>
68
 
<varlistentry id="GIMP-THUMB-FILE-TYPE-FOLDER:CAPS" role="constant">
 
66
<varlistentry id="GIMP-THUMB-FILE-TYPE-FOLDER--CAPS" role="constant">
69
67
<term><literal>GIMP_THUMB_FILE_TYPE_FOLDER</literal></term>
70
68
<listitem><simpara>  a directory
71
69
</simpara></listitem>
72
70
</varlistentry>
73
 
<varlistentry id="GIMP-THUMB-FILE-TYPE-SPECIAL:CAPS" role="constant">
 
71
<varlistentry id="GIMP-THUMB-FILE-TYPE-SPECIAL--CAPS" role="constant">
74
72
<term><literal>GIMP_THUMB_FILE_TYPE_SPECIAL</literal></term>
75
73
<listitem><simpara> a special file (device node, fifo, socket, ...)
76
 
 
77
74
</simpara></listitem>
78
75
</varlistentry>
79
76
</variablelist></refsect2>
80
77
<refsect2 id="GimpThumbSize" role="enum">
81
78
<title>enum GimpThumbSize</title>
82
 
<indexterm zone="GimpThumbSize"><primary>GimpThumbSize</primary></indexterm><programlisting>typedef enum
 
79
<indexterm zone="GimpThumbSize"><primary sortas="GimpThumbSize">GimpThumbSize</primary></indexterm><programlisting>typedef enum
83
80
{
84
81
  GIMP_THUMB_SIZE_FAIL   = 0,
85
82
  GIMP_THUMB_SIZE_NORMAL = 128,
89
86
<para>
90
87
Possible thumbnail sizes as defined by the Thumbnail Managaging Standard
91
88
</para><variablelist role="enum">
92
 
<varlistentry id="GIMP-THUMB-SIZE-FAIL:CAPS" role="constant">
 
89
<varlistentry id="GIMP-THUMB-SIZE-FAIL--CAPS" role="constant">
93
90
<term><literal>GIMP_THUMB_SIZE_FAIL</literal></term>
94
91
<listitem><simpara>   special size used to indicate a thumbnail
95
92
                          creation failure
96
93
</simpara></listitem>
97
94
</varlistentry>
98
 
<varlistentry id="GIMP-THUMB-SIZE-NORMAL:CAPS" role="constant">
 
95
<varlistentry id="GIMP-THUMB-SIZE-NORMAL--CAPS" role="constant">
99
96
<term><literal>GIMP_THUMB_SIZE_NORMAL</literal></term>
100
97
<listitem><simpara> normal thumbnail size (128 pixels)
101
98
</simpara></listitem>
102
99
</varlistentry>
103
 
<varlistentry id="GIMP-THUMB-SIZE-LARGE:CAPS" role="constant">
 
100
<varlistentry id="GIMP-THUMB-SIZE-LARGE--CAPS" role="constant">
104
101
<term><literal>GIMP_THUMB_SIZE_LARGE</literal></term>
105
102
<listitem><simpara>  large thumbnail size (256 pixels)
106
 
 
107
103
</simpara></listitem>
108
104
</varlistentry>
109
105
</variablelist></refsect2>
110
106
<refsect2 id="GimpThumbState" role="enum">
111
107
<title>enum GimpThumbState</title>
112
 
<indexterm zone="GimpThumbState"><primary>GimpThumbState</primary></indexterm><programlisting>typedef enum
 
108
<indexterm zone="GimpThumbState"><primary sortas="GimpThumbState">GimpThumbState</primary></indexterm><programlisting>typedef enum
113
109
{
114
110
  GIMP_THUMB_STATE_UNKNOWN,
115
111
  GIMP_THUMB_STATE_REMOTE,
125
121
<para>
126
122
Possible image and thumbnail file states used by libgimpthumb.
127
123
</para><variablelist role="enum">
128
 
<varlistentry id="GIMP-THUMB-STATE-UNKNOWN:CAPS" role="constant">
 
124
<varlistentry id="GIMP-THUMB-STATE-UNKNOWN--CAPS" role="constant">
129
125
<term><literal>GIMP_THUMB_STATE_UNKNOWN</literal></term>
130
126
<listitem><simpara>   nothing is known about the file/thumbnail
131
127
</simpara></listitem>
132
128
</varlistentry>
133
 
<varlistentry id="GIMP-THUMB-STATE-REMOTE:CAPS" role="constant">
 
129
<varlistentry id="GIMP-THUMB-STATE-REMOTE--CAPS" role="constant">
134
130
<term><literal>GIMP_THUMB_STATE_REMOTE</literal></term>
135
131
<listitem><simpara>    the file is on a remote file system
136
132
</simpara></listitem>
137
133
</varlistentry>
138
 
<varlistentry id="GIMP-THUMB-STATE-FOLDER:CAPS" role="constant">
 
134
<varlistentry id="GIMP-THUMB-STATE-FOLDER--CAPS" role="constant">
139
135
<term><literal>GIMP_THUMB_STATE_FOLDER</literal></term>
140
136
<listitem><simpara>
141
137
</simpara></listitem>
142
138
</varlistentry>
143
 
<varlistentry id="GIMP-THUMB-STATE-SPECIAL:CAPS" role="constant">
 
139
<varlistentry id="GIMP-THUMB-STATE-SPECIAL--CAPS" role="constant">
144
140
<term><literal>GIMP_THUMB_STATE_SPECIAL</literal></term>
145
141
<listitem><simpara>
146
142
</simpara></listitem>
147
143
</varlistentry>
148
 
<varlistentry id="GIMP-THUMB-STATE-NOT-FOUND:CAPS" role="constant">
 
144
<varlistentry id="GIMP-THUMB-STATE-NOT-FOUND--CAPS" role="constant">
149
145
<term><literal>GIMP_THUMB_STATE_NOT_FOUND</literal></term>
150
146
<listitem><simpara> the file/thumbnail doesn't exist
151
147
</simpara></listitem>
152
148
</varlistentry>
153
 
<varlistentry id="GIMP-THUMB-STATE-EXISTS:CAPS" role="constant">
 
149
<varlistentry id="GIMP-THUMB-STATE-EXISTS--CAPS" role="constant">
154
150
<term><literal>GIMP_THUMB_STATE_EXISTS</literal></term>
155
151
<listitem><simpara>    the file/thumbnail exists
156
152
</simpara></listitem>
157
153
</varlistentry>
158
 
<varlistentry id="GIMP-THUMB-STATE-OLD:CAPS" role="constant">
 
154
<varlistentry id="GIMP-THUMB-STATE-OLD--CAPS" role="constant">
159
155
<term><literal>GIMP_THUMB_STATE_OLD</literal></term>
160
156
<listitem><simpara>       the thumbnail may be outdated
161
157
</simpara></listitem>
162
158
</varlistentry>
163
 
<varlistentry id="GIMP-THUMB-STATE-FAILED:CAPS" role="constant">
 
159
<varlistentry id="GIMP-THUMB-STATE-FAILED--CAPS" role="constant">
164
160
<term><literal>GIMP_THUMB_STATE_FAILED</literal></term>
165
161
<listitem><simpara>    the thumbnail couldn't be created
166
162
</simpara></listitem>
167
163
</varlistentry>
168
 
<varlistentry id="GIMP-THUMB-STATE-OK:CAPS" role="constant">
 
164
<varlistentry id="GIMP-THUMB-STATE-OK--CAPS" role="constant">
169
165
<term><literal>GIMP_THUMB_STATE_OK</literal></term>
170
166
<listitem><simpara>        the thumbnail exists and matches the image
171
 
 
172
167
</simpara></listitem>
173
168
</varlistentry>
174
169
</variablelist></refsect2>