Class
ValentExtension
unstable since: 1.0
Description [src]
abstract class Valent.Extension : Valent.Object
implements Gio.ActionGroup, Gio.ActionMap {
/* No available fields */
}An abstract base class for extensions.
ValentExtension is a base class for extensions with conveniences for
GAction, GSettings backed by ValentContext.
Plugin Actions
ValentExtension implements the GActionGroup and
GActionMap interfaces, providing a simple way for plugins to
expose functions and states. Each GAction added to the action map
will be included in the object action group with the plugin’s module name as
a prefix (eg. share.uri).
.plugin File
Implementations may define the extra fields in the .plugin file, to take
advantage of core features in the base class.
The field names are inferred from the GType name of the implementation, with
Valent being stripped if present. For example ValentDevicePlugin becomes
X-DevicePluginSettings, while NameDevicePlugin would become
X-NameDevicePluginSettings.
-
Extension Category Field
A list of categories separated by semi-colons, serving as a hint for organizational purposes. This should be in the form
Main;Additional;, with values from the freedesktop.org Desktop Menu Specification.Field pattern:
X-<type name>Category -
GSettingsSchema FieldA
GSettingsschema ID for the extensions’s settings. Seevalent_context_get_plugin_settings()for more information.Field pattern:
X-<type name>Settings.
Available since: 1.0
Instance methods
valent_extension_plugin_state_changed
Emits GObject::notify for
ValentExtension:plugin-state.
unstable since: 1.0
valent_extension_plugin_state_check
Get the extension state, while propagating any errors that describe it.
unstable since: 1.0
Methods inherited from ValentObject (9)
valent_object_chain_cancellable
Chain a cancellable to the object’s cancellable.
unstable since: 1.0
valent_object_destroy
Destroy the object.
unstable since: 1.0
valent_object_dup_iri
Get a copy of the IRI for the object.
unstable since: 1.0
valent_object_in_destruction
Get whether the object is destroyed or in destruction.
unstable since: 1.0
valent_object_lock
Acquire a lock on object.
unstable since: 1.0
valent_object_notify
Emit GObject::notify on object, on the main thread.
unstable since: 1.0
valent_object_notify_by_pspec
Emit GObject::notify on object, on the main thread.
unstable since: 1.0
valent_object_ref_cancellable
Get a GCancellable for the object.
unstable since: 1.0
valent_object_unlock
Release a lock on object.
unstable since: 1.0
Methods inherited from GActionGroup (14)
g_action_group_action_added
Emits the GActionGroup::action-added signal on action_group.
g_action_group_action_enabled_changed
Emits the GActionGroup::action-enabled-changed signal on action_group.
g_action_group_action_removed
Emits the GActionGroup::action-removed signal on action_group.
g_action_group_action_state_changed
Emits the GActionGroup::action-state-changed signal on action_group.
g_action_group_activate_action
Activate the named action within action_group.
g_action_group_change_action_state
Request for the state of the named action within action_group to be
changed to value.
g_action_group_get_action_enabled
Checks if the named action within action_group is currently enabled.
g_action_group_get_action_parameter_type
Queries the type of the parameter that must be given when activating
the named action within action_group.
g_action_group_get_action_state
Queries the current state of the named action within action_group.
g_action_group_get_action_state_hint
Requests a hint about the valid range of values for the state of the
named action within action_group.
g_action_group_get_action_state_type
Queries the type of the state of the named action within
action_group.
g_action_group_has_action
Checks if the named action exists within action_group.
g_action_group_list_actions
Lists the actions contained within action_group.
g_action_group_query_action
Queries all aspects of the named action within an action_group.
Methods inherited from GActionMap (5)
g_action_map_add_action
Adds an action to the action_map.
g_action_map_add_action_entries
A convenience function for creating multiple GSimpleAction instances
and adding them to a GActionMap.
g_action_map_lookup_action
Looks up the action with the name action_name in action_map.
g_action_map_remove_action
Removes the named action from the action map.
g_action_map_remove_action_entries
Remove actions from a GActionMap. This is meant as the reverse of g_action_map_add_action_entries().
Properties
Valent.Extension:plugin-state
The ValentPluginState describing the state of the extension.
unstable since: 1.0
Properties inherited from ValentObject (2)
Valent.Object:cancellable
The object GCancellable.
unstable since: 1.0
Valent.Object:iri
The object IRI.
unstable since: 1.0
Signals
Signals inherited from ValentObject (1)
Signals inherited from GObject (1)
GObject::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.
Signals inherited from GActionGroup (4)
GActionGroup::action-added
Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.
GActionGroup::action-enabled-changed
Signals that the enabled status of the named action has changed.
GActionGroup::action-removed
Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.
GActionGroup::action-state-changed
Signals that the state of the named action has changed.