/usr/include/d/gtkd-3/gio/VolumeT.d is in libgtkd-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 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | /*
* 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 gio.VolumeT;
public import gio.AsyncResultIF;
public import gio.Cancellable;
public import gio.DriveIF;
public import gio.FileIF;
public import gio.IconIF;
public import gio.MountIF;
public import gio.MountOperation;
public import gio.c.functions;
public import gio.c.types;
public import glib.ErrorG;
public import glib.GException;
public import glib.Str;
public import gobject.ObjectG;
public import gobject.Signals;
public import gtkc.giotypes;
public import std.algorithm;
/**
* The #GVolume interface represents user-visible objects that can be
* mounted. Note, when porting from GnomeVFS, #GVolume is the moral
* equivalent of #GnomeVFSDrive.
*
* Mounting a #GVolume instance is an asynchronous operation. For more
* information about asynchronous operations, see #GAsyncResult and
* #GTask. To mount a #GVolume, first call g_volume_mount() with (at
* least) the #GVolume instance, optionally a #GMountOperation object
* and a #GAsyncReadyCallback.
*
* Typically, one will only want to pass %NULL for the
* #GMountOperation if automounting all volumes when a desktop session
* starts since it's not desirable to put up a lot of dialogs asking
* for credentials.
*
* The callback will be fired when the operation has resolved (either
* with success or failure), and a #GAsyncReady structure will be
* passed to the callback. That callback should then call
* g_volume_mount_finish() with the #GVolume instance and the
* #GAsyncReady data to see if the operation was completed
* successfully. If an @error is present when g_volume_mount_finish()
* is called, then it will be filled with any error information.
*
* ## Volume Identifiers # {#volume-identifier}
*
* It is sometimes necessary to directly access the underlying
* operating system object behind a volume (e.g. for passing a volume
* to an application via the commandline). For this purpose, GIO
* allows to obtain an 'identifier' for the volume. There can be
* different kinds of identifiers, such as Hal UDIs, filesystem labels,
* traditional Unix devices (e.g. `/dev/sda2`), UUIDs. GIO uses predefined
* strings as names for the different kinds of identifiers:
* #G_VOLUME_IDENTIFIER_KIND_HAL_UDI, #G_VOLUME_IDENTIFIER_KIND_LABEL, etc.
* Use g_volume_get_identifier() to obtain an identifier for a volume.
*
*
* Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available
* when the gvfs hal volume monitor is in use. Other volume monitors
* will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE
* identifier, which can be used to obtain a hal device by means of
* libhal_manager_find_device_string_match().
*/
public template VolumeT(TStruct)
{
/** Get the main Gtk struct */
public GVolume* getVolumeStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return cast(GVolume*)getStruct();
}
/**
* Checks if a volume can be ejected.
*
* Returns: %TRUE if the @volume can be ejected. %FALSE otherwise
*/
public bool canEject()
{
return g_volume_can_eject(getVolumeStruct()) != 0;
}
/**
* Checks if a volume can be mounted.
*
* Returns: %TRUE if the @volume can be mounted. %FALSE otherwise
*/
public bool canMount()
{
return g_volume_can_mount(getVolumeStruct()) != 0;
}
/**
* Ejects a volume. This is an asynchronous operation, and is
* finished by calling g_volume_eject_finish() with the @volume
* and #GAsyncResult returned in the @callback.
*
* Deprecated: Use g_volume_eject_with_operation() instead.
*
* Params:
* flags = flags affecting the unmount if required for eject
* cancellable = optional #GCancellable object, %NULL to ignore
* callback = a #GAsyncReadyCallback, or %NULL
* userData = user data that gets passed to @callback
*/
public void eject(GMountUnmountFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)
{
g_volume_eject(getVolumeStruct(), flags, (cancellable is null) ? null : cancellable.getCancellableStruct(), callback, userData);
}
/**
* Finishes ejecting a volume. If any errors occurred during the operation,
* @error will be set to contain the errors and %FALSE will be returned.
*
* Deprecated: Use g_volume_eject_with_operation_finish() instead.
*
* Params:
* result = a #GAsyncResult
*
* Returns: %TRUE, %FALSE if operation failed
*
* Throws: GException on failure.
*/
public bool ejectFinish(AsyncResultIF result)
{
GError* err = null;
auto p = g_volume_eject_finish(getVolumeStruct(), (result is null) ? null : result.getAsyncResultStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Ejects a volume. This is an asynchronous operation, and is
* finished by calling g_volume_eject_with_operation_finish() with the @volume
* and #GAsyncResult data returned in the @callback.
*
* Params:
* flags = flags affecting the unmount if required for eject
* mountOperation = a #GMountOperation or %NULL to
* avoid user interaction
* cancellable = optional #GCancellable object, %NULL to ignore
* callback = a #GAsyncReadyCallback, or %NULL
* userData = user data passed to @callback
*
* Since: 2.22
*/
public void ejectWithOperation(GMountUnmountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)
{
g_volume_eject_with_operation(getVolumeStruct(), flags, (mountOperation is null) ? null : mountOperation.getMountOperationStruct(), (cancellable is null) ? null : cancellable.getCancellableStruct(), callback, userData);
}
/**
* Finishes ejecting a volume. If any errors occurred during the operation,
* @error will be set to contain the errors and %FALSE will be returned.
*
* Params:
* result = a #GAsyncResult
*
* Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise
*
* Since: 2.22
*
* Throws: GException on failure.
*/
public bool ejectWithOperationFinish(AsyncResultIF result)
{
GError* err = null;
auto p = g_volume_eject_with_operation_finish(getVolumeStruct(), (result is null) ? null : result.getAsyncResultStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Gets the kinds of [identifiers][volume-identifier] that @volume has.
* Use g_volume_get_identifier() to obtain the identifiers themselves.
*
* Returns: a %NULL-terminated array
* of strings containing kinds of identifiers. Use g_strfreev() to free.
*/
public string[] enumerateIdentifiers()
{
auto retStr = g_volume_enumerate_identifiers(getVolumeStruct());
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr);
}
/**
* Gets the activation root for a #GVolume if it is known ahead of
* mount time. Returns %NULL otherwise. If not %NULL and if @volume
* is mounted, then the result of g_mount_get_root() on the
* #GMount object obtained from g_volume_get_mount() will always
* either be equal or a prefix of what this function returns. In
* other words, in code
*
* |[<!-- language="C" -->
* GMount *mount;
* GFile *mount_root
* GFile *volume_activation_root;
*
* mount = g_volume_get_mount (volume); // mounted, so never NULL
* mount_root = g_mount_get_root (mount);
* volume_activation_root = g_volume_get_activation_root (volume); // assume not NULL
* ]|
* then the expression
* |[<!-- language="C" -->
* (g_file_has_prefix (volume_activation_root, mount_root) ||
* g_file_equal (volume_activation_root, mount_root))
* ]|
* will always be %TRUE.
*
* Activation roots are typically used in #GVolumeMonitor
* implementations to find the underlying mount to shadow, see
* g_mount_is_shadowed() for more details.
*
* Returns: the activation root of @volume
* or %NULL. Use g_object_unref() to free.
*
* Since: 2.18
*/
public FileIF getActivationRoot()
{
auto p = g_volume_get_activation_root(getVolumeStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileIF)(cast(GFile*) p, true);
}
/**
* Gets the drive for the @volume.
*
* Returns: a #GDrive or %NULL if @volume is not
* associated with a drive. The returned object should be unreffed
* with g_object_unref() when no longer needed.
*/
public DriveIF getDrive()
{
auto p = g_volume_get_drive(getVolumeStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(DriveIF)(cast(GDrive*) p, true);
}
/**
* Gets the icon for @volume.
*
* Returns: a #GIcon.
* The returned object should be unreffed with g_object_unref()
* when no longer needed.
*/
public IconIF getIcon()
{
auto p = g_volume_get_icon(getVolumeStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(IconIF)(cast(GIcon*) p, true);
}
/**
* Gets the identifier of the given kind for @volume.
* See the [introduction][volume-identifier] for more
* information about volume identifiers.
*
* Params:
* kind = the kind of identifier to return
*
* Returns: a newly allocated string containing the
* requested identfier, or %NULL if the #GVolume
* doesn't have this kind of identifier
*/
public string getIdentifier(string kind)
{
auto retStr = g_volume_get_identifier(getVolumeStruct(), Str.toStringz(kind));
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the mount for the @volume.
*
* Returns: a #GMount or %NULL if @volume isn't mounted.
* The returned object should be unreffed with g_object_unref()
* when no longer needed.
*/
public MountIF getMount()
{
auto p = g_volume_get_mount(getVolumeStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(MountIF)(cast(GMount*) p, true);
}
/**
* Gets the name of @volume.
*
* Returns: the name for the given @volume. The returned string should
* be freed with g_free() when no longer needed.
*/
public string getName()
{
auto retStr = g_volume_get_name(getVolumeStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the sort key for @volume, if any.
*
* Returns: Sorting key for @volume or %NULL if no such key is available
*
* Since: 2.32
*/
public string getSortKey()
{
return Str.toString(g_volume_get_sort_key(getVolumeStruct()));
}
/**
* Gets the symbolic icon for @volume.
*
* Returns: a #GIcon.
* The returned object should be unreffed with g_object_unref()
* when no longer needed.
*
* Since: 2.34
*/
public IconIF getSymbolicIcon()
{
auto p = g_volume_get_symbolic_icon(getVolumeStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(IconIF)(cast(GIcon*) p, true);
}
/**
* Gets the UUID for the @volume. The reference is typically based on
* the file system UUID for the volume in question and should be
* considered an opaque string. Returns %NULL if there is no UUID
* available.
*
* Returns: the UUID for @volume or %NULL if no UUID can be computed.
* The returned string should be freed with g_free()
* when no longer needed.
*/
public string getUuid()
{
auto retStr = g_volume_get_uuid(getVolumeStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Mounts a volume. This is an asynchronous operation, and is
* finished by calling g_volume_mount_finish() with the @volume
* and #GAsyncResult returned in the @callback.
*
* Params:
* flags = flags affecting the operation
* mountOperation = a #GMountOperation or %NULL to avoid user interaction
* cancellable = optional #GCancellable object, %NULL to ignore
* callback = a #GAsyncReadyCallback, or %NULL
* userData = user data that gets passed to @callback
*/
public void mount(GMountMountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)
{
g_volume_mount(getVolumeStruct(), flags, (mountOperation is null) ? null : mountOperation.getMountOperationStruct(), (cancellable is null) ? null : cancellable.getCancellableStruct(), callback, userData);
}
/**
* Finishes mounting a volume. If any errors occurred during the operation,
* @error will be set to contain the errors and %FALSE will be returned.
*
* If the mount operation succeeded, g_volume_get_mount() on @volume
* is guaranteed to return the mount right after calling this
* function; there's no need to listen for the 'mount-added' signal on
* #GVolumeMonitor.
*
* Params:
* result = a #GAsyncResult
*
* Returns: %TRUE, %FALSE if operation failed
*
* Throws: GException on failure.
*/
public bool mountFinish(AsyncResultIF result)
{
GError* err = null;
auto p = g_volume_mount_finish(getVolumeStruct(), (result is null) ? null : result.getAsyncResultStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Returns whether the volume should be automatically mounted.
*
* Returns: %TRUE if the volume should be automatically mounted
*/
public bool shouldAutomount()
{
return g_volume_should_automount(getVolumeStruct()) != 0;
}
protected class OnChangedDelegateWrapper
{
void delegate(VolumeIF) dlg;
gulong handlerId;
this(void delegate(VolumeIF) dlg)
{
this.dlg = dlg;
onChangedListeners ~= this;
}
void remove(OnChangedDelegateWrapper source)
{
foreach(index, wrapper; onChangedListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onChangedListeners[index] = null;
onChangedListeners = std.algorithm.remove(onChangedListeners, index);
break;
}
}
}
}
OnChangedDelegateWrapper[] onChangedListeners;
/**
* Emitted when the volume has been changed.
*/
gulong addOnChanged(void delegate(VolumeIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnChangedDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"changed",
cast(GCallback)&callBackChanged,
cast(void*)wrapper,
cast(GClosureNotify)&callBackChangedDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackChanged(GVolume* volumeStruct, OnChangedDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackChangedDestroy(OnChangedDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnRemovedDelegateWrapper
{
void delegate(VolumeIF) dlg;
gulong handlerId;
this(void delegate(VolumeIF) dlg)
{
this.dlg = dlg;
onRemovedListeners ~= this;
}
void remove(OnRemovedDelegateWrapper source)
{
foreach(index, wrapper; onRemovedListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onRemovedListeners[index] = null;
onRemovedListeners = std.algorithm.remove(onRemovedListeners, index);
break;
}
}
}
}
OnRemovedDelegateWrapper[] onRemovedListeners;
/**
* This signal is emitted when the #GVolume have been removed. If
* the recipient is holding references to the object they should
* release them so the object can be finalized.
*/
gulong addOnRemoved(void delegate(VolumeIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnRemovedDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"removed",
cast(GCallback)&callBackRemoved,
cast(void*)wrapper,
cast(GClosureNotify)&callBackRemovedDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackRemoved(GVolume* volumeStruct, OnRemovedDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackRemovedDestroy(OnRemovedDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
}
|