Indicate-0.7 Python API Documentation

Class: Indicate.Indicator

Subclass of: GObject.Object

The indicator object represents a single item that is shared over the indicator bus. This could be something like one IM, one e-mail or a single system update. It should be accessed only through its accessors.

Signals

void"hide"(self, indicator)

Emitted every time this indicator is hidden. This is mostly used by #IndicateServer. Typically this results in an emition of #IndicateServer::indicator-removed.

void"displayed"(self, indicator, arg1)

This is the signal that the indicator has been displayed, or hidden by a listener. In most cases, the signal will be that it has been displayed as most folks don't go hiding it later.

void"modified"(self, indicator, arg1)

Emitted every time an indicator property is changed. This is mostly used by #IndicateServer. Typically this results in an emition of #IndicateServer::indicator-modified.

void"user-display"(self, indicator, object)

void"show"(self, indicator)

Emitted every time this indicator is shown. This is mostly used by #IndicateServer. Typically this results in an emition of #IndicateServer::indicator-added.

Constructors

 new()

 new_with_server(server)

Methods

voiddisplayed(displayed)

boolget_displayed()

intget_id()

GLib.Variantget_property(key)

GLib.Variantget_property_variant(key)

Indicate.Serverget_server()

voidhide(data)

boolis_visible()

Array<utf8>list_properties()

voidmodified(property, data)

voidset_displayed(displayed)

voidset_property(key, data)

voidset_property_bool(key, value)

voidset_property_int(key, value)

voidset_property_time(key, time)

voidset_property_variant(key, value)

voidset_server(server)

voidshow(data)

voiduser_display(timestamp, data)

Class: Indicate.Listener

Subclass of: GObject.Object

Signals

void"indicator-servers-report"(self, listener)

void"server-removed"(self, listener, object, p0)

void"server-added"(self, listener, object, p0)

void"indicator-removed"(self, listener, object, p0)

void"indicator-modified"(self, listener, object, p0, p1)

void"indicator-added"(self, listener, object, p0)

void"server-count-changed"(self, listener, object, p0)

Constructors

 new()

Methods

voiddisplay(server, indicator, timestamp)

voiddisplayed(server, indicator, displayed)

voidget_property(server, indicator, property, callback, data)

voidget_property_bool(server, indicator, property, callback, data)

voidget_property_int(server, indicator, property, callback, data)

voidget_property_time(server, indicator, property, callback, data)

voidget_property_variant(server, indicator, property, callback, data)

Indicate.Listenerref_default()(static method)

boolserver_check_interest(server, interest)

voidserver_get_count(server, callback, data)

voidserver_get_desktop(server, callback, data)

voidserver_get_icon_theme(server, callback, data)

GLib.Listserver_get_indicators(server)

voidserver_get_menu(server, callback, data)

voidserver_get_type(server, callback, data)

voidserver_remove_interest(server, interest)

voidserver_show_interest(server, interest)

voidset_default_max_indicators(max)

voidset_server_max_indicators(server, max)

Class: Indicate.Server

Subclass of: GObject.Object

This is the object that represents the overall connection between this application and DBus. It acts as the proxy for incomming DBus calls and also sends the appropriate signals on DBus for events happening on other objects locally. It provides some settings that effection how the application as a whole is perceived by listeners of the indicator protocol.

Properties

int"count"read/write

string"icon-theme"read/write

string"menu"read-only

string"desktop"read/write

string"path"construct-only

string"type"read/write

Signals

void"indicator-delete"(self, server, object)

void"server-show"(self, server, arg1)

Emitted when a server comes onto DBus by being shown. This is typically when listeners start reacting to the application's indicators. This results in a signal on DBus.

void"indicator-new"(self, server, object)

void"server-hide"(self, server, arg1)

Emitted when a server removes itself from DBus. This results in a signal on DBus.

void"indicator-modified"(self, server, arg1, arg2)

Emitted every time that a property on an indicator changes and it is visible to the world. This results in a signal on DBus.

void"max-indicators-changed"(self, server, arg1)

Emitted when a listener either specifies their max number to be higher, or at all. The default is -1 or infinite.

void"server-display"(self, server, arg1)

Emitted when a listener signals that the server itself should be displayed. This signal is caused by a user clicking on the application item in the Messaging Menu. This signal is emitted by DBus.

void"interest-removed"(self, server, arg1)

Emitted when a listener signals that they are no longer interested in this server for a particular reason. This signal is emitted by DBus. @note This signal is also emitted after a timeout when the object is created with @arg1 set to #INDICATOR_INTREST_NONE if no one has shown any interest in the server.

void"interest-added"(self, server, arg1)

Emitted when a listener signals that they are interested in this server for a particular reason. This signal is emitted by DBus.

void"server-count-changed"(self, server, arg1)

Emitted when the count property of the server changes to a new value.

Methods

voidadd_indicator(indicator)

boolcheck_interest(interest)

boolget_indicator_count(count)

boolget_indicator_property(id, property, value)

intget_max_indicators()

intget_next_id()

stringget_path()

voidhide()

voidindicator_added(id)

boolindicator_displayed(sender, id, displayed)

voidindicator_modified(id, property)

voidindicator_removed(id)

voidinterest_added(interest)

voidinterest_removed(interest)

voidmax_indicators_changed(max)

intmax_indicators_get()

boolmax_indicators_set(sender, max)

Indicate.Serverref_default()(static method)

voidremove_indicator(indicator)

boolremove_interest(sender, interest)

voidserver_count_changed(count)

voidserver_display(timestamp)

voidserver_hide(type)

voidserver_show(type)

voidset_count(count)

voidset_dbus_object(obj)(static method)

voidset_default()

voidset_desktop_file(path)

voidset_icon_theme(name)

voidset_menu(menu)

voidset_type(type)

voidshow()

boolshow_indicator_to_user(id, timestamp)

boolshow_interest(sender, interest)

Enum: Indicate.Interests

NONE0SERVER_DISPLAY1SERVER_SIGNAL2INDICATOR_DISPLAY3INDICATOR_SIGNAL4INDICATOR_COUNT5LAST6