← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

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 role="top_of_page" id="libgimpthumb-gimpthumb-error.top_of_page">gimpthumb-error</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMPTHUMB Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpthumb-error</refname>
14
 
<refpurpose>Error codes used by libgimpthumb</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimpthumb-gimpthumb-error.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
enum                <link linkend="GimpThumbError">GimpThumbError</link>;
22
 
#define             <link linkend="GIMP-THUMB-ERROR--CAPS">GIMP_THUMB_ERROR</link>
23
 
<link linkend="GQuark">GQuark</link>              <link linkend="gimp-thumb-error-quark">gimp_thumb_error_quark</link>              (void);
24
 
</synopsis>
25
 
</refsynopsisdiv>
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
<refsect1 id="libgimpthumb-gimpthumb-error.description" role="desc">
36
 
<title role="desc.title">Description</title>
37
 
<para>
38
 
</para>
39
 
</refsect1>
40
 
 
41
 
<refsect1 id="libgimpthumb-gimpthumb-error.details" role="details">
42
 
<title role="details.title">Details</title>
43
 
<refsect2 id="GimpThumbError" role="enum">
44
 
<title>enum GimpThumbError</title>
45
 
<indexterm zone="GimpThumbError"><primary sortas="GimpThumbError">GimpThumbError</primary></indexterm><programlisting>typedef enum
46
 
{
47
 
  GIMP_THUMB_ERROR_OPEN,         /*  open failed                            */
48
 
  GIMP_THUMB_ERROR_OPEN_ENOENT,  /*  file does not exist                    */
49
 
  GIMP_THUMB_ERROR_MKDIR         /*  mkdir failed                           */
50
 
} GimpThumbError;
51
 
</programlisting>
52
 
<para>
53
 
These are the possible error codes used when a <link linkend="GError"><type>GError</type></link> is set by
54
 
libgimpthumb.
55
 
</para><variablelist role="enum">
56
 
<varlistentry id="GIMP-THUMB-ERROR-OPEN--CAPS" role="constant">
57
 
<term><literal>GIMP_THUMB_ERROR_OPEN</literal></term>
58
 
<listitem><simpara>        there was a problem opening the file
59
 
</simpara></listitem>
60
 
</varlistentry>
61
 
<varlistentry id="GIMP-THUMB-ERROR-OPEN-ENOENT--CAPS" role="constant">
62
 
<term><literal>GIMP_THUMB_ERROR_OPEN_ENOENT</literal></term>
63
 
<listitem><simpara> the file doesn't exist
64
 
</simpara></listitem>
65
 
</varlistentry>
66
 
<varlistentry id="GIMP-THUMB-ERROR-MKDIR--CAPS" role="constant">
67
 
<term><literal>GIMP_THUMB_ERROR_MKDIR</literal></term>
68
 
<listitem><simpara>       there was a problem creating a directory
69
 
</simpara></listitem>
70
 
</varlistentry>
71
 
</variablelist></refsect2>
72
 
<refsect2 id="GIMP-THUMB-ERROR--CAPS" role="macro">
73
 
<title>GIMP_THUMB_ERROR</title>
74
 
<indexterm zone="GIMP-THUMB-ERROR--CAPS"><primary sortas="GIMP_THUMB_ERROR">GIMP_THUMB_ERROR</primary></indexterm><programlisting>#define GIMP_THUMB_ERROR (gimp_thumb_error_quark ())
75
 
</programlisting>
76
 
<para>
77
 
Identifier for the libgimpthumb error domain.
78
 
</para></refsect2>
79
 
<refsect2 id="gimp-thumb-error-quark" role="function">
80
 
<title>gimp_thumb_error_quark ()</title>
81
 
<indexterm zone="gimp-thumb-error-quark"><primary sortas="gimp_thumb_error_quark">gimp_thumb_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>              gimp_thumb_error_quark              (void);</programlisting>
82
 
<para>
83
 
This function is never called directly. Use <link linkend="GIMP-THUMB-ERROR--CAPS"><function>GIMP_THUMB_ERROR()</function></link> instead.</para>
84
 
<para>
85
 
</para><variablelist role="params">
86
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GQuark"><type>GQuark</type></link> that defines the GimpThumb error domain.
87
 
</simpara></listitem></varlistentry>
88
 
</variablelist></refsect2>
89
 
 
90
 
</refsect1>
91
 
 
92
 
 
93
 
 
94
 
 
95
 
</refentry>