AppIndicator3-0.1 Python API Documentation

Class: AppIndicator3.Indicator

Subclass of: GObject.Object

A application 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. Private fields

Properties

string"category"construct-only

The type of indicator that this represents. Please don't use 'Other'. Defaults to 'ApplicationStatus'.

int"ordering-index"read/write

The ordering index is an odd parameter, and if you think you don't need it you're probably right. In general, the application indicator try to place the applications in a recreatable place taking into account which category they're in to try and group them. But, there are some cases where you'd want to ensure indicators are next to each other. To do that you can override the generated ordering index and replace it with a new one. Again, you probably don't want to be doing this, but in case you do, this is the way.

string"label-guide"read/write

An optional string to provide guidance to the panel on how big the #AppIndicator:label string could get. If this is set correctly then the panel should never 'jiggle' as the string adjusts through out the range of options. For instance, if you were providing a percentage like "54% thrust" in #AppIndicator:label you'd want to set this string to "100% thrust" to ensure space when Scotty can get you enough power.

string"title"read/write

Provides a way to refer to this application indicator in a human readable form. This is used in the Unity desktop in the HUD as the first part of the menu entries to distinguish them from the focused application's entries.

string"attention-icon-desc"read/write

If the indicator sets it's status to %APP_INDICATOR_STATUS_ATTENTION then this textual description of the icon shown.

string"icon-name"read/write

The name of the regular icon that is shown for the indicator.

string"icon-desc"read/write

The description of the regular icon that is shown for the indicator.

string"label"read/write

A label that can be shown next to the string in the application indicator. The label will not be shown unless there is an icon as well. The label is useful for numerical and other frequently updated information. In general, it shouldn't be shown unless a user requests it as it can take up a significant amount of space on the user's panel. This may not be shown in all visualizations.

string"status"read/write

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

bool"connected"read-only

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

string"icon-theme-path"construct-only

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

unknown_{http://www.gtk.org/introspection/core/1.0}type"dbus-menu-server"read/write

A way to get the internal dbusmenu server if it is available. This should only be used for testing.

string"attention-icon-name"read/write

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

string"id"construct-only

The ID for this indicator, which should be unique, but used consistently by this program and its indicator.

Signals

void"new-status"(self, indicator, arg1)

Emitted when #AppIndicator:status is changed

void"new-icon-theme-path"(self, indicator, object)

Signaled when there is a new icon set for the object.

void"scroll-event"(self, indicator, arg1, arg2)

Signaled when the #AppIndicator receives a scroll event.

void"connection-changed"(self, indicator, arg1)

Signaled when we connect to a watcher, or when it drops away.

void"new-label"(self, indicator, object, p0)

Emitted when either #AppIndicator:label or #AppIndicator:label-guide are changed.

void"new-icon"(self, indicator)

when #AppIndicator:icon-name is changed

void"new-attention-icon"(self, indicator)

Emitted when #AppIndicator:attention-icon-name is changed

Constructors

 new(id, icon_name, category)

 new_with_path(id, icon_name, category, icon_theme_path)

Methods

voidbuild_menu_from_desktop(desktop_file, desktop_profile)

voidconnection_changed(connected, user_data)

stringget_attention_icon()

stringget_attention_icon_desc()

stringget_icon()

stringget_icon_desc()

stringget_icon_theme_path()

stringget_id()

stringget_label()

stringget_label_guide()

Gtk.Menuget_menu()

intget_ordering_index()

Gtk.Widgetget_secondary_activate_target()

stringget_title()

voidnew_attention_icon(user_data)

voidnew_icon(user_data)

voidnew_icon_theme_path(icon_theme_path, user_data)

voidnew_label(label, guide, user_data)

voidnew_status(status, user_data)

voidscroll_event(delta, direction, user_data)

voidset_attention_icon(icon_name)

voidset_attention_icon_full(icon_name, icon_desc)

voidset_icon(icon_name)

voidset_icon_full(icon_name, icon_desc)

voidset_icon_theme_path(icon_theme_path)

voidset_label(label, guide)

voidset_menu(menu)

voidset_ordering_index(ordering_index)

voidset_secondary_activate_target(menuitem)

voidset_status(status)

voidset_title(title)

voidunfallback(status_icon)

Enum: AppIndicator3.IndicatorStatus

PASSIVE0ACTIVE1ATTENTION2

Enum: AppIndicator3.IndicatorCategory

APPLICATION_STATUS0COMMUNICATIONS1SYSTEM_SERVICES2HARDWARE3OTHER4