Applet.MenuItem

Synopsis

void _init ( string text,
  string icon,
  Function callback )
MenuItem clone ( )
string _text
string _icon
Function _callback
St.Icon icon

Description

A menu item that contains an icon, a text and responds to clicks

Inherits: PopupMenu.PopupBaseMenuItem

Details


_init ()
void _init ( string text,
  string icon,
  Function callback )

Constructor function

text text to be displayed in the menu item
icon name of icon to be displayed in the menu item
callback callback function to be called when the menu item is clicked


clone ()
MenuItem clone ( )

Clones the menu item

Return a clone of this menu item


_text
string _text

Text to be displayed in the menu item



_icon
string _icon

Name of icon to be displayed in the menu item



_callback
Function _callback

Callback function when the menu item is clicked



icon
St.Icon icon

Icon of the menu item


Applet.AppletContextMenu

Synopsis

void _init ( Applet.Applet launcher,
  St.Side orientation )

Description

A context menu (right-click menu) to be used by an applet

Inherits: PopupMenu.PopupMenu

Details


_init ()
void _init ( Applet.Applet launcher,
  St.Side orientation )

Constructor function

launcher The applet that contains the context menu
orientation The orientation of the applet

Applet.AppletPopupMenu

Synopsis

void _init ( Applet.Applet launcher,
  St.Side orientation )
void setMaxHeight ( )

Description

A popupmenu menu (left-click menu) to be used by an applet

Inherits: PopupMenu.PopupMenu

Details


_init ()
void _init ( Applet.Applet launcher,
  St.Side orientation )

Constructor function

launcher The applet that contains the context menu
orientation The orientation of the applet


setMaxHeight ()
void setMaxHeight ( )

Sets the maximum height of the monitor so that it does not expand pass the monitor when it has too many children


Applet.Applet

Synopsis

void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )
void set_applet_tooltip ( string text )
void on_applet_clicked ( Clutter.Event event )
void on_applet_added_to_panel ( )
void on_applet_removed_from_panel ( )
void setOrientation ( St.Side orientation )
void on_orientation_changed ( St.Side orientation )
void setPanelHeight ( int panelHeight )
void on_panel_height_changed ( )
St.BoxLayout actor
string _uuid
int instance_id
St.BoxLayout _panelLocation
int _order
DND._Draggable _draggable
boolean _scaleMode
Tooltips.PanelItemTooltip _applet_tooltip
PopupMenu.PopupMenuManager _menuManager
AppletContextMenu _applet_context_menu
string _applet_tooltip_text

Description

Base applet class that other applets can inherit

Details


_init ()
void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )

orientation orientation of the applet; Orientation of panel containing the actor
panelHeight height of the panel containing the applet
instance_id instance id of the applet


set_applet_tooltip ()
void set_applet_tooltip ( string text )

Sets the tooltip of the applet

text the tooltip text to be set


on_applet_clicked ()
void on_applet_clicked ( Clutter.Event event )

This function is called when the applet is clicked.

This is meant to be overriden in individual applets.

event the event object


on_applet_added_to_panel ()
void on_applet_added_to_panel ( )

This function is called by appletManager when the applet is added to the panel.

This is meant to be overridden in individual applets.



on_applet_removed_from_panel ()
void on_applet_removed_from_panel ( )

This function is called by appletManager when the applet is removed from the panel.

This is meant to be overridden in individual applets.



setOrientation ()
void setOrientation ( St.Side orientation )

Sets the orientation of the applet.

This function should only be called by appletManager

orientation the orientation


on_orientation_changed ()
void on_orientation_changed ( St.Side orientation )

This function is called when the applet is changes orientation.

This is meant to be overridden in individual applets.

orientation new orientation of the applet


setPanelHeight ()
void setPanelHeight ( int panelHeight )

Sets the panel height property of the applet.

panelHeight panelHeight


on_panel_height_changed ()
void on_panel_height_changed ( )

This function is called when the panel containing the applet changes height

This is meant to be overridden in individual applets.



actor
St.BoxLayout actor

Actor of the applet



_uuid
string _uuid

UUID of the applet



instance_id
int instance_id

Instance id of the applet



_panelLocation
St.BoxLayout _panelLocation

Panel sector containing the applet



_order
int _order

The order of the applet within a panel location



_draggable
DND._Draggable _draggable

The draggable object of the applet



_scaleMode
boolean _scaleMode

Whether the applet scales according to the panel size



_applet_tooltip
Tooltips.PanelItemTooltip _applet_tooltip

The tooltip of the applet



_menuManager
PopupMenu.PopupMenuManager _menuManager

The menu manager of the applet



_applet_context_menu
AppletContextMenu _applet_context_menu

The context menu of the applet



_applet_tooltip_text
string _applet_tooltip_text

Text of the tooltip


Applet.IconApplet

Synopsis

void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )
void set_applet_icon_name ( string icon_name )
void set_applet_icon_symbolic_name ( string icon_name )
void set_applet_icon_symbolic_path ( string icon_path )
St.Icon _applet_icon
St.IconType __icon_type
string __icon_name

Description

Applet that contains an icon

Inherits: Applet.Applet

Details


_init ()
void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )

orientation orientation of the applet; Orientation of panel containing the actor
panelHeight height of the panel containing the applet
instance_id instance id of the applet


set_applet_icon_name ()
void set_applet_icon_name ( string icon_name )

Sets the icon of the applet to @icon_name.

The icon will be full color

icon_name Name of the icon


set_applet_icon_symbolic_name ()
void set_applet_icon_symbolic_name ( string icon_name )

Sets the icon of the applet to @icon_name.

The icon will be symbolic

icon_name Name of the icon


set_applet_icon_symbolic_path ()
void set_applet_icon_symbolic_path ( string icon_path )

Sets the icon of the applet to the image file at @icon_path

The icon will be symbolic

icon_path path of the icon


_applet_icon
St.Icon _applet_icon

Actor of the icon



__icon_type
St.IconType __icon_type

Type of the icon (FULLCOLOR/SYMBOLIC)



__icon_name
string __icon_name

Name of icon


Applet.TextApplet

Synopsis

void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )
void set_applet_label ( string text )
St.Label _applet_label

Description

Applet that displays a text

Inherits: Applet.Applet

Details


_init ()
void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )

orientation orientation of the applet; Orientation of panel containing the actor
panelHeight height of the panel containing the applet
instance_id instance id of the applet


set_applet_label ()
void set_applet_label ( string text )

Sets the text of the actor to @text

text text to be displayed at the label


_applet_label
St.Label _applet_label

Label of the applet


Applet.TextIconApplet

Synopsis

void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )
void set_applet_label ( string text )
void hide_applet_icon ( )
St.Label _applet_label

Description

Applet that displays an icon and a text. The icon is on the left of the text

Inherits: Applet.IconApplet

Details


_init ()
void _init ( St.Side orientation,
  int panelHeight,
  int instance_id )

orientation orientation of the applet; Orientation of panel containing the actor
panelHeight height of the panel containing the applet
instance_id instance id of the applet


set_applet_label ()
void set_applet_label ( string text )

Sets the text of the actor to @text

text text to be displayed at the label


hide_applet_icon ()
void hide_applet_icon ( )

Hides the icon of the applet



_applet_label
St.Label _applet_label

Label of the applet