summaryrefslogtreecommitdiff
path: root/libpurple/purpleidleui.h
diff options
context:
space:
mode:
authorGary Kramlich <grim@reaperworld.com>2021-10-22 03:33:32 -0500
committerGary Kramlich <grim@reaperworld.com>2021-10-22 03:33:32 -0500
commitf1da8613611d1ff9b13d3fca3f33d03a944b039d (patch)
tree0b8d5b07f2f79f2039f9457480a7c12ab0004f5d /libpurple/purpleidleui.h
parent0bc65db10522f7cb872027ada13b1cfd5fc39b87 (diff)
downloadpidgin-f1da8613611d1ff9b13d3fca3f33d03a944b039d.tar.gz
Replace PurpleIdleUiOps with the PurpleIdleUi Interface
This continues our path down replacing the UiOps with Interfaces so that developers can write user interfaces in other languages using gobject introspection. Testing Done: Ran pidgin3 and set it to auto idle after 1 minute of system idle time. This attempted to query xscreen saver, but something didn't work there, but that's been happening before this change. Not sure if it's my system or the code just needs fixing. Ran finch3 set idle time to 1 minute and verified that it set me to away after that minute. I also used the libpurple idle time for both pidgin3 and finch3 and verified they continued to work as well. Reviewed at https://reviews.imfreedom.org/r/1091/
Diffstat (limited to 'libpurple/purpleidleui.h')
-rw-r--r--libpurple/purpleidleui.h70
1 files changed, 70 insertions, 0 deletions
diff --git a/libpurple/purpleidleui.h b/libpurple/purpleidleui.h
new file mode 100644
index 0000000000..e319a26dae
--- /dev/null
+++ b/libpurple/purpleidleui.h
@@ -0,0 +1,70 @@
+/*
+ * Purple - Internet Messaging Library
+ * Copyright (C) Pidgin Developers <devel@pidgin.im>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses/>.
+ */
+
+#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
+# error "only <pidgin.h> may be included directly"
+#endif
+
+#ifndef PURPLE_IDLE_UI_H
+#define PURPLE_IDLE_UI_H
+
+#include <glib.h>
+#include <glib-object.h>
+
+#include <time.h>
+
+G_BEGIN_DECLS
+
+#define PURPLE_TYPE_IDLE_UI (purple_idle_ui_get_type())
+G_DECLARE_INTERFACE(PurpleIdleUi, purple_idle_ui, PURPLE, IDLE_UI, GObject)
+
+/**
+ * PurpleIdleUiInterface:
+ * @get_idle_time: vfunc to get the time that the user interface has been idle.
+ *
+ * An interface that a user interface can implement to let the core determine
+ * idle times.
+ *
+ * Since: 3.0.0
+ */
+struct _PurpleIdleUiInterface {
+ /*< private >*/
+ GTypeInterface parent;
+
+ /*< public >*/
+ time_t (*get_idle_time)(PurpleIdleUi *ui);
+
+ /*< private >*/
+ gpointer reserved[4];
+};
+
+/**
+ * purple_idle_ui_get_idle_time:
+ * @ui: The idle ui instance.
+ *
+ * Gets the idle time from the user interface.
+ *
+ * Returns: The time that the user interface went idle.
+ *
+ * Since: 3.0.0
+ */
+time_t purple_idle_ui_get_idle_time(PurpleIdleUi *ui);
+
+G_END_DECLS
+
+#endif /* PURPLE_ID_UI_H */