File: Value.d

package info (click to toggle)
tilix 1.9.6-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,444 kB
  • sloc: xml: 1,175; sh: 285; python: 127; perl: 72; ansic: 53; makefile: 6
file content (190 lines) | stat: -rw-r--r-- 4,836 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module secret.Value;

private import glib.ConstructionException;
private import glib.Str;
private import gobject.ObjectG;
private import secretc.secret;
public  import secretc.secrettypes;


/**
 * A secret value, like a password or other binary secret.
 */
public class Value
{
	/** the main Gtk struct */
	protected SecretValue* secretValue;
	protected bool ownedRef;

	/** Get the main Gtk struct */
	public SecretValue* getValueStruct()
	{
		return secretValue;
	}

	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)secretValue;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (SecretValue* secretValue, bool ownedRef = false)
	{
		this.secretValue = secretValue;
		this.ownedRef = ownedRef;
	}


	/** */
	public static GType getType()
	{
		return secret_value_get_type();
	}

	/**
	 * Create a #SecretValue for the secret data passed in. The secret data is
	 * copied into non-pageable 'secure' memory.
	 *
	 * If the length is less than zero, then @secret is assumed to be
	 * null-terminated.
	 *
	 * Params:
	 *     secret = the secret data
	 *     length = the length of the data
	 *     contentType = the content type of the data
	 *
	 * Return: the new #SecretValue
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(string secret, ptrdiff_t length, string contentType)
	{
		auto p = secret_value_new(Str.toStringz(secret), length, Str.toStringz(contentType));

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(SecretValue*) p);
	}

	/**
	 * Create a #SecretValue for the secret data passed in. The secret data is
	 * not copied, and will later be freed with the @destroy function.
	 *
	 * If the length is less than zero, then @secret is assumed to be
	 * null-terminated.
	 *
	 * Params:
	 *     secret = the secret data
	 *     length = the length of the data
	 *     contentType = the content type of the data
	 *     destroy = function to call to free the secret data
	 *
	 * Return: the new #SecretValue
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(string secret, ptrdiff_t length, string contentType, GDestroyNotify destroy)
	{
		auto p = secret_value_new_full(Str.toStringz(secret), length, Str.toStringz(contentType), destroy);

		if(p is null)
		{
			throw new ConstructionException("null returned by new_full");
		}

		this(cast(SecretValue*) p);
	}

	/**
	 * Get the secret data in the #SecretValue. The value is not necessarily
	 * null-terminated unless it was created with secret_value_new() or a
	 * null-terminated string was passed to secret_value_new_full().
	 *
	 * Return: the secret data
	 */
	public string get()
	{
		size_t length;

		return Str.toString(secret_value_get(secretValue, &length));
	}

	/**
	 * Get the content type of the secret value, such as
	 * <literal>text/plain</literal>.
	 *
	 * Return: the content type
	 */
	public string getContentType()
	{
		return Str.toString(secret_value_get_content_type(secretValue));
	}

	/**
	 * Get the secret data in the #SecretValue if it contains a textual
	 * value. The content type must be <literal>text/plain</literal>.
	 *
	 * Return: the content type
	 */
	public string getText()
	{
		return Str.toString(secret_value_get_text(secretValue));
	}

	/**
	 * Add another reference to the #SecretValue. For each reference
	 * secret_value_unref() should be called to unreference the value.
	 *
	 * Return: the value
	 */
	public Value doref()
	{
		auto p = secret_value_ref(secretValue);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Value)(cast(SecretValue*) p, true);
	}

	/**
	 * Unreference a #SecretValue. When the last reference is gone, then
	 * the value will be freed.
	 */
	public void unref()
	{
		secret_value_unref(secretValue);
	}
}