Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Checks if a volume can be ejected.
true if the volume can be ejected. false otherwise
Checks if a volume can be mounted.
true if the volume can be mounted. false otherwise
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the unmount if required for eject
optional Gio.Cancellable object, null to ignore
a Gio.AsyncReadyCallback, or null
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
Finishes ejecting a volume. If any errors occurred during the operation,
error will be set to contain the errors and false will be returned.
true, false if operation failed
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_with_operation_finish() with the volume
and Gio.AsyncResult data returned in the callback.
flags affecting the unmount if required for eject
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_with_operation_finish() with the volume
and Gio.AsyncResult data returned in the callback.
flags affecting the unmount if required for eject
a Gio.MountOperation or null to avoid user interaction
optional Gio.Cancellable object, null to ignore
a Gio.AsyncReadyCallback, or null
Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_with_operation_finish() with the volume
and Gio.AsyncResult data returned in the callback.
flags affecting the unmount if required for eject
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
Finishes ejecting a volume. If any errors occurred during the operation,
error will be set to contain the errors and false will be returned.
true if the volume was successfully ejected. false otherwise
Gets the kinds of identifiers that volume has.
Use g_volume_get_identifier() to obtain the identifiers themselves.
a null-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free.
Gets the activation root for a Gio.Volume 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
Gio.Mount 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
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
(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 Gio.VolumeMonitor
implementations to find the underlying mount to shadow, see
g_mount_is_shadowed() for more details.
the activation root of volume or null. Use g_object_unref() to free.
Gets the identifier of the given kind for volume.
See the introduction for more
information about volume identifiers.
the kind of identifier to return
a newly allocated string containing the requested identifier, or null if the Gio.Volume doesn't have this kind of identifier
Gets the name of volume.
the name for the given volume. The returned string should be freed with g_free() when no longer needed.
Gets the sort key for volume, if any.
Sorting key for volume or null if no such key is available
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.
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.
Mounts a volume. This is an asynchronous operation, and is
finished by calling g_volume_mount_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the operation
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Mounts a volume. This is an asynchronous operation, and is
finished by calling g_volume_mount_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the operation
a Gio.MountOperation or null to avoid user interaction
optional Gio.Cancellable object, null to ignore
a Gio.AsyncReadyCallback, or null
Mounts a volume. This is an asynchronous operation, and is
finished by calling g_volume_mount_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the operation
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
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
Gio.VolumeMonitor.
true, false if operation failed
Returns whether the volume should be automatically mounted.
true if the volume should be automatically mounted
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Virtualvfunc_Checks if a volume can be ejected.
Virtualvfunc_Checks if a volume can be mounted.
Virtualvfunc_Changed signal that is emitted when the volume's state has changed.
Virtualvfunc_Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
Virtualvfunc_Finishes ejecting a volume. If any errors occurred during the operation,
error will be set to contain the errors and false will be returned.
Virtualvfunc_Ejects a volume. This is an asynchronous operation, and is
finished by calling g_volume_eject_with_operation_finish() with the volume
and Gio.AsyncResult data returned in the callback.
flags affecting the unmount if required for eject
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
Virtualvfunc_Finishes ejecting a volume. If any errors occurred during the operation,
error will be set to contain the errors and false will be returned.
Virtualvfunc_Gets the kinds of identifiers that volume has.
Use g_volume_get_identifier() to obtain the identifiers themselves.
Virtualvfunc_Gets the activation root for a Gio.Volume 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
Gio.Mount 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
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
(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 Gio.VolumeMonitor
implementations to find the underlying mount to shadow, see
g_mount_is_shadowed() for more details.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Gets the identifier of the given kind for volume.
See the introduction for more
information about volume identifiers.
the kind of identifier to return
Virtualvfunc_Virtualvfunc_Gets the name of volume.
Virtualvfunc_Gets the sort key for volume, if any.
Virtualvfunc_Virtualvfunc_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.
Virtualvfunc_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
Gio.VolumeMonitor.
Virtualvfunc_Mounts a volume. This is an asynchronous operation, and is
finished by calling g_volume_mount_finish() with the volume
and Gio.AsyncResult returned in the callback.
flags affecting the operation
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.Volume>a Gio.AsyncReadyCallback, or null
Virtualvfunc_The removed signal that is emitted when the Gio.Volume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized.
Virtualvfunc_Returns whether the volume should be automatically mounted.
The Gio.Volume interface represents user-visible objects that can be mounted. For example, a file system partition on a USB flash drive, or an optical disc inserted into a disc drive.
If a Gio.Volume is currently mounted, the corresponding Gio.Mount can be retrieved using Gio.Volume.get_mount.
Mounting a Gio.Volume instance is an asynchronous operation. For more information about asynchronous operations, see Gio.AsyncResult and Gio.Task. To mount a Gio.Volume, first call Gio.Volume.mount with (at least) the Gio.Volume instance, optionally a Gio.MountOperation object and a Gio.AsyncReadyCallback.
Typically, one will only want to pass
NULLfor the Gio.MountOperation 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 Gio.AsyncResult instance will be passed to the callback. That callback should then call Gio.Volume.mount_finish with the Gio.Volume instance and the Gio.AsyncResult data to see if the operation was completed successfully. If a GLib.Error is present when Gio.Volume.mount_finish is called, then it will be filled with any error information.
Note, when porting from GnomeVFS, Gio.Volume is the moral equivalent of
GnomeVFSDrive.Volume Identifiers
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 command line). 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_UUID,G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use Gio.Volume.get_identifier to obtain an identifier for a volume.Note that
G_VOLUME_IDENTIFIER_KIND_HAL_UDIwill only be available when the GVFS hal volume monitor is in use. Other volume monitors will generally be able to provide theG_VOLUME_IDENTIFIER_KIND_UNIX_DEVICEidentifier, which can be used to obtain a hal device by means oflibhal_manager_find_device_string_match().