dazzle.SuggestionEntryBuffer source code

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.SuggestionEntryBuffer;
20 
21 private import dazzle.Suggestion;
22 private import dazzle.c.functions;
23 public  import dazzle.c.types;
24 private import glib.ConstructionException;
25 private import glib.Str;
26 private import gobject.ObjectG;
27 private import gtk.EntryBuffer;
28 
29 
30 /** */
31 public class SuggestionEntryBuffer : EntryBuffer
32 {
33 	/** the main Gtk struct */
34 	protected DzlSuggestionEntryBuffer* dzlSuggestionEntryBuffer;
35 
36 	/** Get the main Gtk struct */
37 	public DzlSuggestionEntryBuffer* getSuggestionEntryBufferStruct(bool transferOwnership = false)
38 	{
39 		if (transferOwnership)
40 			ownedRef = false;
41 		return dzlSuggestionEntryBuffer;
42 	}
43 
44 	/** the main Gtk struct as a void* */
45 	protected override void* getStruct()
46 	{
47 		return cast(void*)dzlSuggestionEntryBuffer;
48 	}
49 
50 	/**
51 	 * Sets our main struct and passes it to the parent class.
52 	 */
53 	public this (DzlSuggestionEntryBuffer* dzlSuggestionEntryBuffer, bool ownedRef = false)
54 	{
55 		this.dzlSuggestionEntryBuffer = dzlSuggestionEntryBuffer;
56 		super(cast(GtkEntryBuffer*)dzlSuggestionEntryBuffer, ownedRef);
57 	}
58 
59 
60 	/** */
61 	public static GType getType()
62 	{
63 		return dzl_suggestion_entry_buffer_get_type();
64 	}
65 
66 	/** */
67 	public this()
68 	{
69 		auto p = dzl_suggestion_entry_buffer_new();
70 
71 		if(p is null)
72 		{
73 			throw new ConstructionException("null returned by new");
74 		}
75 
76 		this(cast(DzlSuggestionEntryBuffer*) p, true);
77 	}
78 
79 	/** */
80 	public void clear()
81 	{
82 		dzl_suggestion_entry_buffer_clear(dzlSuggestionEntryBuffer);
83 	}
84 
85 	/** */
86 	public void commit()
87 	{
88 		dzl_suggestion_entry_buffer_commit(dzlSuggestionEntryBuffer);
89 	}
90 
91 	/**
92 	 * Gets the #DzlSuggestion that is the current "preview suffix" of the
93 	 * text in the entry.
94 	 *
95 	 * Returns: An #DzlSuggestion or %NULL.
96 	 */
97 	public Suggestion getSuggestion()
98 	{
99 		auto p = dzl_suggestion_entry_buffer_get_suggestion(dzlSuggestionEntryBuffer);
100 
101 		if(p is null)
102 		{
103 			return null;
104 		}
105 
106 		return ObjectG.getDObject!(Suggestion)(cast(DzlSuggestion*) p);
107 	}
108 
109 	/** */
110 	public uint getTypedLength()
111 	{
112 		return dzl_suggestion_entry_buffer_get_typed_length(dzlSuggestionEntryBuffer);
113 	}
114 
115 	/** */
116 	public string getTypedText()
117 	{
118 		return Str.toString(dzl_suggestion_entry_buffer_get_typed_text(dzlSuggestionEntryBuffer));
119 	}
120 
121 	/**
122 	 * Sets the current suggestion for the entry buffer.
123 	 *
124 	 * The suggestion is used to get a potential suffix for the current entry
125 	 * text. This allows the entry to show "preview text" after the entered
126 	 * text for what might be inserted should they activate the current item.
127 	 *
128 	 * Params:
129 	 *     suggestion = An #DzlSuggestion or %NULL
130 	 */
131 	public void setSuggestion(Suggestion suggestion)
132 	{
133 		dzl_suggestion_entry_buffer_set_suggestion(dzlSuggestionEntryBuffer, (suggestion is null) ? null : suggestion.getSuggestionStruct());
134 	}
135 }