Class
AyatanaAppIndicatorGlibIndicator
Description
class AyatanaAppIndicatorGlib.Indicator : GObject.Object
{
/* No available fields */
}
An 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 creating a new indicator.
Constructors
app_indicator_new
Creates a new AppIndicator
setting the properties:
AppIndicator:id
with id
, AppIndicator:category
with category
and AppIndicator:icon-name
with icon_name
.
app_indicator_new_with_path
Creates a new AppIndicator
setting the properties:
AppIndicator:id
with id
, AppIndicator:category
with category
,
AppIndicator:icon-name
with icon_name
and AppIndicator:icon-theme-path
with icon_theme_path
.
Instance methods
app_indicator_get_attention_icon_desc
Wrapper function for property AppIndicator:attention-icon-desc
.
app_indicator_get_secondary_activate_target
Gets the action being activated on secondary-activate event.
app_indicator_get_title
Gets the title of the application indicator. See the function app_indicator_set_title () for information on the title.
app_indicator_set_actions
Sets the action group that will be associated with the menu items. An application indicator will not be rendered unless it has actions.
app_indicator_set_icon
Sets the default icon to use when the status is active but not set to attention. In most cases, this should be the application icon for the program.
app_indicator_set_label
This is a wrapper function for the AppIndicator:label
and
AppIndicator:label-guide
properties. This function can take NULL
as either label
or guide
and will clear the entries.
app_indicator_set_menu
Sets the menu that should be shown when the Application Indicator is activated in the panel. An application indicator will not be rendered unless it has a menu.
app_indicator_set_ordering_index
Sets the ordering index for the app indicator which affects its placement on the panel. For almost all app indicators this is not the function you’re looking for.
app_indicator_set_secondary_activate_target
Set the action
to be activated when a secondary activation event
(i.e. a middle-click) is emitted over the AppIndicator
icon/label.
app_indicator_set_title
Sets the title of the application indicator, or how it should be referred to in a human readable form. This string should be UTF-8 and localized, as it is expected that users will set it.
app_indicator_set_tooltip
If icon_name
is NULL
, the tooltip will not have an icon.
If title
is NULL
, the indicator will not have a tooltip.
If description
is NULL
, the tooltip will not have a description.
Properties
AyatanaAppIndicatorGlib.Indicator:attention-icon-desc
If the indicator sets its status to APP_INDICATOR_STATUS_ATTENTION
then this is the textual description of the icon shown.
AyatanaAppIndicatorGlib.Indicator:attention-icon-name
If the indicator sets its status to APP_INDICATOR_STATUS_ATTENTION
then this icon is shown.
AyatanaAppIndicatorGlib.Indicator:category
The type of indicator that this represents. Please don’t use ‘Other’. Defaults to ‘ApplicationStatus’.
AyatanaAppIndicatorGlib.Indicator:connected
Whether we’re conneced to a watcher. TRUE
if we have a
reasonable expectation of being displayed through this object.
AyatanaAppIndicatorGlib.Indicator:icon-desc
The description of the regular icon that is shown for the indicator.
AyatanaAppIndicatorGlib.Indicator:icon-name
The name of the regular icon that is shown for the indicator.
AyatanaAppIndicatorGlib.Indicator:icon-theme-path
An additional place to look for icon names that may be installed by the application.
AyatanaAppIndicatorGlib.Indicator:id
The ID for this indicator, which should be unique, but used consistently by this program and its indicator.
AyatanaAppIndicatorGlib.Indicator:label
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.
AyatanaAppIndicatorGlib.Indicator:label-guide
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 throughout 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.
AyatanaAppIndicatorGlib.Indicator:menu
The menu that should be shown when the Application Indicator is clicked on in the panel.
AyatanaAppIndicatorGlib.Indicator:ordering-index
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 service will try to place the indicators in a recreatable place taking into account which category they’re in to try and group them. But, there are some cases when 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 do this, but in case you do, this is the way.
AyatanaAppIndicatorGlib.Indicator:status
Whether the indicator is shown or requests attention. Can be one of ‘Passive’ (the indicator should not be shown), ‘Active’ (the indicator should be shown in its default state), and ‘Attention’ (the indicator should now show it’s attention icon). Defaults to ‘Passive’.
AyatanaAppIndicatorGlib.Indicator:title
Provides a way to refer to this application indicator in a human readable form.
Signals
AyatanaAppIndicatorGlib.Indicator::connection-changed
Emitted when we connect to a watcher, or when it drops away.
AyatanaAppIndicatorGlib.Indicator::new-attention-icon
Emitted when AppIndicator:attention-icon-name
has changed.
AyatanaAppIndicatorGlib.Indicator::new-icon-theme-path
Emittod when there is a new icon set for the object.
AyatanaAppIndicatorGlib.Indicator::new-label
Emitted when either AppIndicator:label
or
AppIndicator:label-guide
have changed.
AyatanaAppIndicatorGlib.Indicator::new-tooltip
Emitted when AppIndicator:tooltip-icon-name
,
AppIndicator:tooltip-title
or AppIndicator:tooltip-description
have changed.
AyatanaAppIndicatorGlib.Indicator::scroll-event
Signaled when the AppIndicator
receives a scroll event.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct AyatanaAppIndicatorGlibIndicatorClass {
GObjectClass parent_class;
void (* new_icon) (
AppIndicator* indicator,
gpointer user_data
);
void (* new_attention_icon) (
AppIndicator* indicator,
gpointer user_data
);
void (* new_status) (
AppIndicator* indicator,
const gchar* status,
gpointer user_data
);
void (* new_icon_theme_path) (
AppIndicator* indicator,
const gchar* icon_theme_path,
gpointer user_data
);
void (* new_label) (
AppIndicator* indicator,
const gchar* label,
const gchar* guide,
gpointer user_data
);
void (* new_tooltip) (
AppIndicator* indicator,
gpointer user_data
);
void (* connection_changed) (
AppIndicator* indicator,
gboolean connected,
gpointer user_data
);
void (* scroll_event) (
AppIndicator* indicator,
gint delta,
guint direction,
gpointer user_data
);
}
No description available.
Class members
parent_class: GObjectClass
No description available.
new_icon: void (* new_icon) ( AppIndicator* indicator, gpointer user_data )
No description available.
new_attention_icon: void (* new_attention_icon) ( AppIndicator* indicator, gpointer user_data )
No description available.
new_status: void (* new_status) ( AppIndicator* indicator, const gchar* status, gpointer user_data )
No description available.
new_icon_theme_path: void (* new_icon_theme_path) ( AppIndicator* indicator, const gchar* icon_theme_path, gpointer user_data )
No description available.
new_label: void (* new_label) ( AppIndicator* indicator, const gchar* label, const gchar* guide, gpointer user_data )
No description available.
new_tooltip: void (* new_tooltip) ( AppIndicator* indicator, gpointer user_data )
No description available.
connection_changed: void (* connection_changed) ( AppIndicator* indicator, gboolean connected, gpointer user_data )
No description available.
scroll_event: void (* scroll_event) ( AppIndicator* indicator, gint delta, guint direction, gpointer user_data )
No description available.