Indicator

---

Object Hierarchy:

Description:

Content:

Properties:

• public string actions { get; set; }
  The action group that is associated with the menu items.
• public string attention_icon_desc { owned get; set; }
  If the indicator sets its status to app_indicator_status_attention then this is the textual description of the icon shown.
• public string attention_icon_name { owned get; set; }
  If the indicator sets its status to app_indicator_status_attention then this icon is shown.
• public string category { get; construct; }
  The type of indicator that this represents.
• public bool connected { get; }
  Whether we're conneced to a watcher.
• public string icon_desc { owned get; set; }
  The description of the regular icon that is shown for the indicator.
• public string icon_name { owned get; set; }
  The name of the regular icon that is shown for the indicator.
• public string icon_theme_path { get; set construct; }
  An additional place to look for icon names that may be installed by the application.
• public string id { get; construct; }
  The ID for this indicator, which should be unique, but used consistently by this program and its indicator.
• public string label { owned get; set; }
  A label that can be shown next to the string in the application indicator.
• public string label_guide { owned get; set; }
  An optional string to provide guidance to the panel on how big the label string could get.
• public string menu { get; set; }
  The menu that should be shown when the Application Indicator is clicked on in the panel.
• public uint ordering_index { get; set; }
  The ordering index is an odd parameter, and if you think you don't need it you're probably right.
• public string status { get; set; }
  Whether the indicator is shown or requests attention.
• public string title { get; set; }
  Provides a way to refer to this application indicator in a human readable form.
• public string tooltip_description { owned get; set; }
  The text of the indicator's tooltip.
• public string tooltip_icon_name { owned get; set; }
  The name of the tooltip's themed icon.
• public string tooltip_title { owned get; set; }
  The title of the indicator's tooltip.

Creation methods:

• public Indicator (string id, string icon_name, IndicatorCategory category)
  Creates a new Indicator setting the properties: id with id, category with category and icon_name with icon_name.
• public Indicator.with_path (string id, string icon_name, IndicatorCategory category, string icon_theme_path)
  Creates a new Indicator setting the properties: id with id, category with category, icon_name with icon_name and icon_theme_path with icon_theme_path.

Methods:

• public virtual void activate_event (int x, int y)
• public unowned SimpleActionGroup get_actions ()
  Gets the action group associated with the menu items.
• public unowned string get_attention_icon ()
  Wrapper function for property attention_icon_name.
• public unowned string get_attention_icon_desc ()
  Wrapper function for property attention_icon_desc.
• public IndicatorCategory get_category ()
  Wrapper function for property category.
• public unowned string get_icon ()
  Wrapper function for property icon_name.
• public unowned string get_icon_desc ()
  Wrapper function for property icon_desc.
• public unowned string get_icon_theme_path ()
  Wrapper function for property icon_theme_path.
• public unowned string get_id ()
  Wrapper function for property id.
• public unowned string get_label ()
  Wrapper function for property label.
• public unowned string get_label_guide ()
  Wrapper function for property label_guide.
• public unowned Menu get_menu ()
  Gets the menu being used for this application indicator.
• public uint32 get_ordering_index ()
  Wrapper function for property ordering_index.
• public unowned string get_secondary_activate_target ()
  Gets the action being activated on secondary-activate event.
• public IndicatorStatus get_status ()
  Wrapper function for property status.
• public unowned string get_title ()
  Gets the title of the application indicator.
• public void set_actions (SimpleActionGroup actions)
  Sets the action group that will be associated with the menu items.
• public void set_attention_icon (string icon_name, string? icon_desc)
  Wrapper function for property attention_icon_name
• public void set_icon (string icon_name, string? icon_desc)
  Sets the default icon to use when the status is active but not set to attention.
• public void set_icon_theme_path (string icon_theme_path)
  Sets the path to use when searching for icons.
• public void set_label (string label, string guide)
  This is a wrapper function for the label and label_guide properties.
• public void set_menu (Menu? menu)
  Sets the menu that should be shown when the Application Indicator is activated in the panel.
• public void set_ordering_index (uint32 ordering_index)
  Sets the ordering index for the app indicator which affects its placement on the panel.
• public void set_secondary_activate_target (string? action)
  Set the action to be activated when a secondary activation event (i.
• public void set_status (IndicatorStatus status)
  Wrapper function for property status
• public void set_title (string? title)
  Sets the title of the application indicator, or how it should be referred to in a human readable form.
• public void set_tooltip (string? icon_name, string title, string? description)
  If icon_name is null, the tooltip will not have an icon.

Signals:

• public signal void activate (int arg1, int arg2)
  Signaled when the Indicator receives a primary activation event (e.
• public virtual signal void connection_changed (bool connected)
  Emitted when we connect to a watcher, or when it drops away.
• public virtual signal void new_attention_icon ()
  Emitted when attention_icon_name has changed.
• public virtual signal void new_icon ()
  Emitted when icon_name has changed.
• public virtual signal void new_icon_theme_path (string icon_theme_path)
  Emittod when there is a new icon set for the object.
• public virtual signal void new_label (string label, string guide)
  Emitted when either label or label_guide have changed.
• public virtual signal void new_status (string status)
  Emitted when status has changed.
• public virtual signal void new_tooltip ()
  Emitted when tooltip_icon_name, tooltip_title or tooltip_description have changed.
• public virtual signal void scroll_event (int delta, uint direction)
  Signaled when the Indicator receives a scroll event.

Inherited Members: