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 drive can be ejected.
true if the drive can be ejected, false otherwise.
Checks if a drive can be polled for media changes.
true if the drive can be polled for media changes, false otherwise.
Checks if a drive can be started.
true if the drive can be started, false otherwise.
Checks if a drive can be started degraded.
true if the drive can be started degraded, false otherwise.
Checks if a drive can be stopped.
true if the drive can be stopped, false otherwise.
Asynchronously ejects a drive.
When the operation is finished, callback will be called.
You can then call g_drive_eject_finish() to obtain the
result of the operation.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Asynchronously ejects a drive.
When the operation is finished, callback will be called.
You can then call g_drive_eject_finish() to obtain the
result of the operation.
flags affecting the unmount if required for eject
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback, or null.
Asynchronously ejects a drive.
When the operation is finished, callback will be called.
You can then call g_drive_eject_finish() to obtain the
result of the operation.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Finishes ejecting a drive.
true if the drive has been ejected successfully, false otherwise.
Ejects a drive. This is an asynchronous operation, and is
finished by calling g_drive_eject_with_operation_finish() with the drive
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 drive. This is an asynchronous operation, and is
finished by calling g_drive_eject_with_operation_finish() with the drive
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 drive. This is an asynchronous operation, and is
finished by calling g_drive_eject_with_operation_finish() with the drive
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.Drive>a Gio.AsyncReadyCallback, or null.
Finishes ejecting a drive. If any errors occurred during the operation,
error will be set to contain the errors and false will be returned.
true if the drive was successfully ejected. false otherwise.
Gets the kinds of identifiers that drive has.
Use g_drive_get_identifier() to obtain the identifiers
themselves.
a null-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free.
Gets the identifier of the given kind for drive. The only
identifier currently available is
G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE.
the kind of identifier to return
a newly allocated string containing the requested identifier, or null if the Gio.Drive doesn't have this kind of identifier.
Gets the name of drive.
a string containing drive's name. The returned string should be freed when no longer needed.
Gets the sort key for drive, if any.
Sorting key for drive or null if no such key is available.
Gets a hint about how a drive can be started/stopped.
A value from the Gio.DriveStartStopType enumeration.
Get a list of mountable volumes for drive.
The returned list should be freed with g_list_free(), after
its elements have been unreffed with g_object_unref().
GLib.List containing any Gio.Volume objects on the given drive.
Checks if the drive has media. Note that the OS may not be polling
the drive for media changes; see g_drive_is_media_check_automatic()
for more details.
true if drive has media, false otherwise.
Check if drive has any mountable volumes.
true if the drive contains volumes, false otherwise.
Checks if drive is capable of automatically detecting media changes.
true if the drive is capable of automatically detecting media changes, false otherwise.
Checks if the drive supports removable media.
true if drive supports removable media, false otherwise.
Checks if the Gio.Drive and/or its media is considered removable by the user.
See g_drive_is_media_removable().
true if drive and/or its media is considered removable, false otherwise.
Asynchronously polls drive to see if media has been inserted or removed.
When the operation is finished, callback will be called.
You can then call g_drive_poll_for_media_finish() to obtain the
result of the operation.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Asynchronously polls drive to see if media has been inserted or removed.
When the operation is finished, callback will be called.
You can then call g_drive_poll_for_media_finish() to obtain the
result of the operation.
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback, or null.
Asynchronously polls drive to see if media has been inserted or removed.
When the operation is finished, callback will be called.
You can then call g_drive_poll_for_media_finish() to obtain the
result of the operation.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Finishes an operation started with g_drive_poll_for_media() on a drive.
true if the drive has been poll_for_mediaed successfully, false otherwise.
Asynchronously starts a drive.
When the operation is finished, callback will be called.
You can then call g_drive_start_finish() to obtain the
result of the operation.
flags affecting the start operation.
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Asynchronously starts a drive.
When the operation is finished, callback will be called.
You can then call g_drive_start_finish() to obtain the
result of the operation.
flags affecting the start operation.
a Gio.MountOperation or null to avoid user interaction.
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback, or null.
Asynchronously starts a drive.
When the operation is finished, callback will be called.
You can then call g_drive_start_finish() to obtain the
result of the operation.
flags affecting the start 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.Drive>a Gio.AsyncReadyCallback, or null.
Finishes starting a drive.
true if the drive has been started successfully, false otherwise.
Asynchronously stops a drive.
When the operation is finished, callback will be called.
You can then call g_drive_stop_finish() to obtain the
result of the operation.
flags affecting the unmount if required for stopping.
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Asynchronously stops a drive.
When the operation is finished, callback will be called.
You can then call g_drive_stop_finish() to obtain the
result of the operation.
flags affecting the unmount if required for stopping.
a Gio.MountOperation or null to avoid user interaction.
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback, or null.
Asynchronously stops a drive.
When the operation is finished, callback will be called.
You can then call g_drive_stop_finish() to obtain the
result of the operation.
flags affecting the unmount if required for stopping.
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Finishes stopping a drive.
true if the drive has been stopped successfully, false otherwise.
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 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 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 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 drive can be ejected.
Virtualvfunc_Checks if a drive can be polled for media changes.
Virtualvfunc_Checks if a drive can be started.
Virtualvfunc_Checks if a drive can be started degraded.
Virtualvfunc_Checks if a drive can be stopped.
Virtualvfunc_Signal emitted when the drive is changed.
Virtualvfunc_The removed signal that is emitted when the Gio.Drive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.
Virtualvfunc_Asynchronously ejects a drive.
When the operation is finished, callback will be called.
You can then call g_drive_eject_finish() to obtain the
result of the operation.
flags affecting the unmount if required for eject
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Virtualvfunc_Signal emitted when the physical eject button (if any) of a drive have been pressed.
Virtualvfunc_Virtualvfunc_Ejects a drive. This is an asynchronous operation, and is
finished by calling g_drive_eject_with_operation_finish() with the drive
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.Drive>a Gio.AsyncReadyCallback, or null.
Virtualvfunc_Finishes ejecting a drive. 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 drive has.
Use g_drive_get_identifier() to obtain the identifiers
themselves.
Virtualvfunc_Virtualvfunc_Gets the identifier of the given kind for drive. The only
identifier currently available is
G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE.
the kind of identifier to return
Virtualvfunc_Gets the name of drive.
Virtualvfunc_Gets the sort key for drive, if any.
Virtualvfunc_Gets a hint about how a drive can be started/stopped.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Checks if the drive has media. Note that the OS may not be polling
the drive for media changes; see g_drive_is_media_check_automatic()
for more details.
Virtualvfunc_Check if drive has any mountable volumes.
Virtualvfunc_Checks if drive is capable of automatically detecting media changes.
Virtualvfunc_Checks if the drive supports removable media.
Virtualvfunc_Checks if the Gio.Drive and/or its media is considered removable by the user.
See g_drive_is_media_removable().
Virtualvfunc_Asynchronously polls drive to see if media has been inserted or removed.
When the operation is finished, callback will be called.
You can then call g_drive_poll_for_media_finish() to obtain the
result of the operation.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Virtualvfunc_Finishes an operation started with g_drive_poll_for_media() on a drive.
Virtualvfunc_Asynchronously starts a drive.
When the operation is finished, callback will be called.
You can then call g_drive_start_finish() to obtain the
result of the operation.
flags affecting the start 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.Drive>a Gio.AsyncReadyCallback, or null.
Virtualvfunc_Virtualvfunc_Asynchronously stops a drive.
When the operation is finished, callback will be called.
You can then call g_drive_stop_finish() to obtain the
result of the operation.
flags affecting the unmount if required for stopping.
Optionalmount_operation: Gio.MountOperationa Gio.MountOperation or null to avoid user interaction.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.Drive>a Gio.AsyncReadyCallback, or null.
Virtualvfunc_Signal emitted when the physical stop button (if any) of a drive have been pressed. Since 2.22.
Virtualvfunc_
Gio.Drive represents a piece of hardware connected to the machine. It’s generally only created for removable hardware or hardware with removable media. For example, an optical disc drive, or a USB flash drive.
Gio.Drive is a container class for Gio.Volume objects that stem from the same piece of media. As such, Gio.Drive abstracts a drive with (or without) removable media and provides operations for querying whether media is available, determining whether media change is automatically detected and ejecting the media.
If the Gio.Drive reports that media isn’t automatically detected, one can poll for media; typically one should not do this periodically as a poll for media operation is potentially expensive and may spin up the drive creating noise.
Gio.Drive supports starting and stopping drives with authentication support for the former. This can be used to support a diverse set of use cases including connecting/disconnecting iSCSI devices, powering down external disk enclosures and starting/stopping multi-disk devices such as RAID devices. Note that the actual semantics and side-effects of starting/stopping a Gio.Drive may vary according to implementation. To choose the correct verbs in e.g. a file manager, use Gio.Drive.get_start_stop_type.
For porting from GnomeVFS note that there is no equivalent of Gio.Drive in that API.