From b666cc1867e04d697f381fa8033803b9e7d0f61d Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 15 Oct 2009 21:12:52 -0500 Subject: Building a basic library starting out. --- src/libcustomindicator/custom-indicator.h | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 src/libcustomindicator/custom-indicator.h (limited to 'src/libcustomindicator/custom-indicator.h') diff --git a/src/libcustomindicator/custom-indicator.h b/src/libcustomindicator/custom-indicator.h new file mode 100644 index 0000000..6e94d3f --- /dev/null +++ b/src/libcustomindicator/custom-indicator.h @@ -0,0 +1,31 @@ +#ifndef __CUSTOM_INDICATOR_H__ +#define __CUSTOM_INDICATOR_H__ + +#include +#include + +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)) + +typedef struct _CustomIndicator CustomIndicator; +typedef struct _CustomIndicatorClass CustomIndicatorClass; + +struct _CustomIndicatorClass { + GObjectClass parent_class; +}; + +struct _CustomIndicator { + GObject parent; +}; + +GType custom_indicator_get_type (void); + +G_END_DECLS + +#endif -- cgit v1.2.3 From 1101075695054df49e96d815fec28b4e9ea0287a Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Fri, 16 Oct 2009 12:33:31 -0500 Subject: Building a basic prototype of the API for the lib. --- src/libcustomindicator/custom-indicator.h | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) (limited to 'src/libcustomindicator/custom-indicator.h') diff --git a/src/libcustomindicator/custom-indicator.h b/src/libcustomindicator/custom-indicator.h index 6e94d3f..9bdae11 100644 --- a/src/libcustomindicator/custom-indicator.h +++ b/src/libcustomindicator/custom-indicator.h @@ -13,6 +13,9 @@ G_BEGIN_DECLS #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)) +typedef int custom_indicator_category_t; +typedef int custom_indicator_status_t; + typedef struct _CustomIndicator CustomIndicator; typedef struct _CustomIndicatorClass CustomIndicatorClass; @@ -24,7 +27,30 @@ struct _CustomIndicator { GObject parent; }; -GType custom_indicator_get_type (void); +/* 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 -- cgit v1.2.3 From 0b6ffb4f6ba06d90d2744fb29d929b9872947a9f Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Fri, 16 Oct 2009 14:31:35 -0500 Subject: Filling out the enums to have values. --- src/libcustomindicator/custom-indicator.h | 37 +++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) (limited to 'src/libcustomindicator/custom-indicator.h') diff --git a/src/libcustomindicator/custom-indicator.h b/src/libcustomindicator/custom-indicator.h index 9bdae11..200e55f 100644 --- a/src/libcustomindicator/custom-indicator.h +++ b/src/libcustomindicator/custom-indicator.h @@ -13,8 +13,41 @@ G_BEGIN_DECLS #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)) -typedef int custom_indicator_category_t; -typedef int custom_indicator_status_t; +/** + 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; -- cgit v1.2.3 From 06111bcb8f073c9e574d523d03ecf27f7a6d22e4 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Sat, 17 Oct 2009 22:16:44 -0500 Subject: Making the enums camel case. I prefer the other, but it seems best to match GTK style --- src/libcustomindicator/custom-indicator.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'src/libcustomindicator/custom-indicator.h') diff --git a/src/libcustomindicator/custom-indicator.h b/src/libcustomindicator/custom-indicator.h index 200e55f..0ac8808 100644 --- a/src/libcustomindicator/custom-indicator.h +++ b/src/libcustomindicator/custom-indicator.h @@ -14,7 +14,7 @@ G_BEGIN_DECLS #define CUSTOM_INDICATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CUSTOM_INDICATOR_TYPE, CustomIndicatorClass)) /** - custom_indicator_category_t: + 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. @@ -30,10 +30,10 @@ typedef enum { /*< prefix=CUSTOM_INDICATOR_CATEGORY >*/ CUSTOM_INDICATOR_CATEGORY_SYSTEM_SERVICES, CUSTOM_INDICATOR_CATEGORY_HARDWARE, CUSTOM_INDICATOR_CATEGORY_OTHER -} custom_indicator_category_t; +} CustomIndicatorCategory; /** - custom_indicator_status_t: + CustomIndicatorStatus: @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. @@ -47,7 +47,7 @@ typedef enum { /*< prefix=CUSTOM_INDICATOR_STATUS >*/ CUSTOM_INDICATOR_STATUS_OFF, CUSTOM_INDICATOR_STATUS_ON, CUSTOM_INDICATOR_STATUS_ATTENTION -} custom_indicator_status_t; +} CustomIndicatorStatus; typedef struct _CustomIndicator CustomIndicator; typedef struct _CustomIndicatorClass CustomIndicatorClass; @@ -67,9 +67,9 @@ GType custom_indicator_get_type (void); void custom_indicator_set_id (CustomIndicator * ci, const gchar * id); void custom_indicator_set_category (CustomIndicator * ci, - custom_indicator_category_t category); + CustomIndicatorCategory category); void custom_indicator_set_status (CustomIndicator * ci, - custom_indicator_status_t status); + CustomIndicatorStatus status); void custom_indicator_set_icon (CustomIndicator * ci, const gchar * icon_name); void custom_indicator_set_attention_icon (CustomIndicator * ci, @@ -79,8 +79,8 @@ void custom_indicator_set_menu (CustomIndic /* 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); +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); void * custom_indicator_get_menu (CustomIndicator * ci); -- cgit v1.2.3