← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gok/karmic

« back to all changes in this revision

Viewing changes to docs/reference/xml/gok-feedback.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2008-07-15 10:17:46 UTC
  • mfrom: (1.1.16 upstream)
  • Revision ID: james.westby@ubuntu.com-20080715101746-3fie18s3rcgb5hb5
Tags: 1.4.0-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gok-feedback.xml
1
1
<refentry id="gok-gok-feedback">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">gok-feedback</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gok-gok-feedback.top_of_page">gok-feedback</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GOK Library</refmiscinfo>
6
6
</refmeta>
11
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
12
</refnamediv>
13
13
 
14
 
<refsynopsisdiv role="synopsis">
 
14
<refsynopsisdiv id="gok-gok-feedback.synopsis" role="synopsis">
15
15
<title role="synopsis.title">Synopsis</title>
16
16
 
17
17
<synopsis>
18
 
 
19
 
 
20
 
 
21
18
<link linkend="GokFeedback">GokFeedback</link>*        <link linkend="gok-feedback-new">gok_feedback_new</link>                    (void);
22
19
<link linkend="void">void</link>                <link linkend="gok-feedback-free">gok_feedback_free</link>                   (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);
23
20
<link linkend="gboolean">gboolean</link>            <link linkend="gok-feedback-open">gok_feedback_open</link>                   (void);
40
37
 
41
38
 
42
39
 
43
 
<refsect1 role="desc">
 
40
<refsect1 id="gok-gok-feedback.description" role="desc">
44
41
<title role="desc.title">Description</title>
45
42
<para>
46
43
 
47
44
</para>
48
45
</refsect1>
49
46
 
50
 
<refsect1 role="details">
 
47
<refsect1 id="gok-gok-feedback.details" role="details">
51
48
<title role="details.title">Details</title>
52
 
<refsect2>
53
 
<title><anchor id="gok-feedback-new" role="function"/>gok_feedback_new ()</title>
54
 
<indexterm><primary>gok_feedback_new</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_new                    (void);</programlisting>
 
49
<refsect2 id="gok-feedback-new" role="function">
 
50
<title>gok_feedback_new ()</title>
 
51
<indexterm zone="gok-feedback-new"><primary>gok_feedback_new</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_new                    (void);</programlisting>
55
52
<para>
56
53
Allocates memory for a new GokFeedback and initializes its attributes
57
54
to default values. Please free the returned GokFeedback using
62
59
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to a new GokFeedback.
63
60
</simpara></listitem></varlistentry>
64
61
</variablelist></refsect2>
65
 
<refsect2>
66
 
<title><anchor id="gok-feedback-free" role="function"/>gok_feedback_free ()</title>
67
 
