A simple switch that controls a boolean type value.

New in Cinnamon 3.2

Provides a spin button and entry that control a number value. This can be integer or floating point format. For floating point, all values must have leading 0's.

Provides a scale widget that allows you to pick a number value between min and max, by step amount. Integer or floating point numbers can be used. For floating point, all values must have leading 0's.

A single-line text entry field that stores a string.

A multi-line text entry field that stores a string.

New in Cinnamon 2.0

Opens a file chooser dialog that allows you to choose a filename. If select-dir is true, it will only allow directories to be selected. Stores as a string.

Provides a preview button and text entry field. You can open a file dialog to pick an image-type file, or enter a registered icon name in the text field. Stores as a string.

Provides a button which shows the currently selected file name and opens a file dialog when clicked. A preview button is also provided to allow the user to test the selected sound. Stores as a string.

New in Cinnamon 3.2

Provides a dropdown list from which you can select from description:value pairs defined by options. The values can be string, number, or boolean.

A Color button that lets you choose a color. Stores an RGBA color code as a string

A button that opens a dialog that lets you select a font. Stores a font string as a string

New in Cinnamon 3.2

A button that opens a dialog that lets you select a date. The date is stored as three key/value pairs representing the numerical value for the day('d'), month('m'), and year('y').

New in Cinnamon 3.2

A button that opens a dialog that lets you select a time. The time is stored as three key/value pairs representing the numerical value for the hour('h'), minute('m'), and second('s').

New in Cinnamon 4.2

Provides a dropdown list from which you can select a tween type. A tween value is a string of the form ease<direction><shape> where direction can be In, Out, InOut, or OutIn and shape can be Quad, Cubic, Quart, Quint, Sine, Expo, Circ, Elastic, Back, or Bounce. For example, to specify a direction of In and a shape of Quad, the resultant string would be easeInQuad. To specify no tween, use the special tween value easeNone.

New in Cinnamon 2.6

Provides a dropdown list from which you can select an effect type. An effect type specifies what an animation looks like. Stores as a string.

New in Cinnamon 3.2

A non-setting widget, this specifies a new section for assisting in organizing your settings.

New in Cinnamon 3.2

A non-setting widget, this allows you to specify a particular layout for your settings rather than relying on the order they appear in your settings-schema.json file. This has the added advantage of using settings pages to further organize your settings into tabs. This is only recommended when you have a large number of settings that wont all fit without scrolling. To use the layout object, you must place it at the beginning of the settings-schema.json file as the first "setting". Any section items not placed within the layout object will be ignored.

To use the layout object, you must define any number of page and section types as key/value pairs in the layout item. Each page will include a sections key which is an array of section items. Each section item in turn will contain a property called keys which is an array of key. In addition, the layout object also must include the pages key which is an array that contains a list of the pages in your layout. The each item in pages and sections must correspond to a page or section key in the layout property and each item in keys must correspond to one of the settings keys in your settings-schema.json file. The pages, sections and keys will be displayed in the order in which their key names appear in their respective arrays and do not depend on their order in the layout object or your settings file.

Here is an example of what a layout object might look like:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

"layout" : {
  "pages" : ["page1", "page2"],
  "page1" : {
    "type" : "page",
    "title" : "1st page",
    "sections" : ["section1", "section2"]
  },
  "page2" : {
    "type" : "page",
    "title" : "2nd page",
    "sections" : ["section3", "section4"]
  },
  "section1" : {
    "type" : "section",
    "title" : "1st section",
    "keys" : ["setting1", "setting2"]
  },
  "section2" : {
    "type" : "section",
    "title" : "2nd section",
    "keys" : ["setting3", "setting4"]
  },
  "section3" : {
    "type" : "section",
    "title" : "3rd section",
    "keys" : ["setting5", "setting6"]
  },
  "section4" : {
    "type" : "section",
    "title" : "4th section",
    "keys" : ["setting7", "setting8"]
  }
}

New in Cinnamon 3.2

An input that allows you to select a keybinding for an action.

A generic storage object for any type of value. This is generally intended for internal settings that won't be adjusted by the user. For example, a history, or most recent command. There is no corresponding widget for it in Cinnamon Settings.

A non-setting widget, this provides a label for making a note or describing something. Unlike a header which is bold-faced to stand out, a label is formatted just like the description of most of the other setting types.

New in Cinnamon 2.6

A non-setting widget, this provides a button, which, when clicked, activates the callback method in your applet, desklet, or extension. The callback value should be a string of the method name only. For instance, to call this.myCallback(), you would put myCallback for the callback value.

Note: for an applet or desklet, the callback function must be a method of the applet or desklet object. For an extension, it can be a method of any object, but that object must be returned from the enabled() function of your extension in order for it to work.

This widget provides a list with columns, and rows which can be created, edited, deleted and reordered. The columns in the list are specified by the columns property. All columns have the following properties:

The column type determines the type of data that will be stored. When the user presses the add or edit button, a dialog is generated with a widget for each column definition. Starting in Cinnamon 3.8, if the options property is given, the widget will be a combo box. Otherwise the widget will be determined by the data type of the column as listed below. These widgets act just like the corresponding widgets in this document, and all the same properties can be included in the column definition, with the exception of description and type. The following types are currently available:

The values are stored as an array of objects where each object in the array corresponds to a row in the list, and each entry in the row object is a key:value pair where the key being the column id of the column to which the value corresponds.

For an example of how to use this widget, see the settings example applet that is included with Cinnamon. The source code for it can be found in /usr/share/cinnamon/applets/settings-example@cinnamon.org

Note: For appearance, it is recommended that you do not use the description property of this setting, but rather place it in it's own section.

New in Cinnamon 3.4

Formerly generating a checkbox widget, this widget type now functions exactly like the switch settings type.

Deprecated since Cinnamon 3.2

Formerly generating a series of radio buttons this widget now functions exactly like the combobox settings type.

Deprecated since Cinnamon 3.2

A non-setting widget, it formerly generated a bold-faced label for assisting in organizing your settings. It now functions exactly like the section type.

Deprecated since Cinnamon 3.2

A non-setting widget, it formerly drew a horizontal separator for assisting in organizing your settings. It currently is ignored. It is recommended that you use sections instead.

Deprecated since Cinnamon 3.2

Signals when key has changed in the configuration file. Use this in conjunction with getValue if you want to handle your own updating in a more traditional way (like gsettings).

The callback function will be called with three parameters: settingProvider, oldval, newval, which are, respectively, the settings object (which you usually don't need), the original value and the updated value.