gio.CharsetConverter 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 gio.CharsetConverter;
26 
27 private import gio.ConverterIF;
28 private import gio.ConverterT;
29 private import gio.InitableIF;
30 private import gio.InitableT;
31 private import glib.ConstructionException;
32 private import glib.ErrorG;
33 private import glib.GException;
34 private import glib.Str;
35 private import gobject.ObjectG;
36 private import gtkc.gio;
37 public  import gtkc.giotypes;
38 
39 
40 /**
41  * #GCharsetConverter is an implementation of #GConverter based on
42  * GIConv.
43  */
44 public class CharsetConverter : ObjectG, ConverterIF, InitableIF
45 {
46 	/** the main Gtk struct */
47 	protected GCharsetConverter* gCharsetConverter;
48 
49 	/** Get the main Gtk struct */
50 	public GCharsetConverter* getCharsetConverterStruct()
51 	{
52 		return gCharsetConverter;
53 	}
54 
55 	/** the main Gtk struct as a void* */
56 	protected override void* getStruct()
57 	{
58 		return cast(void*)gCharsetConverter;
59 	}
60 
61 	protected override void setStruct(GObject* obj)
62 	{
63 		gCharsetConverter = cast(GCharsetConverter*)obj;
64 		super.setStruct(obj);
65 	}
66 
67 	/**
68 	 * Sets our main struct and passes it to the parent class.
69 	 */
70 	public this (GCharsetConverter* gCharsetConverter, bool ownedRef = false)
71 	{
72 		this.gCharsetConverter = gCharsetConverter;
73 		super(cast(GObject*)gCharsetConverter, ownedRef);
74 	}
75 
76 	// add the Converter capabilities
77 	mixin ConverterT!(GCharsetConverter);
78 
79 	// add the Initable capabilities
80 	mixin InitableT!(GCharsetConverter);
81 
82 	/**
83 	 */
84 
85 	public static GType getType()
86 	{
87 		return g_charset_converter_get_type();
88 	}
89 
90 	/**
91 	 * Creates a new #GCharsetConverter.
92 	 *
93 	 * Params:
94 	 *     toCharset = destination charset
95 	 *     fromCharset = source charset
96 	 *
97 	 * Return: a new #GCharsetConverter or %NULL on error.
98 	 *
99 	 * Since: 2.24
100 	 *
101 	 * Throws: GException on failure.
102 	 * Throws: ConstructionException GTK+ fails to create the object.
103 	 */
104 	public this(string toCharset, string fromCharset)
105 	{
106 		GError* err = null;
107 		
108 		auto p = g_charset_converter_new(Str.toStringz(toCharset), Str.toStringz(fromCharset), &err);
109 		
110 		if(p is null)
111 		{
112 			throw new ConstructionException("null returned by new");
113 		}
114 		
115 		if (err !is null)
116 		{
117 			throw new GException( new ErrorG(err) );
118 		}
119 		
120 		this(cast(GCharsetConverter*) p, true);
121 	}
122 
123 	/**
124 	 * Gets the number of fallbacks that @converter has applied so far.
125 	 *
126 	 * Return: the number of fallbacks that @converter has applied
127 	 *
128 	 * Since: 2.24
129 	 */
130 	public uint getNumFallbacks()
131 	{
132 		return g_charset_converter_get_num_fallbacks(gCharsetConverter);
133 	}
134 
135 	/**
136 	 * Gets the #GCharsetConverter:use-fallback property.
137 	 *
138 	 * Return: %TRUE if fallbacks are used by @converter
139 	 *
140 	 * Since: 2.24
141 	 */
142 	public bool getUseFallback()
143 	{
144 		return g_charset_converter_get_use_fallback(gCharsetConverter) != 0;
145 	}
146 
147 	/**
148 	 * Sets the #GCharsetConverter:use-fallback property.
149 	 *
150 	 * Params:
151 	 *     useFallback = %TRUE to use fallbacks
152 	 *
153 	 * Since: 2.24
154 	 */
155 	public void setUseFallback(bool useFallback)
156 	{
157 		g_charset_converter_set_use_fallback(gCharsetConverter, useFallback);
158 	}
159 }