aboutsummaryrefslogtreecommitdiff
path: root/src/libappindicator/app-indicator.h
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2009-11-30 10:58:09 -0600
committerTed Gould <ted@gould.cx>2009-11-30 10:58:09 -0600
commit997bdb5be1665441cfa2e13d4cb0c9733e7776f6 (patch)
tree55c70cd06c7d34ca974144f36b68855c07959fe1 /src/libappindicator/app-indicator.h
parent8eff74d9fb43dfc5e86ca6225cdbfb31f550c100 (diff)
downloadayatana-indicator-application-997bdb5be1665441cfa2e13d4cb0c9733e7776f6.tar.gz
ayatana-indicator-application-997bdb5be1665441cfa2e13d4cb0c9733e7776f6.tar.bz2
ayatana-indicator-application-997bdb5be1665441cfa2e13d4cb0c9733e7776f6.zip
Shortening the file names as well.
Diffstat (limited to 'src/libappindicator/app-indicator.h')
-rw-r--r--src/libappindicator/app-indicator.h142
1 files changed, 142 insertions, 0 deletions
diff --git a/src/libappindicator/app-indicator.h b/src/libappindicator/app-indicator.h
new file mode 100644
index 0000000..2e9045c
--- /dev/null
+++ b/src/libappindicator/app-indicator.h
@@ -0,0 +1,142 @@
+#ifndef __CUSTOM_INDICATOR_H__
+#define __CUSTOM_INDICATOR_H__
+
+#include <glib.h>
+#include <glib-object.h>
+#include <libdbusmenu-glib/server.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))
+
+#define CUSTOM_INDICATOR_SIGNAL_NEW_ICON "new-icon"
+#define CUSTOM_INDICATOR_SIGNAL_NEW_ATTENTION_ICON "new-attention-icon"
+#define CUSTOM_INDICATOR_SIGNAL_NEW_STATUS "new-status"
+#define CUSTOM_INDICATOR_SIGNAL_CONNECTION_CHANGED "connection-changed"
+
+/**
+ CustomIndicatorCategory:
+ @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
+} CustomIndicatorCategory;
+
+/**
+ CustomIndicatorStatus:
+ @CUSTOM_INDICATOR_STATUS_PASSIVE: The indicator should not be shown to the user.
+ @CUSTOM_INDICATOR_STATUS_ACTIVE: 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_PASSIVE,
+ CUSTOM_INDICATOR_STATUS_ACTIVE,
+ CUSTOM_INDICATOR_STATUS_ATTENTION
+} CustomIndicatorStatus;
+
+typedef struct _CustomIndicator CustomIndicator;
+typedef struct _CustomIndicatorClass CustomIndicatorClass;
+
+/**
+ CustomIndicatorClass:
+ @parent_class: Mia familia
+ @new_icon: Slot for #CustomIndicator::new-icon.
+ @new_attention_icon: Slot for #CustomIndicator::new-attention-icon.
+ @new_status: Slot for #CustomIndicator::new-status.
+ @connection_changed: Slot for #CustomIndicator::connection-changed.
+ @custom_indicator_reserved_1: Reserved for future use.
+ @custom_indicator_reserved_2: Reserved for future use.
+ @custom_indicator_reserved_3: Reserved for future use.
+ @custom_indicator_reserved_4: Reserved for future use.
+
+ The signals and external functions that make up the #CustomIndicator
+ class object.
+*/
+struct _CustomIndicatorClass {
+ /* Parent */
+ GObjectClass parent_class;
+
+ /* DBus Signals */
+ void (* new_icon) (CustomIndicator * indicator,
+ gpointer user_data);
+ void (* new_attention_icon) (CustomIndicator * indicator,
+ gpointer user_data);
+ void (* new_status) (CustomIndicator * indicator,
+ gchar * status_string,
+ gpointer user_data);
+
+ /* Local Signals */
+ void (* connection_changed) (CustomIndicator * indicator,
+ gboolean connected,
+ gpointer user_data);
+
+ /* Reserved */
+ void (*custom_indicator_reserved_1)(void);
+ void (*custom_indicator_reserved_2)(void);
+ void (*custom_indicator_reserved_3)(void);
+ void (*custom_indicator_reserved_4)(void);
+};
+
+/**
+ CustomIndicator:
+ @parent: Parent object.
+
+ A custom indicator represents the values that are needed to show a
+ unique status in the panel for an application. In general, applications
+ should try to fit in the other indicators that are available on the
+ panel before using this. But, sometimes it is necissary.
+*/
+struct _CustomIndicator {
+ GObject parent;
+ /* None. We're a very private object. */
+};
+
+/* 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,
+ CustomIndicatorCategory category);
+void custom_indicator_set_status (CustomIndicator * ci,
+ CustomIndicatorStatus 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,
+ DbusmenuServer * menu);
+
+/* Get properties */
+const gchar * custom_indicator_get_id (CustomIndicator * ci);
+CustomIndicatorCategory custom_indicator_get_category (CustomIndicator * ci);
+CustomIndicatorStatus custom_indicator_get_status (CustomIndicator * ci);
+const gchar * custom_indicator_get_icon (CustomIndicator * ci);
+const gchar * custom_indicator_get_attention_icon (CustomIndicator * ci);
+DbusmenuServer * custom_indicator_get_menu (CustomIndicator * ci);
+
+G_END_DECLS
+
+#endif