/usr/include/giomm-2.4/giomm/mount.h is in libglibmm-2.4-dev 2.42.0-1.
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 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_MOUNT_H
#define _GIOMM_MOUNT_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
//#include <giomm/drive.h>
//#include <giomm/file.h>
//#include <giomm/volume.h>
#include <glibmm/interface.h>
#include <giomm/asyncresult.h>
#include <giomm/cancellable.h>
#include <giomm/mountoperation.h>
#include <giomm/icon.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GMountIface GMountIface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GMount GMount;
typedef struct _GMountClass GMountClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class Mount_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var MountUnmountFlags MOUNT_UNMOUNT_NONE
* No flags set.
*
* @var MountUnmountFlags MOUNT_UNMOUNT_FORCE
* Unmount even if there are outstanding file operations on the mount.
*
* @enum MountUnmountFlags
*
* Flags used when an unmounting a mount.
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%MountUnmountFlags operator|(MountUnmountFlags, MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags operator&(MountUnmountFlags, MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags operator^(MountUnmountFlags, MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags operator~(MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags& operator|=(MountUnmountFlags&, MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags& operator&=(MountUnmountFlags&, MountUnmountFlags)</tt><br>
* <tt>%MountUnmountFlags& operator^=(MountUnmountFlags&, MountUnmountFlags)</tt><br>
*/
enum MountUnmountFlags
{
MOUNT_UNMOUNT_NONE = 0x0,
MOUNT_UNMOUNT_FORCE = (1 << 0)
};
/** @ingroup giommEnums */
inline MountUnmountFlags operator|(MountUnmountFlags lhs, MountUnmountFlags rhs)
{ return static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountUnmountFlags operator&(MountUnmountFlags lhs, MountUnmountFlags rhs)
{ return static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountUnmountFlags operator^(MountUnmountFlags lhs, MountUnmountFlags rhs)
{ return static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountUnmountFlags operator~(MountUnmountFlags flags)
{ return static_cast<MountUnmountFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline MountUnmountFlags& operator|=(MountUnmountFlags& lhs, MountUnmountFlags rhs)
{ return (lhs = static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MountUnmountFlags& operator&=(MountUnmountFlags& lhs, MountUnmountFlags rhs)
{ return (lhs = static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MountUnmountFlags& operator^=(MountUnmountFlags& lhs, MountUnmountFlags rhs)
{ return (lhs = static_cast<MountUnmountFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var MountMountFlags MOUNT_MOUNT_NONE
* No flags set.
*
* @enum MountMountFlags
*
* Flags used when mounting a mount.
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%MountMountFlags operator|(MountMountFlags, MountMountFlags)</tt><br>
* <tt>%MountMountFlags operator&(MountMountFlags, MountMountFlags)</tt><br>
* <tt>%MountMountFlags operator^(MountMountFlags, MountMountFlags)</tt><br>
* <tt>%MountMountFlags operator~(MountMountFlags)</tt><br>
* <tt>%MountMountFlags& operator|=(MountMountFlags&, MountMountFlags)</tt><br>
* <tt>%MountMountFlags& operator&=(MountMountFlags&, MountMountFlags)</tt><br>
* <tt>%MountMountFlags& operator^=(MountMountFlags&, MountMountFlags)</tt><br>
*/
enum MountMountFlags
{
MOUNT_MOUNT_NONE = 0x0
};
/** @ingroup giommEnums */
inline MountMountFlags operator|(MountMountFlags lhs, MountMountFlags rhs)
{ return static_cast<MountMountFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountMountFlags operator&(MountMountFlags lhs, MountMountFlags rhs)
{ return static_cast<MountMountFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountMountFlags operator^(MountMountFlags lhs, MountMountFlags rhs)
{ return static_cast<MountMountFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MountMountFlags operator~(MountMountFlags flags)
{ return static_cast<MountMountFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline MountMountFlags& operator|=(MountMountFlags& lhs, MountMountFlags rhs)
{ return (lhs = static_cast<MountMountFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MountMountFlags& operator&=(MountMountFlags& lhs, MountMountFlags rhs)
{ return (lhs = static_cast<MountMountFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MountMountFlags& operator^=(MountMountFlags& lhs, MountMountFlags rhs)
{ return (lhs = static_cast<MountMountFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
class File;
class Drive;
class Volume;
/** The Mount interface represents user-visible mounts.
* Mount is a "mounted" filesystem that you can access. Mounted is in quotes because it's not the same as a unix mount:
* it might be a gvfs mount, but you can still access the files on it if you use GIO. It might or might not be related to a volume object.
*
* Unmounting a Mount instance is an asynchronous operation. For more information about asynchronous operations, see AsyncReady.
* To unmount a Mount instance, first call unmount(). The callback slot will be called when the operation has resolved (either with success or failure),
* and a AsyncReady structure will be passed to the callback. That callback should then call unmount_finish() with the AsyncReady data to see if the operation was completed successfully.
*
* @ingroup Streams
*
* @newin{2,16}
*/
class Mount : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Mount CppObjectType;
typedef Mount_Class CppClassType;
typedef GMount BaseObjectType;
typedef GMountIface BaseClassType;
private:
friend class Mount_Class;
static CppClassType mount_class_;
// noncopyable
Mount(const Mount&);
Mount& operator=(const Mount&);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
Mount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit Mount(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit Mount(GMount* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Mount();
static void add_interface(GType gtype_implementer);
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GMount* gobj() { return reinterpret_cast<GMount*>(gobject_); }
///Provides access to the underlying C GObject.
const GMount* gobj() const { return reinterpret_cast<GMount*>(gobject_); }
private:
public:
/** Gets the root directory on @a mount.
*
* @return A File.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<File> get_root();
/** Gets the root directory on @a mount.
*
* @return A File.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<const File> get_root() const;
/** Gets the name of @a mount.
*
* @return The name for the given @a mount.
* The returned string should be freed with Glib::free()
* when no longer needed.
*/
std::string get_name() const;
/** Gets the icon for @a mount.
*
* @return A Icon.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<Icon> get_icon();
/** Gets the icon for @a mount.
*
* @return A Icon.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<const Icon> get_icon() const;
/** Gets the symbolic icon for @a mount.
*
* @newin{2,34}
*
* @return A Icon.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<Icon> get_symbolic_icon();
/** Gets the symbolic icon for @a mount.
*
* @newin{2,34}
*
* @return A Icon.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<const Icon> get_symbolic_icon() const;
/** Gets the UUID for the @a mount. The reference is typically based on
* the file system UUID for the mount in question and should be
* considered an opaque string. Returns <tt>0</tt> if there is no UUID
* available.
*
* @return The UUID for @a mount or <tt>0</tt> if no UUID can be computed.
* The returned string should be freed with Glib::free()
* when no longer needed.
*/
std::string get_uuid() const;
/** Gets the volume for the @a mount.
*
* @return A Volume or <tt>0</tt> if @a mount is not associated with a volume.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<Volume> get_volume();
/** Gets the volume for the @a mount.
*
* @return A Volume or <tt>0</tt> if @a mount is not associated with a volume.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<const Volume> get_volume() const;
/** Gets the drive for the @a mount.
*
* This is a convenience method for getting the Volume and then
* using that object to get the Drive.
*
* @return A Drive or <tt>0</tt> if @a mount is not associated with a volume or a drive.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<Drive> get_drive();
/** Gets the drive for the @a mount.
*
* This is a convenience method for getting the Volume and then
* using that object to get the Drive.
*
* @return A Drive or <tt>0</tt> if @a mount is not associated with a volume or a drive.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<const Drive> get_drive() const;
/** Checks if @a mount can be mounted.
*
* @return <tt>true</tt> if the @a mount can be unmounted.
*/
bool can_unmount() const;
/** Checks if @a mount can be eject.
*
* @return <tt>true</tt> if the @a mount can be ejected.
*/
bool can_eject() const;
void unmount(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void unmount(const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void unmount(MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void unmount(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void unmount(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void unmount(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Finishes unmounting a mount. If any errors occurred during the operation,
* @a error will be set to contain the errors and <tt>false</tt> will be returned.
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the mount was successfully unmounted. <tt>false</tt> otherwise.
*/
bool unmount_finish(const Glib::RefPtr<AsyncResult>& result);
/** Remounts a mount.
* This is an asynchronous operation, and is finished by calling mount_finish() with the AsyncResult data returned in the callback slot.
*
* Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount
* to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to
* actually be unmounted.
*
* @param operation A mount operation.
* @param slot A callback which will be called when the operation is completed or canceled.
* @param cancellable A cancellable object which can be used to cancel the operation.
* @param flags Flags affecting the operation.
*/
void remount(const Glib::RefPtr<MountOperation>& operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Remounts a mount.
* This is an asynchronous operation, and is finished by calling mount_finish() with the AsyncResult data returned in the callback slot.
*
* Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount
* to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to
* actually be unmounted.
*
* @param operation A mount operation.
* @param slot A callback which will be called when the operation is completed or canceled.
* @param flags Flags affecting the operation.
*/
void remount(const Glib::RefPtr<MountOperation>& operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Remounts a mount.
*
* Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount
* to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to
* actually be unmounted.
*
* @param operation A mount operation.
* @param flags Flags affecting the operation.
*/
void remount(const Glib::RefPtr<MountOperation>& operation, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Remounts a mount, without user interaction.
*
* Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount
* to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to
* actually be unmounted.
*
* @param flags Flags affecting the operation.
*/
void remount(MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Finishes remounting a mount. If any errors occurred during the operation,
* @a error will be set to contain the errors and <tt>false</tt> will be returned.
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the mount was successfully remounted. <tt>false</tt> otherwise.
*/
bool remount_finish(const Glib::RefPtr<AsyncResult>& result);
void eject(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void eject(const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void eject(MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void eject(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void eject(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
void eject(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Finishes ejecting a mount. If any errors occurred during the operation,
* @a error will be set to contain the errors and <tt>false</tt> will be returned.
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the mount was successfully ejected. <tt>false</tt> otherwise.
*/
bool eject_finish(const Glib::RefPtr<AsyncResult>& result);
/** Tries to guess the type of content stored on the mount.
* Returns one or more textual identifiers of well-known content types (typically
* prefixed with "x-content/"), e.g. x-content/image-dcf for camera
* memory cards. See the <a href="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</a> specification for more on x-content types.
*
* This is an asynchronous operation, and is finished by calling
* guess_content_type_finish().
*
* @param slot A callback which will be called when the operation is completed or canceled.
* @param cancellable A cancellable object which can be used to cancel the operation.
* @param force_rescan Whether to force a rescan of the content. Otherwise a cached result will be used if available.
*
* @newin{2,18}
*/
void guess_content_type(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, bool force_rescan = true);
/** Tries to guess the type of content stored on the mount.
* Returns one or more textual identifiers of well-known content types (typically
* prefixed with "x-content/"), e.g. x-content/image-dcf for camera
* memory cards. See the <a href="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</a> specification for more on x-content types.
*
* This is an asynchronous operation, and is finished by calling
* guess_content_type_finish().
*
* @param slot A callback which will be called when the operation is completed or canceled.
* @param force_rescan Whether to force a rescan of the content. Otherwise a cached result will be used if available.
*
* @newin{2,18}
*/
void guess_content_type(const SlotAsyncReady& slot, bool force_rescan = true);
/** Tries to guess the type of content stored on the mount.
* Returns one or more textual identifiers of well-known content types (typically
* prefixed with "x-content/"), e.g. x-content/image-dcf for camera
* memory cards. See the <a href="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</a> specification for more on x-content types.
*
* @param force_rescan Whether to force a rescan of the content. Otherwise a cached result will be used if available.
*
* @newin{2,18}
*/
void guess_content_type(bool force_rescan = true);
void guess_content_type_sync(const Glib::RefPtr<Cancellable>& cancellable, bool force_rescan = true);
void guess_content_type_sync(bool force_rescan = true);
/** Finishes guessing content types of the Mount.
* If any errors occurred during the operation, an exception will be thrown.
* In particular, you may get a Gio::Error::NOT_SUPPORTED if the mount
* does not support content guessing.
*
* @newin{2,18}
* @param result An AsyncResult.
* @return An array of content types.
* @throw Glib::Error
*/
Glib::StringArrayHandle guess_content_type_finish(const Glib::RefPtr<AsyncResult>& result);
/** Determines if @a mount is shadowed. Applications or libraries should
* avoid displaying @a mount in the user interface if it is shadowed.
*
* A mount is said to be shadowed if there exists one or more user
* visible objects (currently Mount objects) with a root that is
* inside the root of @a mount.
*
* One application of shadow mounts is when exposing a single file
* system that is used to address several logical volumes. In this
* situation, a VolumeMonitor implementation would create two
* Volume objects (for example, one for the camera functionality of
* the device and one for a SD card reader on the device) with
* activation URIs `gphoto2://[usb:001,002]/store1/`
* and `gphoto2://[usb:001,002]/store2/`. When the
* underlying mount (with root
* `gphoto2://[usb:001,002]/`) is mounted, said
* VolumeMonitor implementation would create two Mount objects
* (each with their root matching the corresponding volume activation
* root) that would shadow the original mount.
*
* The proxy monitor in GVfs 2.26 and later, automatically creates and
* manage shadow mounts (and shadows the underlying mount) if the
* activation root on a Volume is set.
*
* @newin{2,20}
*
* @return <tt>true</tt> if @a mount is shadowed.
*/
bool is_shadowed() const;
/** Increments the shadow count on @a mount. Usually used by
* VolumeMonitor implementations when creating a shadow mount for
* @a mount, see g_mount_is_shadowed() for more information. The caller
* will need to emit the Mount::signal_changed() signal on @a mount manually.
*
* @newin{2,20}
*
*/
void shadow();
/** Decrements the shadow count on @a mount. Usually used by
* VolumeMonitor implementations when destroying a shadow mount for
* @a mount, see g_mount_is_shadowed() for more information. The caller
* will need to emit the Mount::signal_changed() signal on @a mount manually.
*
* @newin{2,20}
*
*/
void unshadow();
/** Gets the default location of @a mount. The default location of the given
* @a mount is a path that reflects the main entry point for the user (e.g.
* the home directory, or the root of the volume).
*
* @return A File.
* The returned object should be unreffed with
* Glib::object_unref() when no longer needed.
*/
Glib::RefPtr<File> get_default_location() const;
/** Gets the sort key for @a mount, if any.
*
* @newin{2,32}
*
* @return Sorting key for @a mount or <tt>0</tt> if no such key is available.
*/
Glib::ustring get_sort_key() const;
/**
* @par Slot Prototype:
* <tt>void on_my_%changed()</tt>
*
* Emitted when the mount has been changed.
*
*/
Glib::SignalProxy0< void > signal_changed();
/**
* @par Slot Prototype:
* <tt>void on_my_%unmounted()</tt>
*
* This signal is emitted when the Mount have been
* unmounted. If the recipient is holding references to the
* object they should release them so the object can be
* finalized.
*
*/
Glib::SignalProxy0< void > signal_unmounted();
/**
* @par Slot Prototype:
* <tt>void on_my_%pre_unmount()</tt>
*
* This signal is emitted when the Mount is about to be
* unmounted.
*
* @newin{2,22}
*
*/
Glib::SignalProxy0< void > signal_pre_unmount();
//There are no properties.
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_changed().
virtual void on_changed();
/// This is a default handler for the signal signal_unmounted().
virtual void on_unmounted();
};
} // namespace Gio
namespace Glib
{
//Pre-declare this so we can use it in TypeTrait:
Glib::RefPtr<Gio::Mount> wrap(GMount* object, bool take_copy);
namespace Container_Helpers
{
/** This specialization of TypeTraits exists
* because the default use of Glib::wrap(GObject*),
* instead of a specific Glib::wrap(GSomeInterface*),
* would not return a wrapper for an interface.
*/
template <>
struct TypeTraits< Glib::RefPtr<Gio::Mount> >
{
typedef Glib::RefPtr<Gio::Mount> CppType;
typedef GMount* CType;
typedef GMount* CTypeNonConst;
static CType to_c_type (const CppType& item)
{ return Glib::unwrap (item); }
static CppType to_cpp_type (const CType& item)
{
//Use a specific Glib::wrap() function,
//because CType has the specific type (not just GObject):
return Glib::wrap(item, true /* take_copy */);
}
static void release_c_type (CType item)
{
GLIBMM_DEBUG_UNREFERENCE(0, item);
g_object_unref(item);
}
};
} // Container_Helpers
} // Glib
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::Mount
*/
Glib::RefPtr<Gio::Mount> wrap(GMount* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_MOUNT_H */
|