← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libedataserverui/xml/e-book-auth-util.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserverui/xml/e-book-auth-util.xml
1
 
<?xml version="1.0"?>
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
 
<refentry id="libedataserverui-e-book-auth-util">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedataserverui-e-book-auth-util.top_of_page">e-book-auth-util</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVERUI Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-book-auth-util</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedataserverui-e-book-auth-util.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis><link linkend="EBook"><returnvalue>EBook</returnvalue></link> *             <link linkend="e-load-book-source">e_load_book_source</link>                  (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
21
 
                                                         <parameter><link linkend="EBookCallback"><type>EBookCallback</type></link> open_func</parameter>,
22
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
23
 
</synopsis>
24
 
</refsynopsisdiv>
25
 
 
26
 
<refsect1 id="libedataserverui-e-book-auth-util.description" role="desc">
27
 
<title role="desc.title">Description</title>
28
 
<para>
29
 
</para>
30
 
</refsect1>
31
 
<refsect1 id="libedataserverui-e-book-auth-util.details" role="details">
32
 
<title role="details.title">Details</title>
33
 
<refsect2 id="e-load-book-source" role="function">
34
 
<title>e_load_book_source ()</title>
35
 
<indexterm zone="e-load-book-source"><primary>e_load_book_source</primary></indexterm>
36
 
<programlisting><link linkend="EBook"><returnvalue>EBook</returnvalue></link> *             e_load_book_source                  (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
37
 
                                                         <parameter><link linkend="EBookCallback"><type>EBookCallback</type></link> open_func</parameter>,
38
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
39
 
<para>
40
 
Creates a new <link linkend="EBook"><type>EBook</type></link> specified by <parameter>source</parameter>, and starts a non-blocking
41
 
open operation on it. If the book requires authorization, presents
42
 
a window asking the user for such.
43
 
</para>
44
 
<para>
45
 
When the operation finishes, calls the callback function indicating
46
 
if it succeeded or not. If you don't care, you can pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for
47
 
<parameter>open_func</parameter>, and no action will be taken on completion.</para>
48
 
<variablelist role="params">
49
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
50
 
<listitem><simpara>an <link linkend="ESource"><type>ESource</type></link>
51
 
</simpara></listitem></varlistentry>
52
 
<varlistentry><term><parameter>open_func</parameter>&#160;:</term>
53
 
<listitem><simpara>a function to call when the operation finishes, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
54
 
</simpara></listitem></varlistentry>
55
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
56
 
<listitem><simpara>data to pass to callback function
57
 
</simpara></listitem></varlistentry>
58
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBook"><type>EBook</type></link> that is being opened.
59
 
</simpara></listitem></varlistentry>
60
 
</variablelist></refsect2>
61
 
 
62
 
</refsect1>
63
 
 
64
 
</refentry>