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(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return gtkSourceCompletionWords;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected override void* getStruct()
54 	{
55 		return cast(void*)gtkSourceCompletionWords;
56 	}
57 
58 	protected override void setStruct(GObject* obj)
59 	{
60 		gtkSourceCompletionWords = cast(GtkSourceCompletionWords*)obj;
61 		super.setStruct(obj);
62 	}
63 
64 	/**
65 	 * Sets our main struct and passes it to the parent class.
66 	 */
67 	public this (GtkSourceCompletionWords* gtkSourceCompletionWords, bool ownedRef = false)
68 	{
69 		this.gtkSourceCompletionWords = gtkSourceCompletionWords;
70 		super(cast(GObject*)gtkSourceCompletionWords, ownedRef);
71 	}
72 
73 	// add the SourceCompletionProvider capabilities
74 	mixin SourceCompletionProviderT!(GtkSourceCompletionWords);
75 
76 
77 	/** */
78 	public static GType getType()
79 	{
80 		return gtk_source_completion_words_get_type();
81 	}
82 
83 	/**
84 	 *
85 	 * Params:
86 	 *     name = The name for the provider, or %NULL.
87 	 *     icon = A specific icon for the provider, or %NULL.
88 	 * Returns: a new #GtkSourceCompletionWords provider
89 	 *
90 	 * Throws: ConstructionException GTK+ fails to create the object.
91 	 */
92 	public this(string name, Pixbuf icon)
93 	{
94 		auto p = gtk_source_completion_words_new(Str.toStringz(name), (icon is null) ? null : icon.getPixbufStruct());
95 		
96 		if(p is null)
97 		{
98 			throw new ConstructionException("null returned by new");
99 		}
100 		
101 		this(cast(GtkSourceCompletionWords*) p, true);
102 	}
103 
104 	/**
105 	 * Registers @buffer in the @words provider.
106 	 *
107 	 * Params:
108 	 *     buffer = a #GtkTextBuffer
109 	 */
110 	public void register(TextBuffer buffer)
111 	{
112 		gtk_source_completion_words_register(gtkSourceCompletionWords, (buffer is null) ? null : buffer.getTextBufferStruct());
113 	}
114 
115 	/**
116 	 * Unregisters @buffer from the @words provider.
117 	 *
118 	 * Params:
119 	 *     buffer = a #GtkTextBuffer
120 	 */
121 	public void unregister(TextBuffer buffer)
122 	{
123 		gtk_source_completion_words_unregister(gtkSourceCompletionWords, (buffer is null) ? null : buffer.getTextBufferStruct());
124 	}
125 }