aboutsummaryrefslogtreecommitdiff
path: root/src/libcustomindicator/custom-indicator.h
diff options
context:
space:
mode:
authorTed Gould <ted@canonical.com>2009-10-16 15:36:22 -0500
committerTed Gould <ted@canonical.com>2009-10-16 15:36:22 -0500
commit227666e9b4a1d928875513acfa8f019497a4261f (patch)
tree3aee3d9693a6f612e019acb27936ee0b985e874c /src/libcustomindicator/custom-indicator.h
parent664bc74b6f0b3eb6ca30539628e2350ed3a2e20c (diff)
parent50e28fd237a7de7e3f28332711dc01c7fe8e4dbd (diff)
downloadayatana-indicator-application-227666e9b4a1d928875513acfa8f019497a4261f.tar.gz
ayatana-indicator-application-227666e9b4a1d928875513acfa8f019497a4261f.tar.bz2
ayatana-indicator-application-227666e9b4a1d928875513acfa8f019497a4261f.zip
Merging in the library interface.
Diffstat (limited to 'src/libcustomindicator/custom-indicator.h')
-rw-r--r--src/libcustomindicator/custom-indicator.h90
1 files changed, 90 insertions, 0 deletions
diff --git a/src/libcustomindicator/custom-indicator.h b/src/libcustomindicator/custom-indicator.h
new file mode 100644
index 0000000..200e55f
--- /dev/null
+++ b/src/libcustomindicator/custom-indicator.h
@@ -0,0 +1,90 @@
+#ifndef __CUSTOM_INDICATOR_H__
+#define __CUSTOM_INDICATOR_H__
+
+#include <glib.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define CUSTOM_INDICATOR_TYPE (custom_indicator_get_type ())
+#define CUSTOM_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CUSTOM_INDICATOR_TYPE, CustomIndicator))
+#define CUSTOM_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CUSTOM_INDICATOR_TYPE, CustomIndicatorClass))
+#define IS_CUSTOM_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CUSTOM_INDICATOR_TYPE))
+#define IS_CUSTOM_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CUSTOM_INDICATOR_TYPE))
+#define CUSTOM_INDICATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CUSTOM_INDICATOR_TYPE, CustomIndicatorClass))
+
+/**
+ custom_indicator_category_t:
+ @CUSTOM_INDICATOR_CATEGORY_APPLICATION_STATUS: The indicator is used to display the status of the application.
+ @CUSTOM_INDICATOR_CATEGORY_COMMUNICATIONS: The application is used for communication with other people.
+ @CUSTOM_INDICATOR_CATEGORY_SYSTEM_SERVICES: A system indicator relating to something in the user's system.
+ @CUSTOM_INDICATOR_CATEGORY_HARDWARE: An indicator relating to the user's hardware.
+ @CUSTOM_INDICATOR_CATEGORY_OTHER: Something not defined in this enum, please don't use unless you really need it.
+
+ The category provides grouping for the indicators so that
+ users can find indicators that are similar together.
+*/
+typedef enum { /*< prefix=CUSTOM_INDICATOR_CATEGORY >*/
+ CUSTOM_INDICATOR_CATEGORY_APPLICATION_STATUS,
+ CUSTOM_INDICATOR_CATEGORY_COMMUNICATIONS,
+ CUSTOM_INDICATOR_CATEGORY_SYSTEM_SERVICES,
+ CUSTOM_INDICATOR_CATEGORY_HARDWARE,
+ CUSTOM_INDICATOR_CATEGORY_OTHER
+} custom_indicator_category_t;
+
+/**
+ custom_indicator_status_t:
+ @CUSTOM_INDICATOR_STATUS_OFF: The indicator should not be shown to the user.
+ @CUSTOM_INDICATOR_STATUS_ON: The indicator should be shown in it's default state.
+ @CUSTOM_INDICATOR_STATUS_ATTENTION: The indicator should show it's attention icon.
+
+ These are the states that the indicator can be on in
+ the user's panel. The indicator by default starts
+ in the state @CUSTOM_INDICATOR_STATUS_OFF and can be
+ shown by setting it to @CUSTOM_INDICATOR_STATUS_ON.
+*/
+typedef enum { /*< prefix=CUSTOM_INDICATOR_STATUS >*/
+ CUSTOM_INDICATOR_STATUS_OFF,
+ CUSTOM_INDICATOR_STATUS_ON,
+ CUSTOM_INDICATOR_STATUS_ATTENTION
+} custom_indicator_status_t;
+
+typedef struct _CustomIndicator CustomIndicator;
+typedef struct _CustomIndicatorClass CustomIndicatorClass;
+
+struct _CustomIndicatorClass {
+ GObjectClass parent_class;
+};
+
+struct _CustomIndicator {
+ GObject parent;
+};
+
+/* GObject Stuff */
+GType custom_indicator_get_type (void);
+
+/* Set properties */
+void custom_indicator_set_id (CustomIndicator * ci,
+ const gchar * id);
+void custom_indicator_set_category (CustomIndicator * ci,
+ custom_indicator_category_t category);
+void custom_indicator_set_status (CustomIndicator * ci,
+ custom_indicator_status_t status);
+void custom_indicator_set_icon (CustomIndicator * ci,
+ const gchar * icon_name);
+void custom_indicator_set_attention_icon (CustomIndicator * ci,
+ const gchar * icon_name);
+void custom_indicator_set_menu (CustomIndicator * ci,
+ void * menu);
+
+/* Get properties */
+const gchar * custom_indicator_get_id (CustomIndicator * ci);
+custom_indicator_category_t custom_indicator_get_category (CustomIndicator * ci);
+custom_indicator_status_t custom_indicator_get_status (CustomIndicator * ci);
+const gchar * custom_indicator_get_icon (CustomIndicator * ci);
+const gchar * custom_indicator_get_attention_icon (CustomIndicator * ci);
+void * custom_indicator_get_menu (CustomIndicator * ci);
+
+G_END_DECLS
+
+#endif