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