Class

ValentApplicationPlugin

unstable since: 1.0

Description [src]

abstract class Valent.ApplicationPlugin : Valent.Extension
  implements Gio.ActionGroup, Gio.ActionMap {
  /* No available fields */
}

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

Hierarchy

hierarchy this ValentApplicationPlugin implements_0 GActionGroup this--implements_0 implements_1 GActionMap this--implements_1 ancestor_0 ValentExtension ancestor_0--this ancestor_1 ValentObject ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Descendants

Instance methods

valent_application_plugin_activate

Handle activation of the application.

unstable since: 1.0

valent_application_plugin_command_line

Handle the given command-line options.

unstable since: 1.0

valent_application_plugin_dbus_register

Handle the D-Bus registration phase of the application.

unstable since: 1.0

valent_application_plugin_dbus_unregister

Handle the D-Bus unregistration phase of the application.

unstable since: 1.0

valent_application_plugin_open

Open the given files.

unstable since: 1.0

valent_application_plugin_shutdown

Handle the shutdown phase of the application.

unstable since: 1.0

valent_application_plugin_startup

Handle the startup phase of the application.

unstable since: 1.0

Methods inherited from ValentExtension (6)
valent_extension_get_context

Get the settings for this plugin.

unstable since: 1.0

valent_extension_get_object

Get the object this plugin is bound to.

unstable since: 1.0

valent_extension_get_settings

Get the settings for this plugin.

unstable since: 1.0

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

valent_extension_toggle_actions

Enable or disable all actions.

unstable since: 1.0

Methods inherited from ValentObject (8)
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_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 GObject (43)

Please see GObject for a full list of methods.

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.

unstable since: 1.0

Valent.Extension:object

The GObject this plugin is bound to.

unstable since: 1.0

Valent.Extension:plugin-info

The PeasPluginInfo describing this plugin.

unstable since: 1.0

Valent.Extension:plugin-state

The ValentPluginState describing the state of the extension.

unstable since: 1.0

Valent.Extension:settings

The GSettings for this plugin.

unstable since: 1.0

Properties inherited from ValentObject (1)
Valent.Object:cancellable

The object GCancellable.

unstable since: 1.0

Signals

Signals inherited from ValentObject (1)
ValentObject::destroy

Emitted when the object is being destroyed.

unstable since: 1.0

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 )

The virtual function pointer for valent_application_plugin_activate()

command_line: int (* command_line) ( ValentApplicationPlugin* plugin, GApplicationCommandLine* command_line )

The virtual function pointer for valent_application_plugin_command_line()

dbus_register: gboolean (* dbus_register) ( ValentApplicationPlugin* plugin, GDBusConnection* connection, const char* object_path, GError** error )

The virtual function pointer for valent_application_plugin_dbus_register()

dbus_unregister: void (* dbus_unregister) ( ValentApplicationPlugin* plugin, GDBusConnection* connection, const char* object_path )

The virtual function pointer for valent_application_plugin_dbus_unregister()

open: gboolean (* open) ( ValentApplicationPlugin* plugin, GFile** files, int n_files, const char* hint )

The virtual function pointer for valent_application_plugin_open()

shutdown: void (* shutdown) ( ValentApplicationPlugin* plugin )

The virtual function pointer for valent_application_plugin_shutdown()

startup: void (* startup) ( ValentApplicationPlugin* plugin )

The virtual function pointer for valent_application_plugin_startup()

Virtual methods

Valent.ApplicationPluginClass.activate

Handle activation of the application.

unstable since: 1.0

Valent.ApplicationPluginClass.command_line

Handle the given command-line options.

unstable since: 1.0

Valent.ApplicationPluginClass.dbus_register

Handle the D-Bus registration phase of the application.

unstable since: 1.0

Valent.ApplicationPluginClass.dbus_unregister

Handle the D-Bus unregistration phase of the application.

unstable since: 1.0

Valent.ApplicationPluginClass.open

Open the given files.

unstable since: 1.0

Valent.ApplicationPluginClass.shutdown

Handle the shutdown phase of the application.

unstable since: 1.0

Valent.ApplicationPluginClass.startup

Handle the startup phase of the application.

unstable since: 1.0