From 629324674c65f9ddcc89ec50cac747ac7040d798 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Wed, 19 May 2010 14:04:33 -0500 Subject: releasing version 0.2.0~dev-0ubuntu1~ppa1 --- .../html/libappindicator-app-indicator.html | 128 ++++++++++----------- 1 file changed, 60 insertions(+), 68 deletions(-) (limited to 'docs/reference/html/libappindicator-app-indicator.html') diff --git a/docs/reference/html/libappindicator-app-indicator.html b/docs/reference/html/libappindicator-app-indicator.html index e8517b7..332e705 100644 --- a/docs/reference/html/libappindicator-app-indicator.html +++ b/docs/reference/html/libappindicator-app-indicator.html @@ -66,48 +66,48 @@ enum AppIndicatorPrivate; AppIndicator; AppIndicatorClass; -GType app_indicator_get_type (void); -AppIndicator * app_indicator_new (const gchar *id, - const gchar *icon_name, +GType app_indicator_get_type (void); +AppIndicator * app_indicator_new (const gchar *id, + const gchar *icon_name, AppIndicatorCategory category); -AppIndicator * app_indicator_new_with_path (const gchar *id, - const gchar *icon_name, +AppIndicator * app_indicator_new_with_path (const gchar *id, + const gchar *icon_name, AppIndicatorCategory category, - const gchar *icon_path); + const gchar *icon_path); void app_indicator_set_status (AppIndicator *self, AppIndicatorStatus status); void app_indicator_set_attention_icon (AppIndicator *self, - const gchar *icon_name); + const gchar *icon_name); void app_indicator_set_menu (AppIndicator *self, - GtkMenu *menu); + GtkMenu *menu); void app_indicator_set_icon (AppIndicator *self, - const gchar *icon_name); -const gchar * app_indicator_get_id (AppIndicator *self); + const gchar *icon_name); +const gchar * app_indicator_get_id (AppIndicator *self); AppIndicatorCategory app_indicator_get_category (AppIndicator *self); AppIndicatorStatus app_indicator_get_status (AppIndicator *self); -const gchar * app_indicator_get_icon (AppIndicator *self); -const gchar * app_indicator_get_attention_icon (AppIndicator *self); -GtkMenu * app_indicator_get_menu (AppIndicator *self); +const gchar * app_indicator_get_icon (AppIndicator *self); +const gchar * app_indicator_get_attention_icon (AppIndicator *self); +GtkMenu * app_indicator_get_menu (AppIndicator *self);

Object Hierarchy

-  GObject
+  GObject
    +----AppIndicator

Properties

-  "attention-icon-name"      gchar*                : Read / Write
-  "category"                 gchar*                : Read / Write / Construct Only
-  "connected"                gboolean              : Read
-  "icon-name"                gchar*                : Read / Write
-  "icon-theme-path"          gchar*                : Read / Write / Construct Only
-  "id"                       gchar*                : Read / Write / Construct Only
+  "attention-icon-name"      gchar*                : Read / Write
+  "category"                 gchar*                : Read / Write / Construct Only
+  "connected"                gboolean              : Read
+  "icon-name"                gchar*                : Read / Write
+  "icon-theme-path"          gchar*                : Read / Write / Construct Only
+  "id"                       gchar*                : Read / Write / Construct Only
   "menu"                     DBusGObjectPath*      : Read
-  "status"                   gchar*                : Read / Write
+  "status"                   gchar*                : Read / Write
@@ -139,7 +139,7 @@ An application indicator is a way for an application to put 
#define APP_INDICATOR_TYPE            (app_indicator_get_type ())

-Get the GType for a AppIndicator. +Get the GType for a AppIndicator.

@@ -148,7 +148,7 @@ Get the #define APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator))

-Safely convert a GObject into an AppIndicator. +Safely convert a GObject into an AppIndicator.

@@ -165,14 +165,14 @@ Safely convert a #define APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), APP_INDICATOR_TYPE, AppIndicatorClass))

-Safely convert a GObjectClass into a AppIndicatorClass. +Safely convert a GObjectClass into a AppIndicatorClass.

