gsv.Utils 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  * Conversion parameters:
26  * inFile  = gtksourceview-3.0-GtkSourceUtils.html
27  * outPack = gsv
28  * outFile = Utils
29  * strct   = 
30  * realStrct=
31  * ctorStrct=
32  * clss    = Utils
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_source_utils_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- glib.Str
47  * structWrap:
48  * module aliases:
49  * local aliases:
50  * overrides:
51  */
52 
53 module gsv.Utils;
54 
55 public  import gsvc.gsvtypes;
56 
57 private import gsvc.gsv;
58 private import glib.ConstructionException;
59 private import gobject.ObjectG;
60 
61 private import glib.Str;
62 
63 
64 
65 /**
66  * Utilities functions.
67  */
68 public class Utils
69 {
70 	
71 	/**
72 	 */
73 	
74 	/**
75 	 * Use this function before gtk_source_search_settings_set_search_text(), to
76 	 * unescape the following sequences of characters: \n, \r, \t and \\.
77 	 * The purpose is to easily write those characters in a search entry.
78 	 * Note that unescaping the search text is not needed for regular expression
79 	 * searches.
80 	 * See also: gtk_source_utils_escape_search_text().
81 	 * Params:
82 	 * text = the text to unescape.
83 	 * Returns: the unescaped text. Since 3.10
84 	 */
85 	public static string unescapeSearchText(string text)
86 	{
87 		// gchar * gtk_source_utils_unescape_search_text  (const gchar *text);
88 		return Str.toString(gtk_source_utils_unescape_search_text(Str.toStringz(text)));
89 	}
90 	
91 	/**
92 	 * Use this function to escape the following characters: \n, \r, \t and \.
93 	 * For a regular expression search, use g_regex_escape_string() instead.
94 	 * One possible use case is to take the GtkTextBuffer's selection and put it in a
95 	 * search entry. The selection can contain tabulations, newlines, etc. So it's
96 	 * better to escape those special characters to better fit in the search entry.
97 	 * See also: gtk_source_utils_unescape_search_text().
98 	 * Warning
99 	 * The escape and unescape functions are not reciprocal! For example,
100 	 * escape (unescape (\)) = \\. So avoid cycles such as: search entry -&gt; unescape
101 	 * -&gt; search settings -&gt; escape -&gt; search entry. The original search entry text
102 	 * may be modified.
103 	 * Params:
104 	 * text = the text to escape.
105 	 * Returns: the escaped text. Since 3.10
106 	 */
107 	public static string escapeSearchText(string text)
108 	{
109 		// gchar * gtk_source_utils_escape_search_text (const gchar *text);
110 		return Str.toString(gtk_source_utils_escape_search_text(Str.toStringz(text)));
111 	}
112 }