gtk.StringObject 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 gtk.StringObject;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import glib.c.functions;
30 private import gobject.ObjectG;
31 private import gtk.c.functions;
32 public  import gtk.c.types;
33 
34 
35 /**
36  * `GtkStringObject` is the type of items in a `GtkStringList`.
37  * 
38  * A `GtkStringObject` is a wrapper around a `const char*`; it has
39  * a [property@Gtk.StringObject:string] property.
40  */
41 public class StringObject : ObjectG
42 {
43 	/** the main Gtk struct */
44 	protected GtkStringObject* gtkStringObject;
45 
46 	/** Get the main Gtk struct */
47 	public GtkStringObject* getStringObjectStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return gtkStringObject;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)gtkStringObject;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GtkStringObject* gtkStringObject, bool ownedRef = false)
64 	{
65 		this.gtkStringObject = gtkStringObject;
66 		super(cast(GObject*)gtkStringObject, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return gtk_string_object_get_type();
74 	}
75 
76 	/**
77 	 * Wraps a string in an object for use with `GListModel`.
78 	 *
79 	 * Params:
80 	 *     string_ = The string to wrap
81 	 *
82 	 * Returns: a new `GtkStringObject`
83 	 *
84 	 * Throws: ConstructionException GTK+ fails to create the object.
85 	 */
86 	public this(string string_)
87 	{
88 		auto __p = gtk_string_object_new(Str.toStringz(string_));
89 
90 		if(__p is null)
91 		{
92 			throw new ConstructionException("null returned by new");
93 		}
94 
95 		this(cast(GtkStringObject*) __p, true);
96 	}
97 
98 	/**
99 	 * Returns the string contained in a `GtkStringObject`.
100 	 *
101 	 * Returns: the string of @self
102 	 */
103 	public string getString()
104 	{
105 		return Str.toString(gtk_string_object_get_string(gtkStringObject));
106 	}
107 }