klass :

 -GObjectClass based class to convert. +GObjectClass based class to convert.
@@ -189,7 +189,7 @@ Checks to see if obj is in the object hi

obj :

-An GObject to check +An GObject to check @@ -206,7 +206,7 @@ Checks to see if klass is in the object

klass :

-An GObjectClass to check +An GObjectClass to check @@ -223,7 +223,7 @@ Gets a pointer to the

obj :

-A GObject in the class hierarchy of AppIndicator. +A GObject in the class hierarchy of AppIndicator. @@ -354,10 +354,6 @@ These are the states that the indicator can be on in All of the private data in an instance of a application indicator.

-
-- -
@@ -369,10 +365,6 @@ A application indicator represents the values that are needed to show a should try to fit in the other indicators that are available on the panel before using this. But, sometimes it is necissary.

-
-- -
@@ -413,7 +405,7 @@ The signals and external functions that make up the -

GObjectClass parent_class;

+

GObjectClass parent_class;

Mia familia @@ -439,7 +431,7 @@ The signals and external functions that make up the fallback ()

-Function that gets called to make a GtkStatusIcon when +Function that gets called to make a GtkStatusIcon when there is no Application Indicator area available. @@ -465,15 +457,15 @@ The signals and external functions that make up the

app_indicator_get_type ()

-
GType               app_indicator_get_type              (void);
+
GType               app_indicator_get_type              (void);

-Generates or returns the unique GType for AppIndicator. +Generates or returns the unique GType for AppIndicator.

-

Returns :

 A unique GType for AppIndicator objects. + A unique GType for AppIndicator objects.
@@ -481,8 +473,8 @@ Generates or returns the unique

app_indicator_new ()

-
AppIndicator *      app_indicator_new                   (const gchar *id,
-                                                         const gchar *icon_name,
+
AppIndicator *      app_indicator_new                   (const gchar *id,
+                                                         const gchar *icon_name,
                                                          AppIndicatorCategory category);

 

 Creates a new AppIndicator setting the properties:
@@ -519,10 +511,10 @@ Creates a new 
 
app_indicator_new_with_path ()

-
AppIndicator *      app_indicator_new_with_path         (const gchar *id,
-                                                         const gchar *icon_name,
+
AppIndicator *      app_indicator_new_with_path         (const gchar *id,
+                                                         const gchar *icon_name,
                                                          AppIndicatorCategory category,
-                                                         const gchar *icon_path);

+                                                         const gchar *icon_path);

 

 Creates a new AppIndicator setting the properties:
 		"id" with id, "category"
@@ -588,7 +580,7 @@ Wrapper function for property "status".
 

 
app_indicator_set_attention_icon ()

 
void                app_indicator_set_attention_icon    (AppIndicator *self,
-                                                         const gchar *icon_name);

+                                                         const gchar *icon_name);

Wrapper function for property "attention-icon".

@@ -612,7 +604,7 @@ Wrapper function for property "attention-icon".

app_indicator_set_menu ()

void                app_indicator_set_menu              (AppIndicator *self,
-                                                         GtkMenu *menu);
+ GtkMenu *menu);

Sets the menu that should be shown when the Application Indicator is clicked on in the panel. An application indicator will not @@ -628,7 +620,7 @@ Sets the menu that should be shown when the Application Indicator

menu :

-A GtkMenu to set +A GtkMenu to set @@ -638,7 +630,7 @@ Sets the menu that should be shown when the Application Indicator

app_indicator_set_icon ()

void                app_indicator_set_icon              (AppIndicator *self,
-                                                         const gchar *icon_name);
+ const gchar *icon_name);

Sets the default icon to use when the status is active but not set to attention. In most cases, this should be the @@ -663,7 +655,7 @@ Sets the default icon to use when the status is active but

app_indicator_get_id ()

-
const gchar *       app_indicator_get_id                (AppIndicator *self);
+
const gchar *       app_indicator_get_id                (AppIndicator *self);

Wrapper function for property "id".

@@ -732,7 +724,7 @@ Wrapper function for property "status".

app_indicator_get_icon ()

