Class

IdeNotification

Description

class Ide.Notification : Ide.Object {
  parent_instance: IdeObject
}
No description available.

Hierarchy

hierarchy this IdeNotification ancestor_0 IdeObject ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Ancestors

Constructors

ide_notification_new

Creates a new IdeNotification.

Available since: 3.32

Functions

ide_notification_file_progress_callback

This function is a GFileProgressCallback helper that will update the IdeNotification:fraction property. user_data must be an IdeNotification.

Available since: 3.32

ide_notification_flatpak_progress_callback
No description available.

Instance methods

ide_notification_add_button

Adds a new button that may be displayed with the notification.

Available since: 3.32

ide_notification_add_button_with_target_value

Adds a new button, used the parsed GVariant format for the action target.

Available since: 3.32

ide_notification_attach

This function will locate the IdeNotifications object starting from object and attach self as a child to that object.

Available since: 3.32

ide_notification_compare
No description available.
ide_notification_dup_body

Copies the current body and returns it to the caller after locking the object. A copy is used to avoid thread-races.

Available since: 3.32

ide_notification_dup_id

Copies the id of the notification and returns it to the caller after locking the object. A copy is used to avoid thread-races.

Available since: 3.32

ide_notification_dup_title

Copies the current title and returns it to the caller after locking the object. A copy is used to avoid thread-races.

Available since: 3.32

ide_notification_get_button

Gets the button indexed by button, and stores information about the button into the various out parameters label, icon, action, and target.

Available since: 3.32

ide_notification_get_default_action
No description available.
ide_notification_get_has_progress

Gets if the notification supports progress updates.

Available since: 3.32

ide_notification_get_n_buttons
No description available.
ide_notification_get_priority
No description available.
ide_notification_get_progress

Gets the progress for the notification.

Available since: 3.32

ide_notification_get_progress_is_imprecise
No description available.
ide_notification_get_urgent
No description available.
ide_notification_ref_icon

Gets the icon for the notification, and returns a new reference to the GIcon.

Available since: 3.32

ide_notification_set_body

Sets the IdeNotification:body property.

Available since: 3.32

ide_notification_set_default_action
No description available.
ide_notification_set_has_progress

Set to TRUE if the notification supports progress updates.

Available since: 3.32

ide_notification_set_icon
No description available.
ide_notification_set_icon_name
No description available.
ide_notification_set_id

Sets the IdeNotification:id property.

Available since: 3.32

ide_notification_set_priority
No description available.
ide_notification_set_progress

Sets the progress for the notification.

Available since: 3.32

ide_notification_set_progress_is_imprecise
No description available.
ide_notification_set_title

Sets the IdeNotification:title property.

Available since: 3.32

ide_notification_set_urgent
No description available.
ide_notification_withdraw

Withdraws the notification by removing it from the IdeObject parent it belongs to.

Available since: 3.32

ide_notification_withdraw_in_seconds

Withdraws self from it’s IdeObject parent after seconds have passed.

Available since: 3.32

Methods inherited from IdeObject (28)
Methods inherited from GObject (43)

Properties

Ide.Notification:body

The “body” property is the main body of text for the notification. Not all notifications need this, but more complex notifications might.

Available since: 3.32

Ide.Notification:has-progress

The “has-progress” property denotes the notification will receive updates to the IdeNotification:progress property.

Available since: 3.32

Ide.Notification:icon

The “icon” property is an optional icon that may be shown next to the notification title and body under certain senarios.

Available since: 3.32

Ide.Notification:icon-name

The “icon-name” property is a helper to make setting IdeNotification:icon more convenient.

Available since: 3.32

Ide.Notification:id

The “id” property is an optional identifier that can be used to locate the notification later.

Available since: 3.32

Ide.Notification:priority

The “priority” property is used to sort the notification in order of importance when displaying to the user.

Available since: 3.32

Ide.Notification:progress

The “progress” property is a value between 0.0 and 1.0 describing the progress of the operation for which the notification represents.

Available since: 3.32

Ide.Notification:progress-is-imprecise

The “progress-is-imprecise” property indicates that the notification has progress, but it is imprecise.

Available since: 3.32

Ide.Notification:title

The “title” property is the main text to show the user. It may be displayed more prominently such as in the titlebar.

Available since: 3.32

Ide.Notification:urgent

If the notification is urgent. These notifications will be displayed with higher priority than those without the urgent property set.

Available since: 3.32

Properties inherited from IdeObject (2)
Ide.Object:cancellable

The “cancellable” property is a GCancellable that can be used by operations that will be cancelled when the IdeObject::destroy signal is emitted on self.

Available since: 3.32

Ide.Object:parent

The parent IdeObject, if any.

Available since: 3.32

Signals

Signals inherited from IdeObject (1)
Ide.Object::destroy

The “destroy” signal is emitted when the object should destroy itself and cleanup any state that is no longer necessary. This happens when the object has been removed from the because it was requested to be destroyed, or because a parent object is being destroyed.

Available since: 3.32

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct IdeNotificationClass {
  IdeObjectClass parent_class;
  None _reserved;
  
}
Class members
parent_class
IdeObjectClass
  No description available.
_reserved
None
  No description available.