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