evince.document.DocumentFindIF source code

1 /*
2  * This file is part of EvinceD.
3  * EvinceD is based on GtkD.
4  *
5  * EvinceD is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License
7  * as published by the Free Software Foundation; either version 3
8  * of the License, or (at your option) any later version, with
9  * some exceptions, please read the COPYING file.
10  *
11  * EvinceD is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with EvinceD; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
19  */
20 
21 // generated automatically - do not change
22 // find conversion definition on APILookup.txt
23 
24 
25 module evince.document.DocumentFindIF;
26 
27 private import evince.document.Page;
28 private import evince.document.c.functions;
29 public  import evince.document.c.types;
30 private import glib.ListG;
31 private import glib.Str;
32 
33 
34 /** */
35 public interface DocumentFindIF{
36 	/** Get the main Gtk struct */
37 	public EvDocumentFind* getDocumentFindStruct(bool transferOwnership = false);
38 
39 	/** the main Gtk struct as a void* */
40 	protected void* getStruct();
41 
42 
43 	/** */
44 	public static GType getType()
45 	{
46 		return ev_document_find_get_type();
47 	}
48 
49 	/**
50 	 *
51 	 * Params:
52 	 *     page = an #EvPage
53 	 *     text = text to find
54 	 *     caseSensitive = whether to match the string case
55 	 * Returns: a list of results
56 	 */
57 	public ListG findText(Page page, string text, bool caseSensitive);
58 
59 	/**
60 	 *
61 	 * Params:
62 	 *     page = an #EvPage
63 	 *     text = text to find
64 	 *     options = a set of #EvFindOptions
65 	 * Returns: a list of results
66 	 */
67 	public ListG findTextWithOptions(Page page, string text, EvFindOptions options);
68 
69 	/** */
70 	public EvFindOptions getSupportedOptions();
71 }