← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/evince/oneiric-updates

« back to all changes in this revision

Viewing changes to help/reference/xml/ev-document-find.xml

  • Committer: Bazaar Package Importer
  • Author(s): Josselin Mouette, Josselin Mouette, Marc 'HE' Brockschmidt
  • Date: 2008-12-31 16:41:58 UTC
  • mfrom: (1.1.36 upstream)
  • mto: (1.5.1 sid)
  • mto: This revision was merged to the branch mainline in revision 109.
  • Revision ID: james.westby@ubuntu.com-20081231164158-xnobl1sokvvc6ho8
Tags: 2.24.2-1
http://bugs.debian.org/506836
[ Josselin Mouette ]
* README.Debian: document that you need to install poppler-data.
  Closes: #506836.

[ Marc 'HE' Brockschmidt ]
* debian/control: Make the Gnome team maintainer. I'm not doing the job
   anyway.

[ Josselin Mouette ]
* New upstream release.
* Require nautilus 2.22 to build the extension for the correct 
  version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
help/reference/xml/ev-document-find.xml
22
22
#define             <link linkend="EV-IS-DOCUMENT-FIND-IFACE:CAPS">EV_IS_DOCUMENT_FIND_IFACE</link>           (k)
23
23
                    <link linkend="EvDocumentFind-struct">EvDocumentFind</link>;
24
24
                    <link linkend="EvDocumentFindIface">EvDocumentFindIface</link>;
25
 
<link linkend="void">void</link>                <link linkend="ev-document-find-begin">ev_document_find_begin</link>              (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
26
 
                                                         <link linkend="int">int</link> page,
27
 
                                                         const <link linkend="char">char</link> *search_string,
 
25
<link linkend="GList">GList</link>*              <link linkend="ev-document-find-find-text">ev_document_find_find_text</link>          (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
 
26
                                                         <link linkend="EvPage">EvPage</link> *page,
 
27
                                                         const <link linkend="gchar">gchar</link> *text,
28
28
                                                         <link linkend="gboolean">gboolean</link> case_sensitive);
29
 
<link linkend="void">void</link>                <link linkend="ev-document-find-cancel">ev_document_find_cancel</link>             (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find);
30
 
<link linkend="int">int</link>                 <link linkend="ev-document-find-page-has-results">ev_document_find_page_has_results</link>   (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
31
 
                                                         <link linkend="int">int</link> page);
32
 
<link linkend="int">int</link>                 <link linkend="ev-document-find-get-n-results">ev_document_find_get_n_results</link>      (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
33
 
                                                         <link linkend="int">int</link> page);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="ev-document-find-get-result">ev_document_find_get_result</link>         (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
35
 
                                                         <link linkend="int">int</link> page,
36
 
                                                         <link linkend="int">int</link> n_result,
37
 
                                                         <link linkend="EvRectangle">EvRectangle</link> *rectangle);
38
 
<link linkend="double">double</link>              <link linkend="ev-document-find-get-progress">ev_document_find_get_progress</link>       (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find);
39
 
<link linkend="void">void</link>                <link linkend="ev-document-find-changed">ev_document_find_changed</link>            (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
40
 
                                                         <link linkend="int">int</link> page);
41
29
 
42
30
</synopsis>
43
31
</refsynopsisdiv>
57
45
 
58
46
 
59
47
 
60
 
<refsect1 role="signal_proto">
61
 
<title role="signal_proto.title">Signals</title>
62
 
<synopsis>
63
 
 
64
 
  &quot;<link linkend="EvDocumentFind-find-changed">find-changed</link>&quot;                                   : Run Last
65
 
</synopsis>
66
 
</refsect1>
67
48
 
68
49
 
69
50
<refsect1 role="desc">
113
94
        GTypeInterface base_iface;
114
95
 
115
96
        /* Methods */
116
 
        
117
 
        void     (* begin)            (EvDocumentFind *document_find,
118
 
                                       int             page,
119
 
                                       const char     *search_string,
120
 
                                       gboolean        case_sensitive);
121
 
        void     (* cancel)           (EvDocumentFind *document_find);
122
 
        int      (* page_has_results) (EvDocumentFind *document_find,
123
 
                                       int             page);
124
 
        int      (* get_n_results)    (EvDocumentFind *document_find,
125
 
                                       int             page);
126
 
        gboolean (* get_result)       (EvDocumentFind *document_find,
127
 
                                       int             page,
128
 
                                       int             n_result,
129
 
                                       EvRectangle    *rectangle); 
130
 
        double   (* get_progress)     (EvDocumentFind *document_find);
131
 
 
132
 
        /* Signals */
133
 
 
134
 
        void     (* find_changed)     (EvDocumentFind *document_find,
135
 
                                       int             page);
 
97
        GList   *(* find_text)     (EvDocumentFind *document_find,
 
98
                                    EvPage         *page,
 
99
                                    const gchar    *text,
 
100
                                    gboolean        case_sensitive);
136
101
} EvDocumentFindIface;
137
102
</programlisting>
138
103
<para>
139
104
 
