Class
ValentApplicationPlugin
since: 1.0
Description [src]
abstract class Valent.ApplicationPlugin : Valent.Extension {
parent_instance: ValentExtension
}
An abstract base class for application plugins.
ValentApplicationPlugin
is a base class for plugins that operate in the
scope of the application. This usually means integrating the application with
the host environment (eg. XDG Autostart).
Implementation Notes
Implementations may handle application events by overriding the appropriate
virtual function, including Valent.ApplicationPluginClass.activate
to
handle activation, Valent.ApplicationPluginClass.command_line
to handle
CLI options, or Valent.ApplicationPluginClass.open
to handle files.
For plugin preferences see ValentPreferencesPage
.
.plugin
File
Application plugins have no special fields in the .plugin
file.
Available since: 1.0
Instance methods
valent_application_plugin_dbus_register
Handle the D-Bus registration phase of the application.
since: 1.0
valent_application_plugin_dbus_unregister
Handle the D-Bus unregistration phase of the application.
since: 1.0
Methods inherited from ValentExtension (6)
valent_extension_get_context
Get the settings for this plugin.
since: 1.0
valent_extension_get_object
Get the object this plugin is bound to.
since: 1.0
valent_extension_get_settings
Get the settings for this plugin.
since: 1.0
valent_extension_plugin_state_changed
Emits GObject::notify
for
ValentExtension:plugin-state
.
since: 1.0
valent_extension_plugin_state_check
Get the extension state, while propagating any errors that describe it.
since: 1.0
valent_extension_toggle_actions
Enable or disable all actions.
since: 1.0
Methods inherited from ValentObject (8)
valent_object_chain_cancellable
Chain a cancellable to the object’s cancellable.
since: 1.0
valent_object_destroy
Destroy the object.
since: 1.0
valent_object_in_destruction
Get whether the object is destroyed or in destruction.
since: 1.0
valent_object_lock
Acquire a lock on object
.
since: 1.0
valent_object_notify
Emit GObject::notify
on object
, on the main thread.
since: 1.0
valent_object_notify_by_pspec
Emit GObject::notify
on object
, on the main thread.
since: 1.0
valent_object_ref_cancellable
Get a GCancellable
for the object.
since: 1.0
valent_object_unlock
Release a lock on object
.
since: 1.0
Methods inherited from GActionGroup (14)
g_action_group_action_added
Emits the GActionGroup::action-added
signal on action_group
.
unstable since: 2.28
g_action_group_action_enabled_changed
Emits the GActionGroup::action-enabled-changed
signal on action_group
.
unstable since: 2.28
g_action_group_action_removed
Emits the GActionGroup::action-removed
signal on action_group
.
unstable since: 2.28
g_action_group_action_state_changed
Emits the GActionGroup::action-state-changed
signal on action_group
.
unstable since: 2.28
g_action_group_activate_action
Activate the named action within action_group
.
unstable since: 2.28
g_action_group_change_action_state
Request for the state of the named action within action_group
to be
changed to value
.
unstable since: 2.28
g_action_group_get_action_enabled
Checks if the named action within action_group
is currently enabled.
unstable since: 2.28
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
.
unstable since: 2.28
g_action_group_get_action_state
Queries the current state of the named action within action_group
.
unstable since: 2.28
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
.
unstable since: 2.28
g_action_group_get_action_state_type
Queries the type of the state of the named action within
action_group
.
unstable since: 2.28
g_action_group_has_action
Checks if the named action exists within action_group
.
unstable since: 2.28
g_action_group_list_actions
Lists the actions contained within action_group
.
unstable since: 2.28
g_action_group_query_action
Queries all aspects of the named action within an action_group
.
unstable since: 2.32
Methods inherited from GActionMap (5)
g_action_map_add_action
Adds an action to the action_map
.
unstable since: 2.32
g_action_map_add_action_entries
A convenience function for creating multiple GSimpleAction
instances
and adding them to a GActionMap
.
unstable since: 2.32
g_action_map_lookup_action
Looks up the action with the name action_name
in action_map
.
unstable since: 2.32
g_action_map_remove_action
Removes the named action from the action map.
unstable since: 2.32
g_action_map_remove_action_entries
Remove actions from a GActionMap
. This is meant as the reverse of g_action_map_add_action_entries().
unstable since: 2.78
Properties
Properties inherited from ValentExtension (5)
Valent.Extension:context
The ValentDevice
this plugin is bound to.
since: 1.0
Valent.Extension:object
The GObject
this plugin is bound to.
since: 1.0
Valent.Extension:plugin-info
The PeasPluginInfo
describing this plugin.
since: 1.0
Valent.Extension:plugin-state
The ValentPluginState
describing the state of the extension.
since: 1.0
Valent.Extension:settings
The GSettings
for this plugin.
since: 1.0
Properties inherited from ValentObject (1)
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.
unstable since: 2.28
GActionGroup::action-enabled-changed
Signals that the enabled status of the named action has changed.
unstable since: 2.28
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.
unstable since: 2.28
GActionGroup::action-state-changed
Signals that the state of the named action has changed.
unstable since: 2.28
Class structure
struct ValentApplicationPluginClass {
ValentExtensionClass parent_class;
gboolean (* activate) (
ValentApplicationPlugin* plugin
);
int (* command_line) (
ValentApplicationPlugin* plugin,
GApplicationCommandLine* command_line
);
gboolean (* dbus_register) (
ValentApplicationPlugin* plugin,
GDBusConnection* connection,
const char* object_path,
GError** error
);
void (* dbus_unregister) (
ValentApplicationPlugin* plugin,
GDBusConnection* connection,
const char* object_path
);
gboolean (* open) (
ValentApplicationPlugin* plugin,
GFile** files,
int n_files,
const char* hint
);
void (* shutdown) (
ValentApplicationPlugin* plugin
);
void (* startup) (
ValentApplicationPlugin* plugin
);
}
The virtual function table for ValentApplicationPlugin
.
Class members
parent_class: ValentExtensionClass
- No description available.
activate: gboolean (* activate) ( ValentApplicationPlugin* plugin )
- No description available.
command_line: int (* command_line) ( ValentApplicationPlugin* plugin, GApplicationCommandLine* command_line )
- No description available.
dbus_register: gboolean (* dbus_register) ( ValentApplicationPlugin* plugin, GDBusConnection* connection, const char* object_path, GError** error )
- No description available.
dbus_unregister: void (* dbus_unregister) ( ValentApplicationPlugin* plugin, GDBusConnection* connection, const char* object_path )
- No description available.
open: gboolean (* open) ( ValentApplicationPlugin* plugin, GFile** files, int n_files, const char* hint )
- No description available.
shutdown: void (* shutdown) ( ValentApplicationPlugin* plugin )
- No description available.
startup: void (* startup) ( ValentApplicationPlugin* plugin )
- No description available.
Virtual methods
Valent.ApplicationPluginClass.dbus_register
Handle the D-Bus registration phase of the application.
since: 1.0
Valent.ApplicationPluginClass.dbus_unregister
Handle the D-Bus unregistration phase of the application.
since: 1.0