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