140
105
</para></refsect2>
141
106
<refsect2>
142
 
<title><anchor id="ev-document-find-begin" role="function"/>ev_document_find_begin ()</title>
143
 
<indexterm><primary>ev_document_find_begin</primary></indexterm><programlisting><link linkend="void">void</link>                ev_document_find_begin              (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
144
 
                                                         <link linkend="int">int</link> page,
145
 
                                                         const <link linkend="char">char</link> *search_string,
 
107
<title><anchor id="ev-document-find-find-text" role="function"/>ev_document_find_find_text ()</title>
 
108
<indexterm><primary>ev_document_find_find_text</primary></indexterm><programlisting><link linkend="GList">GList</link>*              ev_document_find_find_text          (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
 
109
                                                         <link linkend="EvPage">EvPage</link> *page,
 
110
                                                         const <link linkend="gchar">gchar</link> *text,
146
111
                                                         <link linkend="gboolean">gboolean</link> case_sensitive);</programlisting>
147
112
<para>
148
113
 
153
118
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
154
119
<listitem><simpara>
155
120
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><parameter>search_string</parameter>&nbsp;:</term>
 
121
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
157
122
<listitem><simpara>
158
123
</simpara></listitem></varlistentry>
159
124
<varlistentry><term><parameter>case_sensitive</parameter>&nbsp;:</term>
160
125
<listitem><simpara>
161
 
 
162
 
 
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
<refsect2>
166
 
<title><anchor id="ev-document-find-cancel" role="function"/>ev_document_find_cancel ()</title>
167
 
<indexterm><primary>ev_document_find_cancel</primary></indexterm><programlisting><link linkend="void">void</link>                ev_document_find_cancel             (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find);</programlisting>
168
 
<para>
169
 
 
170
 
</para><variablelist role="params">
171
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
172
 
<listitem><simpara>
173
 
 
174
 
 
175
 
</simpara></listitem></varlistentry>
176
 
</variablelist></refsect2>
177
 
<refsect2>
178
 
<title><anchor id="ev-document-find-page-has-results" role="function"/>ev_document_find_page_has_results ()</title>
179
 
<indexterm><primary>ev_document_find_page_has_results</primary></indexterm><programlisting><link linkend="int">int</link>                 ev_document_find_page_has_results   (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
180
 
                                                         <link linkend="int">int</link> page);</programlisting>
181
 
<para>
182
 
 
183
 
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
185
 
<listitem><simpara>
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
188
 
<listitem><simpara>
189
 
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
191
 
 
192
 
 
193
 
</simpara></listitem></varlistentry>
194
 
</variablelist></refsect2>
195
 
<refsect2>
196
 
<title><anchor id="ev-document-find-get-n-results" role="function"/>ev_document_find_get_n_results ()</title>
197
 
<indexterm><primary>ev_document_find_get_n_results</primary></indexterm><programlisting><link linkend="int">int</link>                 ev_document_find_get_n_results      (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
198
 
                                                         <link linkend="int">int</link> page);</programlisting>
199
 
<para>
200
 
 
201
 
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
203
 
<listitem><simpara>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
206
 
<listitem><simpara>
207
 
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
209
 
 
210
 
 
211
 
</simpara></listitem></varlistentry>
212
 
</variablelist></refsect2>
213
 
<refsect2>
214
 
<title><anchor id="ev-document-find-get-result" role="function"/>ev_document_find_get_result ()</title>
215
 
<indexterm><primary>ev_document_find_get_result</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ev_document_find_get_result         (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
216
 
                                                         <link linkend="int">int</link> page,
217
 
                                                         <link linkend="int">int</link> n_result,
218
 
                                                         <link linkend="EvRectangle">EvRectangle</link> *rectangle);</programlisting>
219
 
<para>
220
 
 
221
 
</para><variablelist role="params">
222
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
223
 
<listitem><simpara>
224
 
</simpara></listitem></varlistentry>
225
 
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
226
 
<listitem><simpara>
227
 
</simpara></listitem></varlistentry>
228
 
<varlistentry><term><parameter>n_result</parameter>&nbsp;:</term>
229
 
<listitem><simpara>
230
 
</simpara></listitem></varlistentry>
231
 
<varlistentry><term><parameter>rectangle</parameter>&nbsp;:</term>
232
 
<listitem><simpara>
233
 
</simpara></listitem></varlistentry>
234
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
235
 
 
236
 
 
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist></refsect2>
239
 
<refsect2>
240
 
<title><anchor id="ev-document-find-get-progress" role="function"/>ev_document_find_get_progress ()</title>
241
 
<indexterm><primary>ev_document_find_get_progress</primary></indexterm><programlisting><link linkend="double">double</link>              ev_document_find_get_progress       (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find);</programlisting>
242
 
<para>
243
 
 
244
 
</para><variablelist role="params">
245
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
246
 
<listitem><simpara>
247
 
</simpara></listitem></varlistentry>
248
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
249
 
 
250
 
 
251
 
</simpara></listitem></varlistentry>
252
 
</variablelist></refsect2>
253
 
<refsect2>
254
 
<title><anchor id="ev-document-find-changed" role="function"/>ev_document_find_changed ()</title>
255
 
<indexterm><primary>ev_document_find_changed</primary></indexterm><programlisting><link linkend="void">void</link>                ev_document_find_changed            (<link linkend="EvDocumentFind">EvDocumentFind</link> *document_find,
256
 
                                                         <link linkend="int">int</link> page);</programlisting>
257
 
<para>
258
 
 
259
 
</para><variablelist role="params">
260
 
<varlistentry><term><parameter>document_find</parameter>&nbsp;:</term>
261
 
<listitem><simpara>
262
 
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
264
 
<listitem><simpara>
265
 
 
266
 
 
267
 
</simpara></listitem></varlistentry>
268
 
</variablelist></refsect2>
269
 
 
270
 
</refsect1>
271
 
 
272
 
<refsect1 role="signals">
273
 
<title role="signals.title">Signal Details</title>
274
 
<refsect2><title><anchor id="EvDocumentFind-find-changed"/>The <literal>&quot;find-changed&quot;</literal> signal</title>
275
 
<indexterm><primary>EvDocumentFind::find-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EvDocumentFind">EvDocumentFind</link> *evdocumentfind,
276
 
                                                        <link linkend="gint">gint</link>            arg1,
277
 
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
278
 
<para>
279
 
 
280
 
</para><variablelist role="params">
281
 
<varlistentry><term><parameter>evdocumentfind</parameter>&nbsp;:</term>
282
 
<listitem><simpara>the object which received the signal.
283
 
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
285
 
<listitem><simpara>
286
 
 
287
 
</simpara></listitem></varlistentry>
288
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
289
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
290
 
</variablelist></refsect2>
291
 
</refsect1>
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
128
 
 
129
 
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
 
 
133
</refsect1>
 
134
 
292
135
 
293
136
 
294
137