~timchen119/ubuntu/trusty/gnome-bluetooth/lp1035431

« back to all changes in this revision

Viewing changes to docs/reference/libgnome-bluetooth/xml/bling-spinner.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2011-02-27 15:45:22 UTC
  • mfrom: (1.3.2 upstream)
  • mto: (2.2.3 experimental) (1.5.1)
  • mto: This revision was merged to the branch mainline in revision 53.
  • Revision ID: james.westby@ubuntu.com-20110227154522-dnnoqasv5v3mv42a
Tags: upstream-2.91.5
ImportĀ upstreamĀ versionĀ 2.91.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<refentry id="gnome-bluetooth-BlingSpinner">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-bluetooth-BlingSpinner.top_of_page">BlingSpinner</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>GNOME-BLUETOOTH Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BlingSpinner</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="gnome-bluetooth-BlingSpinner.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="BlingSpinnerPrivate">BlingSpinnerPrivate</link>;
18
 
                    <link linkend="BlingSpinner">BlingSpinner</link>;
19
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="bling-spinner-new">bling_spinner_new</link>                   (void);
20
 
<link linkend="void">void</link>                <link linkend="bling-spinner-start">bling_spinner_start</link>                 (<link linkend="BlingSpinner">BlingSpinner</link> *spinner);
21
 
<link linkend="void">void</link>                <link linkend="bling-spinner-stop">bling_spinner_stop</link>                  (<link linkend="BlingSpinner">BlingSpinner</link> *spinner);
22
 
</synopsis>
23
 
</refsynopsisdiv>
24
 
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
<refsect1 id="gnome-bluetooth-BlingSpinner.description" role="desc">
34
 
<title role="desc.title">Description</title>
35
 
<para>
36
 
</para>
37
 
</refsect1>
38
 
 
39
 
<refsect1 id="gnome-bluetooth-BlingSpinner.details" role="details">
40
 
<title role="details.title">Details</title>
41
 
<refsect2 id="BlingSpinnerPrivate" role="struct">
42
 
<title>BlingSpinnerPrivate</title>
43
 
<indexterm zone="BlingSpinnerPrivate"><primary sortas="BlingSpinnerPrivate">BlingSpinnerPrivate</primary></indexterm><programlisting>typedef struct _BlingSpinnerPrivate BlingSpinnerPrivate;</programlisting>
44
 
<para>
45
 
</para></refsect2>
46
 
<refsect2 id="BlingSpinner" role="struct">
47
 
<title>BlingSpinner</title>
48
 
<indexterm zone="BlingSpinner"><primary sortas="BlingSpinner">BlingSpinner</primary></indexterm><programlisting>typedef struct {
49
 
        GtkDrawingArea parent;
50
 
} BlingSpinner;
51
 
</programlisting>
52
 
<para>
53
 
</para></refsect2>
54
 
<refsect2 id="bling-spinner-new" role="function">
55
 
<title>bling_spinner_new ()</title>
56
 
<indexterm zone="bling-spinner-new"><primary sortas="bling_spinner_new">bling_spinner_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         bling_spinner_new                   (void);</programlisting>
57
 
<para>
58
 
Returns a default spinner. Not yet started.</para>
59
 
<para>
60
 
</para><variablelist role="params">
61
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="BlingSpinner"><type>BlingSpinner</type></link>
62
 
</simpara></listitem></varlistentry>
63
 
</variablelist></refsect2>
64
 
<refsect2 id="bling-spinner-start" role="function">
65
 
<title>bling_spinner_start ()</title>
66
 
<indexterm zone="bling-spinner-start"><primary sortas="bling_spinner_start">bling_spinner_start</primary></indexterm><programlisting><link linkend="void">void</link>                bling_spinner_start                 (<link linkend="BlingSpinner">BlingSpinner</link> *spinner);</programlisting>
67
 
<para>
68
 
Starts the animation</para>
69
 
<para>
70
 
</para><variablelist role="params">
71
 
<varlistentry><term><parameter>spinner</parameter>&#160;:</term>
72
 
<listitem><simpara>
73
 
</simpara></listitem></varlistentry>
74
 
</variablelist></refsect2>
75
 
<refsect2 id="bling-spinner-stop" role="function">
76
 
<title>bling_spinner_stop ()</title>
77
 
<indexterm zone="bling-spinner-stop"><primary sortas="bling_spinner_stop">bling_spinner_stop</primary></indexterm><programlisting><link linkend="void">void</link>                bling_spinner_stop                  (<link linkend="BlingSpinner">BlingSpinner</link> *spinner);</programlisting>
78
 
<para>
79
 
Stops the animation</para>
80
 
<para>
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>spinner</parameter>&#160;:</term>
83
 
<listitem><simpara>
84
 
</simpara></listitem></varlistentry>
85
 
</variablelist></refsect2>
86
 
 
87
 
</refsect1>
88
 
 
89
 
 
90
 
 
91
 
 
92
 
</refentry>