/usr/include/d/gtkd-3/gsv/SourceFileSaver.d is in libgtkdsv-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | /*
* 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 gsv.SourceFileSaver;
private import gio.AsyncResultIF;
private import gio.Cancellable;
private import gio.FileIF;
private import glib.ConstructionException;
private import glib.ErrorG;
private import glib.GException;
private import gobject.ObjectG;
private import gsv.SourceBuffer;
private import gsv.SourceEncoding;
private import gsv.SourceFile;
private import gsv.c.functions;
public import gsv.c.types;
public import gsvc.gsvtypes;
/** */
public class SourceFileSaver : ObjectG
{
/** the main Gtk struct */
protected GtkSourceFileSaver* gtkSourceFileSaver;
/** Get the main Gtk struct */
public GtkSourceFileSaver* getSourceFileSaverStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gtkSourceFileSaver;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gtkSourceFileSaver;
}
protected override void setStruct(GObject* obj)
{
gtkSourceFileSaver = cast(GtkSourceFileSaver*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GtkSourceFileSaver* gtkSourceFileSaver, bool ownedRef = false)
{
this.gtkSourceFileSaver = gtkSourceFileSaver;
super(cast(GObject*)gtkSourceFileSaver, ownedRef);
}
/** */
public static GType getType()
{
return gtk_source_file_saver_get_type();
}
/**
* Creates a new #GtkSourceFileSaver object. The @buffer will be saved to the
* #GtkSourceFile's location.
*
* This constructor is suitable for a simple "save" operation, when the @file
* already contains a non-%NULL #GtkSourceFile:location.
*
* Params:
* buffer = the #GtkSourceBuffer to save.
* file = the #GtkSourceFile.
*
* Returns: a new #GtkSourceFileSaver object.
*
* Since: 3.14
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(SourceBuffer buffer, SourceFile file)
{
auto p = gtk_source_file_saver_new((buffer is null) ? null : buffer.getSourceBufferStruct(), (file is null) ? null : file.getSourceFileStruct());
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GtkSourceFileSaver*) p, true);
}
/**
* Creates a new #GtkSourceFileSaver object with a target location. When the
* file saving is finished successfully, @target_location is set to the @file's
* #GtkSourceFile:location property. If an error occurs, the previous valid
* location is still available in #GtkSourceFile.
*
* This constructor is suitable for a "save as" operation, or for saving a new
* buffer for the first time.
*
* Params:
* buffer = the #GtkSourceBuffer to save.
* file = the #GtkSourceFile.
* targetLocation = the #GFile where to save the buffer to.
*
* Returns: a new #GtkSourceFileSaver object.
*
* Since: 3.14
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(SourceBuffer buffer, SourceFile file, FileIF targetLocation)
{
auto p = gtk_source_file_saver_new_with_target((buffer is null) ? null : buffer.getSourceBufferStruct(), (file is null) ? null : file.getSourceFileStruct(), (targetLocation is null) ? null : targetLocation.getFileStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_with_target");
}
this(cast(GtkSourceFileSaver*) p, true);
}
/**
* Returns: the #GtkSourceBuffer to save.
*
* Since: 3.14
*/
public SourceBuffer getBuffer()
{
auto p = gtk_source_file_saver_get_buffer(gtkSourceFileSaver);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(SourceBuffer)(cast(GtkSourceBuffer*) p);
}
/**
* Returns: the compression type.
*
* Since: 3.14
*/
public GtkSourceCompressionType getCompressionType()
{
return gtk_source_file_saver_get_compression_type(gtkSourceFileSaver);
}
/**
* Returns: the encoding.
*
* Since: 3.14
*/
public SourceEncoding getEncoding()
{
auto p = gtk_source_file_saver_get_encoding(gtkSourceFileSaver);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(SourceEncoding)(cast(GtkSourceEncoding*) p);
}
/**
* Returns: the #GtkSourceFile.
*
* Since: 3.14
*/
public SourceFile getFile()
{
auto p = gtk_source_file_saver_get_file(gtkSourceFileSaver);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(SourceFile)(cast(GtkSourceFile*) p);
}
/**
* Returns: the flags.
*
* Since: 3.14
*/
public GtkSourceFileSaverFlags getFlags()
{
return gtk_source_file_saver_get_flags(gtkSourceFileSaver);
}
/**
* Returns: the #GFile where to save the buffer to.
*
* Since: 3.14
*/
public FileIF getLocation()
{
auto p = gtk_source_file_saver_get_location(gtkSourceFileSaver);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileIF)(cast(GFile*) p);
}
/**
* Returns: the newline type.
*
* Since: 3.14
*/
public GtkSourceNewlineType getNewlineType()
{
return gtk_source_file_saver_get_newline_type(gtkSourceFileSaver);
}
/**
* Saves asynchronously the buffer into the file. See the #GAsyncResult
* documentation to know how to use this function.
*
* Params:
* ioPriority = the I/O priority of the request. E.g. %G_PRIORITY_LOW,
* %G_PRIORITY_DEFAULT or %G_PRIORITY_HIGH.
* cancellable = optional #GCancellable object, %NULL to ignore.
* progressCallback = function to call back with
* progress information, or %NULL if progress information is not needed.
* progressCallbackData = user data to pass to @progress_callback.
* progressCallbackNotify = function to call on
* @progress_callback_data when the @progress_callback is no longer needed, or
* %NULL.
* callback = a #GAsyncReadyCallback to call when the request is
* satisfied.
* userData = user data to pass to @callback.
*
* Since: 3.14
*/
public void saveAsync(int ioPriority, Cancellable cancellable, GFileProgressCallback progressCallback, void* progressCallbackData, GDestroyNotify progressCallbackNotify, GAsyncReadyCallback callback, void* userData)
{
gtk_source_file_saver_save_async(gtkSourceFileSaver, ioPriority, (cancellable is null) ? null : cancellable.getCancellableStruct(), progressCallback, progressCallbackData, progressCallbackNotify, callback, userData);
}
/**
* Finishes a file saving started with gtk_source_file_saver_save_async().
*
* If the file has been saved successfully, the following #GtkSourceFile
* properties will be updated: the location, the encoding, the newline type and
* the compression type.
*
* Since the 3.20 version, gtk_text_buffer_set_modified() is called with %FALSE
* if the file has been saved successfully.
*
* Params:
* result = a #GAsyncResult.
*
* Returns: whether the file was saved successfully.
*
* Since: 3.14
*
* Throws: GException on failure.
*/
public bool saveFinish(AsyncResultIF result)
{
GError* err = null;
auto p = gtk_source_file_saver_save_finish(gtkSourceFileSaver, (result is null) ? null : result.getAsyncResultStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets the compression type. By default the compression type is taken from the
* #GtkSourceFile.
*
* Params:
* compressionType = the new compression type.
*
* Since: 3.14
*/
public void setCompressionType(GtkSourceCompressionType compressionType)
{
gtk_source_file_saver_set_compression_type(gtkSourceFileSaver, compressionType);
}
/**
* Sets the encoding. If @encoding is %NULL, the UTF-8 encoding will be set.
* By default the encoding is taken from the #GtkSourceFile.
*
* Params:
* encoding = the new encoding, or %NULL for UTF-8.
*
* Since: 3.14
*/
public void setEncoding(SourceEncoding encoding)
{
gtk_source_file_saver_set_encoding(gtkSourceFileSaver, (encoding is null) ? null : encoding.getSourceEncodingStruct());
}
/** */
public void setFlags(GtkSourceFileSaverFlags flags)
{
gtk_source_file_saver_set_flags(gtkSourceFileSaver, flags);
}
/**
* Sets the newline type. By default the newline type is taken from the
* #GtkSourceFile.
*
* Params:
* newlineType = the new newline type.
*
* Since: 3.14
*/
public void setNewlineType(GtkSourceNewlineType newlineType)
{
gtk_source_file_saver_set_newline_type(gtkSourceFileSaver, newlineType);
}
}
|