diff options
Diffstat (limited to 'lib/gs-plugin-event.h')
-rw-r--r-- | lib/gs-plugin-event.h | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/lib/gs-plugin-event.h b/lib/gs-plugin-event.h new file mode 100644 index 0000000..dc74486 --- /dev/null +++ b/lib/gs-plugin-event.h @@ -0,0 +1,67 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- + * vi:set noexpandtab tabstop=8 shiftwidth=8: + * + * Copyright (C) 2016 Richard Hughes <richard@hughsie.com> + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#pragma once + +#include <glib-object.h> + +#include "gs-app.h" +#include "gs-plugin-types.h" + +G_BEGIN_DECLS + +#define GS_TYPE_PLUGIN_EVENT (gs_plugin_event_get_type ()) + +G_DECLARE_FINAL_TYPE (GsPluginEvent, gs_plugin_event, GS, PLUGIN_EVENT, GObject) + +/** + * GsPluginEventFlag: + * @GS_PLUGIN_EVENT_FLAG_NONE: No special flags set + * @GS_PLUGIN_EVENT_FLAG_INVALID: Event is no longer valid, e.g. was dismissed + * @GS_PLUGIN_EVENT_FLAG_VISIBLE: Event is is visible on the screen + * @GS_PLUGIN_EVENT_FLAG_WARNING: Event should be shown with more urgency + * @GS_PLUGIN_EVENT_FLAG_INTERACTIVE: The plugin job was created with interactive=True + * + * Any flags an event can have. + **/ +typedef enum { + GS_PLUGIN_EVENT_FLAG_NONE = 0, /* Since: 3.22 */ + GS_PLUGIN_EVENT_FLAG_INVALID = 1 << 0, /* Since: 3.22 */ + GS_PLUGIN_EVENT_FLAG_VISIBLE = 1 << 1, /* Since: 3.22 */ + GS_PLUGIN_EVENT_FLAG_WARNING = 1 << 2, /* Since: 3.22 */ + GS_PLUGIN_EVENT_FLAG_INTERACTIVE = 1 << 3, /* Since: 3.30 */ + /*< private >*/ + GS_PLUGIN_EVENT_FLAG_LAST +} GsPluginEventFlag; + +GsPluginEvent *gs_plugin_event_new (void); + +const gchar *gs_plugin_event_get_unique_id (GsPluginEvent *event); + +void gs_plugin_event_set_app (GsPluginEvent *event, + GsApp *app); +GsApp *gs_plugin_event_get_app (GsPluginEvent *event); +void gs_plugin_event_set_origin (GsPluginEvent *event, + GsApp *origin); +GsApp *gs_plugin_event_get_origin (GsPluginEvent *event); +void gs_plugin_event_set_action (GsPluginEvent *event, + GsPluginAction action); +GsPluginAction gs_plugin_event_get_action (GsPluginEvent *event); + +void gs_plugin_event_set_error (GsPluginEvent *event, + const GError *error); +const GError *gs_plugin_event_get_error (GsPluginEvent *event); + +void gs_plugin_event_add_flag (GsPluginEvent *event, + GsPluginEventFlag flag); +void gs_plugin_event_remove_flag (GsPluginEvent *event, + GsPluginEventFlag flag); +gboolean gs_plugin_event_has_flag (GsPluginEvent *event, + GsPluginEventFlag flag); + +G_END_DECLS |