← Back to branch summary

~ubuntu-branches/ubuntu/breezy/gimp/breezy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-10-04 19:04:46 UTC
  • Revision ID: james.westby@ubuntu.com-20051004190446-ukh32kwk56s4sjhu
Tags: upstream-2.2.8
Import upstream version 2.2.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpthumb/xml/gimpthumb-error.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="libgimpthumb-gimpthumb-error">
 
6
<refmeta>
 
7
<refentrytitle>gimpthumb-error</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPTHUMB Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimpthumb-error</refname><refpurpose>Error codes used by libgimpthumb</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
enum        <link linkend="GimpThumbError">GimpThumbError</link>;
 
23
#define     <link linkend="GIMP-THUMB-ERROR:CAPS">GIMP_THUMB_ERROR</link>
 
24
<link linkend="GQuark">GQuark</link>      <link linkend="gimp-thumb-error-quark">gimp_thumb_error_quark</link>          (void);
 
25
</synopsis>
 
26
</refsynopsisdiv>
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
<refsect1>
 
37
<title>Description</title>
 
38
<para>
 
39
 
 
40
</para>
 
41
</refsect1>
 
42
 
 
43
<refsect1>
 
44
<title>Details</title>
 
45
<refsect2>
 
46
<title><anchor id="GimpThumbError"/>enum GimpThumbError</title>
 
47
<indexterm><primary>GimpThumbError</primary></indexterm><programlisting>typedef enum
 
48
{
 
49
  GIMP_THUMB_ERROR_OPEN,         /*  open failed                            */
 
50
  GIMP_THUMB_ERROR_OPEN_ENOENT,  /*  file does not exist                    */
 
51
  GIMP_THUMB_ERROR_MKDIR         /*  mkdir failed                           */
 
52
} GimpThumbError;
 
53
</programlisting>
 
54
<para>
 
55
These are the possible error codes used when a <link linkend="GError"><type>GError</type></link> is set by
 
56
libgimpthumb.
 
57
</para><variablelist role="enum">
 
58
<varlistentry>
 
59
<term><literal>GIMP_THUMB_ERROR_OPEN</literal></term>
 
60
<listitem><simpara>        there was a problem opening the file
 
61
</simpara></listitem>
 
62
</varlistentry>
 
63
<varlistentry>
 
64
<term><literal>GIMP_THUMB_ERROR_OPEN_ENOENT</literal></term>
 
65
<listitem><simpara> the file doesn't exist
 
66
</simpara></listitem>
 
67
</varlistentry>
 
68
<varlistentry>
 
69
<term><literal>GIMP_THUMB_ERROR_MKDIR</literal></term>
 
70
<listitem><simpara>       there was a problem creating a directory
 
71
 
 
72
</simpara></listitem>
 
73
</varlistentry>
 
74
</variablelist></refsect2>
 
75
<refsect2>
 
76
<title><anchor id="GIMP-THUMB-ERROR:CAPS"/>GIMP_THUMB_ERROR</title>
 
77
<indexterm><primary>GIMP_THUMB_ERROR</primary></indexterm><programlisting>#define GIMP_THUMB_ERROR (gimp_thumb_error_quark ())
 
78
</programlisting>
 
79
<para>
 
80
Identifier for the libgimpthumb error domain.
 
81
</para></refsect2>
 
82
<refsect2>
 
83
<title><anchor id="gimp-thumb-error-quark"/>gimp_thumb_error_quark ()</title>
 
84
<indexterm><primary>gimp_thumb_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      gimp_thumb_error_quark          (void);</programlisting>
 
85
<para>
 
86
This function is never called directly. Use <link linkend="GIMP-THUMB-ERROR:CAPS"><function>GIMP_THUMB_ERROR()</function></link> instead.</para>
 
87
<para>
 
88
 
 
89
</para><variablelist role="params">
 
90
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GQuark"><type>GQuark</type></link> that defines the GimpThumb error domain.
 
91
</simpara></listitem></varlistentry>
 
92
</variablelist></refsect2>
 
93
 
 
94
</refsect1>
 
95
 
 
96
 
 
97
 
 
98
 
 
99
</refentry>