-
const gchar *       app_indicator_get_icon              (AppIndicator *self);
+
const gchar *       app_indicator_get_icon              (AppIndicator *self);

Wrapper function for property "icon-name".

@@ -755,7 +747,7 @@ Wrapper function for property "icon-name".

app_indicator_get_attention_icon ()

-
const gchar *       app_indicator_get_attention_icon    (AppIndicator *self);
+
const gchar *       app_indicator_get_attention_icon    (AppIndicator *self);

Wrapper function for property "attention-icon-name".

@@ -778,7 +770,7 @@ Wrapper function for property "attention-icon-name".

app_indicator_get_menu ()

-
GtkMenu *           app_indicator_get_menu              (AppIndicator *self);
+
GtkMenu *           app_indicator_get_menu              (AppIndicator *self);

Gets the menu being used for this application indicator.

@@ -792,7 +784,7 @@ Gets the menu being used for this application indicator.

Returns :

- A menu object or NULL if one hasn't been set. + A menu object or NULL if one hasn't been set. @@ -803,42 +795,42 @@ Gets the menu being used for this application indicator.

Property Details

The "attention-icon-name" property

-
  "attention-icon-name"      gchar*                : Read / Write
+
  "attention-icon-name"      gchar*                : Read / Write

If the indicator sets it's status to 'attention' then this icon is shown.

Default value: NULL

The "category" property

-
  "category"                 gchar*                : Read / Write / Construct Only
+
  "category"                 gchar*                : Read / Write / Construct Only

The type of indicator that this represents. Please don't use 'other'. Defaults to 'Application Status'.

Default value: NULL

The "connected" property

-
  "connected"                gboolean              : Read
+
  "connected"                gboolean              : Read

Pretty simple, true if we have a reasonable expectation of being displayed through this object. You should hide your TrayIcon if so.

Default value: FALSE

The "icon-name" property

-
  "icon-name"                gchar*                : Read / Write
+
  "icon-name"                gchar*                : Read / Write

The default icon that is shown for the indicator.

Default value: NULL

The "icon-theme-path" property

-
  "icon-theme-path"          gchar*                : Read / Write / Construct Only
+
  "icon-theme-path"          gchar*                : Read / Write / Construct Only

An additional place to look for icon names that may be installed by the application.

Default value: NULL

The "id" property

-
  "id"                       gchar*                : Read / Write / Construct Only
+
  "id"                       gchar*                : Read / Write / Construct Only

An ID that should be unique, but used consistently by this program and it's indicator.

Default value: NULL

@@ -851,7 +843,7 @@ Gets the menu being used for this application indicator.

The "status" property

-
  "status"                   gchar*                : Read / Write
+
  "status"                   gchar*                : Read / Write

Whether the indicator is shown or requests attention. Defaults to 'off'.

Default value: NULL

@@ -861,8 +853,8 @@ Gets the menu being used for this application indicator.

The "connection-changed" signal

void                user_function                      (AppIndicator *arg0,
-                                                        gboolean      arg1,
-                                                        gpointer      user_data)      : Run Last
+ gboolean arg1, + gpointer user_data) : Run Last

Signaled when we connect to a watcher, or when it drops away. @@ -891,7 +883,7 @@ Signaled when we connect to a watcher, or when it drops

The "new-attention-icon" signal

void                user_function                      (AppIndicator *arg0,
-                                                        gpointer      user_data)      : Run Last
+ gpointer user_data) : Run Last

Signaled when there is a new attention icon set for the object. @@ -915,7 +907,7 @@ Signaled when there is a new attention icon set for the

The "new-icon" signal

void                user_function                      (AppIndicator *arg0,
-                                                        gpointer      user_data)      : Run Last
+ gpointer user_data) : Run Last

Signaled when there is a new icon set for the object. @@ -939,8 +931,8 @@ Signaled when there is a new icon set for the

The "new-status" signal

void                user_function                      (AppIndicator *arg0,
-                                                        gchar        *arg1,
-                                                        gpointer      user_data)      : Run Last
+ gchar *arg1, + gpointer user_data) : Run Last

Signaled when the status of the indicator changes.

-- cgit v1.2.3