1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<refentry id="gok-gok-feedback">
<refmeta>
<refentrytitle role="top_of_page" id="gok-gok-feedback.top_of_page">gok-feedback</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GOK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gok-feedback</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="gok-gok-feedback.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GokFeedback">GokFeedback</link>* <link linkend="gok-feedback-new">gok_feedback_new</link> (void);
<link linkend="void">void</link> <link linkend="gok-feedback-free">gok_feedback_free</link> (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);
<link linkend="gboolean">gboolean</link> <link linkend="gok-feedback-open">gok_feedback_open</link> (void);
<link linkend="void">void</link> <link linkend="gok-feedback-close">gok_feedback_close</link> (void);
<link linkend="GokFeedback">GokFeedback</link>* <link linkend="gok-feedback-get-first-feedback">gok_feedback_get_first_feedback</link> (void);
<link linkend="GokFeedback">GokFeedback</link>* <link linkend="gok-feedback-find-feedback">gok_feedback_find_feedback</link> (<link linkend="gchar">gchar</link> *NameFeedback,
<link linkend="gboolean">gboolean</link> bDisplayName);
<link linkend="void">void</link> <link linkend="gok-feedback-add-feedback">gok_feedback_add_feedback</link> (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackNew);
<link linkend="void">void</link> <link linkend="gok-feedback-delete-feedback">gok_feedback_delete_feedback</link> (<link linkend="GokFeedback">GokFeedback</link> *pFeedbackDelete);
<link linkend="void">void</link> <link linkend="gok-feedback-backup">gok_feedback_backup</link> (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);
<link linkend="gboolean">gboolean</link> <link linkend="gok-feedback-revert">gok_feedback_revert</link> (<link linkend="GokFeedback">GokFeedback</link> *pFeedback);
</synopsis>
</refsynopsisdiv>
<refsect1 id="gok-gok-feedback.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="gok-gok-feedback.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="gok-feedback-new" role="function">
<title>gok_feedback_new ()</title>
<indexterm zone="gok-feedback-new"><primary>gok_feedback_new</primary></indexterm><programlisting><link linkend="GokFeedback">GokFeedback</link>* gok_feedback_new (void);</programlisting>
<para>
Allocates memory for a new GokFeedback and initializes its attributes
to default values. Please free the returned GokFeedback using
gok_feedback_free.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to a new GokFeedback.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-free" role="function">
<title>gok_feedback_free ()</title>
<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>
<para>
Frees a GokFeedback and associated resources.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pFeedback</parameter> :</term>
<listitem><simpara> Pointer to the feedback that will be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-open" role="function">
<title>gok_feedback_open ()</title>
<indexterm zone="gok-feedback-open"><primary>gok_feedback_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gok_feedback_open (void);</programlisting>
<para>
Initializes the gok feedbacks and reads them from GConf.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the feedbacks were initialized, FALSE if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-close" role="function">
<title>gok_feedback_close ()</title>
<indexterm zone="gok-feedback-close"><primary>gok_feedback_close</primary></indexterm><programlisting><link linkend="void">void</link> gok_feedback_close (void);</programlisting>
<para>
Closes the gok feedbacks and saves them in GConf.</para>
<para>
</para></refsect2>
<refsect2 id="gok-feedback-get-first-feedback" role="function">
<title>gok_feedback_get_first_feedback ()</title>
<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>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the first feedback in the list of feedbacks.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-find-feedback" role="function">
<title>gok_feedback_find_feedback ()</title>
<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,
<link linkend="gboolean">gboolean</link> bDisplayName);</programlisting>
<para>
Finds the feedback from within our list of feedbacks.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>NameFeedback</parameter> :</term>
<listitem><simpara> Name of the feedback you're trying to find.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bDisplayName</parameter> :</term>
<listitem><simpara> This should be set TRUE if you are passing in the display
name of the feedback. It should be set FALSE if passing in the actual
name of the feedback.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the feedback, NULL if not found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-add-feedback" role="function">
<title>gok_feedback_add_feedback ()</title>
<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>
<para>
Adds a new feedback to our list of feedbacks.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pFeedbackNew</parameter> :</term>
<listitem><simpara> Pointer to an feedback that gets added to our list of feedbacks.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-delete-feedback" role="function">
<title>gok_feedback_delete_feedback ()</title>
<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>
<para>
Deletes the given feedback and unhooks it from our list of feedbacks.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pFeedbackDelete</parameter> :</term>
<listitem><simpara> Pointer to the feedback that will be deleted.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-backup" role="function">
<title>gok_feedback_backup ()</title>
<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>
<para>
Creates a copy of all the data stored on the feedback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pFeedback</parameter> :</term>
<listitem><simpara> Pointer to the feedback that will be backed up.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gok-feedback-revert" role="function">
<title>gok_feedback_revert ()</title>
<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>
<para>
Moves the backup data to the current data on the feedback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pFeedback</parameter> :</term>
<listitem><simpara> Pointer to the feedback that will be reverted.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if any of the reverted settings are different from the
current settings. Returns FALSE if the reverted settings are the same
as the current settings.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|