Class
IdeNotification
Ancestors
- IdeObject
- GObject
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
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
ide_notification_get_has_progress
Gets if the notification supports progress updates.
Available since: 3.32
ide_notification_get_n_buttons
ide_notification_get_priority
ide_notification_get_progress_is_imprecise
ide_notification_get_urgent
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_default_action
ide_notification_set_default_action_and_target_value
ide_notification_set_has_progress
Set to TRUE
if the notification supports progress updates.
Available since: 3.32
ide_notification_set_icon
ide_notification_set_icon_name
ide_notification_set_priority
ide_notification_set_progress_is_imprecise
ide_notification_set_urgent
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)
ide_object_add
Adds child
to self
, with location dependent on location
.
Available since: 3.32
ide_object_append
Inserts child
as the last child of self
.
Available since: 3.32
ide_object_destroy
ide_object_ensure_child_typed
Like ide_object_get_child_typed()
except that it creates an object of
type
if it is missing.
Available since: 3.32
ide_object_foreach
Calls callback
for each child of self
.
Available since: 3.32
ide_object_get_child_typed
Finds the first child of self
that is of type
.
Available since: 3.32
ide_object_get_children_typed
Gets all children matching type
.
Available since: 3.32
ide_object_get_context
Gets the IdeContext
for the object.
Available since: 3.32
ide_object_get_n_children
Gets the number of children for an object.
Available since: 3.32
ide_object_get_nth_child
Gets the nth
child of self
.
Available since: 3.32
ide_object_get_parent
Gets the parent IdeObject
, if any.
Available since: 3.32
ide_object_get_position
Gets the position of self
within the parent node.
Available since: 3.32
ide_object_in_destruction
ide_object_insert_after
Inserts child
into self
‘s children, directly after sibling
.
Available since: 3.32
ide_object_insert_before
Inserts child
into self
‘s children, directly before sibling
.
Available since: 3.32
ide_object_insert_sorted
Locates the proper sibling for child
by using func
amongst self
‘s
children IdeObject
. Those objects must already be sorted.
Available since: 3.32
ide_object_is_root
Checks if self
is root, meaning it has no parent.
Available since: 3.32
ide_object_lock
Acquires the lock for self
. This can be useful when you need to do
multi-threaded work with self
and want to ensure exclusivity.
Available since: 3.32
ide_object_prepend
Inserts child
as the first child of self
.
Available since: 3.32
ide_object_ref_cancellable
Gets a GCancellable
for the object.
Available since: 3.32
ide_object_ref_context
Gets the root IdeContext
for the object, if any.
Available since: 3.32
ide_object_ref_parent
Gets the parent IdeObject
, if any.
Available since: 3.32
ide_object_ref_root
Finds and returns the toplevel object in the tree.
Available since: 3.32
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
Class structure
struct IdeNotificationClass {
IdeObjectClass parent_class;
None _reserved;
}
Class members
parent_class |
|
No description available. | |
_reserved |
|
No description available. |
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