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