<indexterm><primary>gok_feedback_free</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_free                   (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
 
62
<refsect2 id="gok-feedback-free" role="function">
 
63
<title>gok_feedback_free ()</title>
 
64
<indexterm zone="gok-feedback-free"><primary>gok_feedback_free</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_free                   (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
68
65
<para>
69
66
Frees a GokFeedback and associated resources.</para>
70
67
<para>
74
71
<listitem><simpara> Pointer to the feedback that will be freed.
75
72
</simpara></listitem></varlistentry>
76
73
</variablelist></refsect2>
77
 
<refsect2>
78
 
<title><anchor id="gok-feedback-open" role="function"/>gok_feedback_open ()</title>
79
 
<indexterm><primary>gok_feedback_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gok_feedback_open                   (void);</programlisting>
 
74
<refsect2 id="gok-feedback-open" role="function">
 
75
<title>gok_feedback_open ()</title>
 
76
<indexterm zone="gok-feedback-open"><primary>gok_feedback_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gok_feedback_open                   (void);</programlisting>
80
77
<para>
81
78
Initializes the gok feedbacks and reads them from GConf.</para>
82
79
<para>
85
82
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the feedbacks were initialized, FALSE if not.
86
83
</simpara></listitem></varlistentry>
87
84
</variablelist></refsect2>
88
 
<refsect2>
89
 
<title><anchor id="gok-feedback-close" role="function"/>gok_feedback_close ()</title>
90
 
<indexterm><primary>gok_feedback_close</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_close                  (void);</programlisting>
 
85
<refsect2 id="gok-feedback-close" role="function">
 
86
<title>gok_feedback_close ()</title>
 
87
<indexterm zone="gok-feedback-close"><primary>gok_feedback_close</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_close                  (void);</programlisting>
91
88
<para>
92
89
Closes the gok feedbacks and saves them in GConf.</para>
93
90
<para>
94
91
 
95
92
</para></refsect2>
96
 
<refsect2>
97
 
<title><anchor id="gok-feedback-get-first-feedback" role="function"/>gok_feedback_get_first_feedback ()</title>
98
 
<indexterm><primary>gok_feedback_get_first_feedback</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_get_first_feedback     (void);</programlisting>
 
93
<refsect2 id="gok-feedback-get-first-feedback" role="function">
 
94
<title>gok_feedback_get_first_feedback ()</title>
 
95
<indexterm zone="gok-feedback-get-first-feedback"><primary>gok_feedback_get_first_feedback</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_get_first_feedback     (void);</programlisting>
99
96
<para>
100
97
</para>
101
98
<para>
104
101
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the first feedback in the list of feedbacks.
105
102
</simpara></listitem></varlistentry>
106
103
</variablelist></refsect2>
107
 
<refsect2>
108
 
<title><anchor id="gok-feedback-find-feedback" role="function"/>gok_feedback_find_feedback ()</title>
109
 
<indexterm><primary>gok_feedback_find_feedback</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_find_feedback          (<link linkend="gchar">gchar</link> *NameFeedback,
 
104
<refsect2 id="gok-feedback-find-feedback" role="function">
 
105
<title>gok_feedback_find_feedback ()</title>
 
106
<indexterm zone="gok-feedback-find-feedback"><primary>gok_feedback_find_feedback</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>*        gok_feedback_find_feedback          (<link linkend="gchar">gchar</link> *NameFeedback,
110
107
                                                         <link linkend="gboolean">gboolean</link> bDisplayName);</programlisting>
111
108
<para>
112
109
Finds the feedback from within our list of feedbacks.</para>
124
121
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the feedback, NULL if not found.
125
122
</simpara></listitem></varlistentry>
126
123
</variablelist></refsect2>
127
 
<refsect2>
128
 
<title><anchor id="gok-feedback-add-feedback" role="function"/>gok_feedback_add_feedback ()</title>
129
 
<indexterm><primary>gok_feedback_add_feedback</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_add_feedback           (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackNew);</programlisting>
 
124
<refsect2 id="gok-feedback-add-feedback" role="function">
 
125
<title>gok_feedback_add_feedback ()</title>
 
126
<indexterm zone="gok-feedback-add-feedback"><primary>gok_feedback_add_feedback</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_add_feedback           (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackNew);</programlisting>
130
127
<para>
131
128
Adds a new feedback to our list of feedbacks.</para>
132
129
<para>
136
133
<listitem><simpara> Pointer to an feedback that gets added to our list of feedbacks.
137
134
</simpara></listitem></varlistentry>
138
135
</variablelist></refsect2>
139
 
<refsect2>
140
 
<title><anchor id="gok-feedback-delete-feedback" role="function"/>gok_feedback_delete_feedback ()</title>
141
 
<indexterm><primary>gok_feedback_delete_feedback</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_delete_feedback        (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackDelete);</programlisting>
 
136
<refsect2 id="gok-feedback-delete-feedback" role="function">
 
137
<title>gok_feedback_delete_feedback ()</title>
 
138
<indexterm zone="gok-feedback-delete-feedback"><primary>gok_feedback_delete_feedback</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_delete_feedback        (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackDelete);</programlisting>
142
139
<para>
143
140
Deletes the given feedback and unhooks it from our list of feedbacks.</para>
144
141
<para>
148
145
<listitem><simpara> Pointer to the feedback that will be deleted.
149
146
</simpara></listitem></varlistentry>
150
147
</variablelist></refsect2>
151
 
<refsect2>
152
 
<title><anchor id="gok-feedback-backup" role="function"/>gok_feedback_backup ()</title>
153
 
<indexterm><primary>gok_feedback_backup</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_backup                 (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
 
148
<refsect2 id="gok-feedback-backup" role="function">
 
149
<title>gok_feedback_backup ()</title>
 
150
<indexterm zone="gok-feedback-backup"><primary>gok_feedback_backup</primary></indexterm><programlisting><link linkend="void">void</link>                gok_feedback_backup                 (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
154
151
<para>
155
152
Creates a copy of all the data stored on the feedback.</para>
156
153
<para>
160
157
<listitem><simpara> Pointer to the feedback that will be backed up.
161
158
</simpara></listitem></varlistentry>
162
159
</variablelist></refsect2>
163
 
<refsect2>
164
 
<title><anchor id="gok-feedback-revert" role="function"/>gok_feedback_revert ()</title>
165
 
<indexterm><primary>gok_feedback_revert</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gok_feedback_revert                 (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
 
160
<refsect2 id="gok-feedback-revert" role="function">
 
161
<title>gok_feedback_revert ()</title>
 
162
<indexterm zone="gok-feedback-revert"><primary>gok_feedback_revert</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gok_feedback_revert                 (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);</programlisting>
166
163
<para>
167
164
Moves the backup data to the current data on the feedback.</para>
168
165
<para>