diff options
Diffstat (limited to 'docs/reference/tmpl/app-indicator.sgml')
| -rw-r--r-- | docs/reference/tmpl/app-indicator.sgml | 466 |
1 files changed, 466 insertions, 0 deletions
diff --git a/docs/reference/tmpl/app-indicator.sgml b/docs/reference/tmpl/app-indicator.sgml new file mode 100644 index 0000000..3f803db --- /dev/null +++ b/docs/reference/tmpl/app-indicator.sgml @@ -0,0 +1,466 @@ +<!-- ##### SECTION Title ##### --> +AppIndicator + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO APP_INDICATOR_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO APP_INDICATOR_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO IS_APP_INDICATOR ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO IS_APP_INDICATOR_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO APP_INDICATOR_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ICON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_LABEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_CONNECTION_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### ENUM AppIndicatorCategory ##### --> +<para> + +</para> + +@APP_INDICATOR_CATEGORY_APPLICATION_STATUS: +@APP_INDICATOR_CATEGORY_COMMUNICATIONS: +@APP_INDICATOR_CATEGORY_SYSTEM_SERVICES: +@APP_INDICATOR_CATEGORY_HARDWARE: +@APP_INDICATOR_CATEGORY_OTHER: + +<!-- ##### ENUM AppIndicatorStatus ##### --> +<para> + +</para> + +@APP_INDICATOR_STATUS_PASSIVE: +@APP_INDICATOR_STATUS_ACTIVE: +@APP_INDICATOR_STATUS_ATTENTION: + +<!-- ##### STRUCT AppIndicatorPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AppIndicator ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL AppIndicator::connection-changed ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL AppIndicator::new-attention-icon ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. + +<!-- ##### SIGNAL AppIndicator::new-icon ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. + +<!-- ##### SIGNAL AppIndicator::new-icon-theme-path ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL AppIndicator::new-label ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL AppIndicator::new-status ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### ARG AppIndicator:attention-icon-name ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:category ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:connected ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:dbus-menu-server ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:icon-name ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:icon-theme-path ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:id ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:label ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:label-guide ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:ordering-index ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:status ##### --> +<para> + +</para> + +<!-- ##### STRUCT AppIndicatorClass ##### --> +<para> + +</para> + +@parent_class: +@new_icon: +@new_attention_icon: +@new_status: +@new_icon_theme_path: +@new_label: +@connection_changed: +@app_indicator_reserved_sw: +@app_indicator_reserved_ats: +@fallback: +@unfallback: +@app_indicator_reserved_1: +@app_indicator_reserved_2: +@app_indicator_reserved_3: +@app_indicator_reserved_4: +@app_indicator_reserved_5: +@app_indicator_reserved_6: + +<!-- ##### FUNCTION app_indicator_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION app_indicator_new ##### --> +<para> + +</para> + +@id: +@icon_name: +@category: +@Returns: + + +<!-- ##### FUNCTION app_indicator_new_with_path ##### --> +<para> + +</para> + +@id: +@icon_name: +@category: +@icon_theme_path: +@Returns: + + +<!-- ##### FUNCTION app_indicator_set_status ##### --> +<para> + +</para> + +@self: +@status: + + +<!-- ##### FUNCTION app_indicator_set_attention_icon ##### --> +<para> + +</para> + +@self: +@icon_name: + + +<!-- ##### FUNCTION app_indicator_set_menu ##### --> +<para> + +</para> + +@self: +@menu: + + +<!-- ##### FUNCTION app_indicator_set_icon ##### --> +<para> + +</para> + +@self: +@icon_name: + + +<!-- ##### FUNCTION app_indicator_set_icon_theme_path ##### --> +<para> + +</para> + +@self: +@icon_theme_path: + + +<!-- ##### FUNCTION app_indicator_set_label ##### --> +<para> + +</para> + +@self: +@label: +@guide: + + +<!-- ##### FUNCTION app_indicator_set_ordering_index ##### --> +<para> + +</para> + +@self: +@ordering_index: + + +<!-- ##### FUNCTION app_indicator_get_id ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_category ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_status ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_icon ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_icon_theme_path ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_attention_icon ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_menu ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_label ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_label_guide ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_ordering_index ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_build_menu_from_desktop ##### --> +<para> + +</para> + +@self: +@desktop_file: +@desktop_profile: + + |