Cinnamon Javascript Reference Manual: Cinnamon Javascript Reference Manual

This document is for Cinnamon 5.6.8 .

imports.ui.

imports.ui.applet

Applet.MenuItem — Deprecated. Use PopupMenu.PopupIconMenuItem instead.
Applet.AppletContextMenu — Applet right-click menu
Applet.AppletPopupMenu — Applet left-click menu
Applet.Applet — Base applet class
Applet.IconApplet — Applet with icon
Applet.TextApplet — Applet with label
Applet.TextIconApplet — Applet with icon and label

imports.ui.appletManager

AppletManager

imports.ui.boxpointer

Boxpointer

imports.ui.dbusMenu

DbusMenu.PropertyStore — A Class to saves menu property values and handles type checking and defaults.
DbusMenu.DbusMenuItem — Represents a single Dbus menu item.
DbusMenu.DBusClient — The client does the heavy lifting of actually reading layouts and distributing events.

imports.ui.desklet

Desklet.Desklet — Base desklet class to be inherited

imports.ui.deskletManager

DeskletManager
DeskletManager.DeskletContainer

imports.ui.dnd

Dnd

imports.ui.extension

Extension

imports.ui.layout

Layout.LayoutManager — Manager of Cinnamon Chrome

imports.ui.lightbox

Lightbox

imports.ui.magnifierDBus

MagnifierDBus

imports.ui.main

Main — This is the heart of Cinnamon, the mother of everything.

imports.ui.messageTray

MessageTray.Notification — A shell notification.

imports.ui.modalDialog

ModalDialog.ModalDialog — A generic object that displays a modal dialog
ModalDialog.ConfirmDialog — A simple dialog with a "Yes" and "No" button.
ModalDialog.NotifyDialog — A simple dialog that presents a message with an "OK" button.
ModalDialog.InfoOSD — An OSD that displays information to users

imports.ui.panel

Panel — The file responsible for managing panels
Panel.PanelManager — Manager of Cinnamon panels
Panel.PanelDummy — Dummy panels for users to select new position of panel
Panel.Panel — A panel object on the monitor

imports.ui.popupMenu

PopupMenu.PopupIconMenuItem — A menu item with an icon and a text.
PopupMenu.PopupIndicatorMenuItem — A menu item with text, ornaments and accel.
PopupMenu.PopupMenuAbstractItem — A class to represent any abstract menu item.
PopupMenu.PopupMenuBase — The base class of all popup menus
PopupMenu.PopupMenu — An actual popup menu
PopupMenu.PopupSubMenu — A submenu that can show and hide
PopupMenu.PopupMenuSection — A section of a PopupMenu that is transparent to user
PopupMenu.PopupMenuFactory — A class to build a cinnamon menu using some abstract menu items.

imports.ui.runDialog

RunDialog

imports.ui.search

Search

imports.ui.settings

Settings — File providing settings objects for xlets.
Settings.XletSettingsBase — Object for handling xlet settings updates
Settings.AppletSettings — Settings object for applets.
Settings.DeskletSettings — Settings object for desklets.
Settings.ExtensionSettings — Settings object for extensions.

imports.ui.systray

Systray.SystrayManager — Utility class for registering tray icon replacements

imports.ui.tooltips

Tooltips.TooltipBase
Tooltips.Tooltip
Tooltips.PanelItemTooltip

imports.ui.tweener

Tweener — File providing tweening functions
Tweener.ClutterFrameTicker — Object used internally for clutter animations

imports.misc.

imports.misc.docInfo

DocInfo

imports.misc.signalManager

SignalManager.SignalManager — A convenience object for managing signals

imports.misc.state

State

imports.misc.util

Util — File providing certain utility functions