1 /*
2  * This file is part of d-dazzle.
3  *
4  * d-dazzle is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * d-dazzle is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with d-dazzle; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 module dazzle.FuzzyIndexCursor;
20 
21 private import dazzle.FuzzyIndex;
22 private import dazzle.c.functions;
23 public  import dazzle.c.types;
24 private import gio.AsyncInitableIF;
25 private import gio.AsyncInitableT;
26 private import gio.ListModelIF;
27 private import gio.ListModelT;
28 private import gobject.ObjectG;
29 
30 
31 /** */
32 public class FuzzyIndexCursor : ObjectG, AsyncInitableIF, ListModelIF
33 {
34 	/** the main Gtk struct */
35 	protected DzlFuzzyIndexCursor* dzlFuzzyIndexCursor;
36 
37 	/** Get the main Gtk struct */
38 	public DzlFuzzyIndexCursor* getFuzzyIndexCursorStruct(bool transferOwnership = false)
39 	{
40 		if (transferOwnership)
41 			ownedRef = false;
42 		return dzlFuzzyIndexCursor;
43 	}
44 
45 	/** the main Gtk struct as a void* */
46 	protected override void* getStruct()
47 	{
48 		return cast(void*)dzlFuzzyIndexCursor;
49 	}
50 
51 	/**
52 	 * Sets our main struct and passes it to the parent class.
53 	 */
54 	public this (DzlFuzzyIndexCursor* dzlFuzzyIndexCursor, bool ownedRef = false)
55 	{
56 		this.dzlFuzzyIndexCursor = dzlFuzzyIndexCursor;
57 		super(cast(GObject*)dzlFuzzyIndexCursor, ownedRef);
58 	}
59 
60 	// add the AsyncInitable capabilities
61 	mixin AsyncInitableT!(DzlFuzzyIndexCursor);
62 
63 	// add the ListModel capabilities
64 	mixin ListModelT!(DzlFuzzyIndexCursor);
65 
66 
67 	/** */
68 	public static GType getType()
69 	{
70 		return dzl_fuzzy_index_cursor_get_type();
71 	}
72 
73 	/**
74 	 * Gets the index the cursor is iterating.
75 	 *
76 	 * Returns: A #DzlFuzzyIndex.
77 	 */
78 	public FuzzyIndex getIndex()
79 	{
80 		auto p = dzl_fuzzy_index_cursor_get_index(dzlFuzzyIndexCursor);
81 
82 		if(p is null)
83 		{
84 			return null;
85 		}
86 
87 		return ObjectG.getDObject!(FuzzyIndex)(cast(DzlFuzzyIndex*) p);
88 	}
89 }