gsv.SourceCompletionWords source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD 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  * gtkD 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 gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gsv.SourceCompletionWords;
26 
27 private import gdkpixbuf.Pixbuf;
28 private import glib.ConstructionException;
29 private import glib.Str;
30 private import gobject.ObjectG;
31 private import gsv.SourceCompletionProviderIF;
32 private import gsv.SourceCompletionProviderT;
33 private import gsvc.gsv;
34 public  import gsvc.gsvtypes;
35 private import gtk.TextBuffer;
36 
37 
38 /** */
39 public class SourceCompletionWords : ObjectG, SourceCompletionProviderIF
40 {
41 	/** the main Gtk struct */
42 	protected GtkSourceCompletionWords* gtkSourceCompletionWords;
43 
44 	/** Get the main Gtk struct */
45 	public GtkSourceCompletionWords* getSourceCompletionWordsStruct()
46 	{
47 		return gtkSourceCompletionWords;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gtkSourceCompletionWords;
54 	}
55 
56 	protected override void setStruct(GObject* obj)
57 	{
58 		gtkSourceCompletionWords = cast(GtkSourceCompletionWords*)obj;
59 		super.setStruct(obj);
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (GtkSourceCompletionWords* gtkSourceCompletionWords, bool ownedRef = false)
66 	{
67 		this.gtkSourceCompletionWords = gtkSourceCompletionWords;
68 		super(cast(GObject*)gtkSourceCompletionWords, ownedRef);
69 	}
70 
71 	// add the SourceCompletionProvider capabilities
72 	mixin SourceCompletionProviderT!(GtkSourceCompletionWords);
73 
74 
75 	/** */
76 	public static GType getType()
77 	{
78 		return gtk_source_completion_words_get_type();
79 	}
80 
81 	/**
82 	 *
83 	 * Params:
84 	 *     name = The name for the provider, or %NULL.
85 	 *     icon = A specific icon for the provider, or %NULL.
86 	 * Returns: a new #GtkSourceCompletionWords provider
87 	 *
88 	 * Throws: ConstructionException GTK+ fails to create the object.
89 	 */
90 	public this(string name, Pixbuf icon)
91 	{
92 		auto p = gtk_source_completion_words_new(Str.toStringz(name), (icon is null) ? null : icon.getPixbufStruct());
93 		
94 		if(p is null)
95 		{
96 			throw new ConstructionException("null returned by new");
97 		}
98 		
99 		this(cast(GtkSourceCompletionWords*) p, true);
100 	}
101 
102 	/**
103 	 * Registers @buffer in the @words provider.
104 	 *
105 	 * Params:
106 	 *     buffer = a #GtkTextBuffer
107 	 */
108 	public void register(TextBuffer buffer)
109 	{
110 		gtk_source_completion_words_register(gtkSourceCompletionWords, (buffer is null) ? null : buffer.getTextBufferStruct());
111 	}
112 
113 	/**
114 	 * Unregisters @buffer from the @words provider.
115 	 *
116 	 * Params:
117 	 *     buffer = a #GtkTextBuffer
118 	 */
119 	public void unregister(TextBuffer buffer)
120 	{
121 		gtk_source_completion_words_unregister(gtkSourceCompletionWords, (buffer is null) ? null : buffer.getTextBufferStruct());
122 	}
123 }