Move lxpanel_generic_config_dlg() declaration from misc.h into plugin.h.
authorAndriy Grytsenko <andrej@rep.kiev.ua>
Tue, 19 Aug 2014 15:04:07 +0000 (18:04 +0300)
committerAndriy Grytsenko <andrej@rep.kiev.ua>
Tue, 19 Aug 2014 15:08:42 +0000 (18:08 +0300)
That function is used by many plugins so that's more appropriate.

plugins/batt/batt.c
plugins/cpufreq/cpufreq.c
plugins/dclock.c
plugins/indicator/indicator.c
plugins/kbled/kbled.c
plugins/monitors/monitors.c
plugins/netstatus/netstatus.c
plugins/space.c
src/misc.h
src/plugin.h

index ea6cac5..427856c 100644 (file)
@@ -47,7 +47,6 @@
 
 #include "dbg.h" /* for ENTER and RET macros */
 #include "batt_sys.h"
-#include "misc.h" /* used for lxpanel_generic_config_dlg() */
 #include "plugin.h" /* all other APIs including panel configuration */
 
 /* The last MAX_SAMPLES samples are averaged when charge rates are evaluated.
index 327acd5..203f8e8 100644 (file)
@@ -28,7 +28,6 @@
 #include <string.h>
 
 #include "plugin.h"
-#include "misc.h"
 
 #include "dbg.h"
 
index ffc5656..1405900 100644 (file)
@@ -17,7 +17,6 @@
  */
 
 #include "plugin.h"
-#include "misc.h"
 
 #include <libfm/fm-gtk.h>
 
index 238fb6d..9e5d09f 100644 (file)
@@ -29,7 +29,6 @@ TODO : vertical support (r354)
 */
 
 #include "plugin.h"
-#include "misc.h"
 
 #include <stdlib.h>
 #include <glib/gi18n.h>
index c0ec8cf..4452828 100644 (file)
@@ -31,7 +31,6 @@
 
 #include <X11/XKBlib.h>
 
-#include "misc.h"
 #include "icon-grid.h"
 
 static const char * on_icons_theme[] = {
index db584c1..c127cf9 100644 (file)
@@ -71,7 +71,6 @@
 #include <libfm/fm-gtk.h>
 
 #include "plugin.h"
-#include "misc.h"
 
 #include "dbg.h"
 
index 1cda933..21e6216 100644 (file)
@@ -23,7 +23,6 @@
 #include <glib/gi18n.h>
 
 #include "plugin.h"
-#include "misc.h"
 
 #include "dbg.h"
 
index 353288b..9433ae8 100644 (file)
@@ -21,7 +21,6 @@
 #include <glib/gi18n.h>
 
 #include "plugin.h"
-#include "misc.h"
 
 /* Private context for space plugin. */
 typedef struct {
index 152f0fb..76e7faf 100644 (file)
@@ -147,22 +147,6 @@ GtkWidget *lxpanel_button_new_for_fm_icon(LXPanel *panel, FmIcon *icon, GdkColor
 void lxpanel_button_set_icon(GtkWidget* btn, const gchar *name, gint size);
 void lxpanel_button_update_icon(GtkWidget* btn, FmIcon *icon, gint size);
 
-typedef enum {
-    CONF_TYPE_STR,
-    CONF_TYPE_INT,
-    CONF_TYPE_BOOL,
-    CONF_TYPE_FILE,
-    CONF_TYPE_FILE_ENTRY,
-    CONF_TYPE_DIRECTORY_ENTRY,
-    CONF_TYPE_TRIM
-} PluginConfType;
-
-/* Parameters: const char* name, gpointer ret_value, PluginConfType type, ....NULL */
-extern GtkWidget *lxpanel_generic_config_dlg(const char *title, LXPanel *panel,
-                                             GSourceFunc apply_func,
-                                             GtkWidget *plugin,
-                                             const char *name, ...);
-
 G_END_DECLS
 
 #endif
index a0411c9..d162e6b 100644 (file)
@@ -119,6 +119,8 @@ extern GQuark lxpanel_plugin_qdata; /* access to plugin private data */
  * @_i: instance widget
  *
  * Retrieves instance data attached to the widget.
+ *
+ * Returns: (transfer none): pointer to the data.
  */
 #define lxpanel_plugin_get_data(_i) g_object_get_qdata(G_OBJECT(_i),lxpanel_plugin_qdata)
 
@@ -211,6 +213,45 @@ extern gboolean lxpanel_launch_path(LXPanel *panel, FmPath *path);
  */
 extern void lxpanel_plugin_show_config_dialog(GtkWidget* plugin);
 
+/**
+ * PluginConfType:
+ *
+ * Type of variable passed to lxpanel_generic_config_dlg().
+ */
+typedef enum {
+    CONF_TYPE_STR,
+    CONF_TYPE_INT,
+    CONF_TYPE_BOOL,
+    CONF_TYPE_FILE,
+    CONF_TYPE_FILE_ENTRY,
+    CONF_TYPE_DIRECTORY_ENTRY,
+    CONF_TYPE_TRIM
+} PluginConfType;
+
+/**
+ * lxpanel_generic_config_dlg
+ * @title: (allow-none): optional title of dialog window
+ * @panel: a panel instance
+ * @apply_func: (allow-none): function to apply changes to the plugin
+ * @plugin: (allow-none): an argument for @apply_func
+ * @name: variable-size list of options to configure, terminated with %NULL
+ *
+ * Creates a generic dialog widget to configure the plugin parameters.
+ * The dialog widget may be used for plugin's callback config() then.
+ * Variable-size list of options consists of three arguments for each
+ * option:
+ *   - const char* name: text representing the option in dialog
+ *   - gpointer ret_value: (out): pointer to the option value
+ *   - PluginConfType type: type of the option
+ *
+ * Returns: (tranfer full): new created dialog widget.
+ */
+/* Parameters: const char* name, gpointer ret_value, PluginConfType type, ....NULL */
+extern GtkWidget *lxpanel_generic_config_dlg(const char *title, LXPanel *panel,
+                                             GSourceFunc apply_func,
+                                             GtkWidget *plugin,
+                                             const char *name, ...);
+
 G_END_DECLS
 
 #endif /* __PLUGIN_H__ */