CinnamonBgItem

CinnamonBgItem — One monitor's background configuration

Functions

Properties

char * color-shading-type Read / Write
char * connector Read
int index Read
char * monitor-label Read
char * picture-options Read / Write
char * picture-uri Read / Write
char * primary-color Read / Write
char * secondary-color Read / Write
gboolean slideshow Read / Write
char * slideshow-source Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── CinnamonBgItem

Description

One entry of the picture-uri-list GSettings key: what to paint on one or more monitor, plus the identity to recognise it across sessions. The color properties always apply — they are the backdrop a picture is drawn over.

Items come from a CinnamonBgList and are live: setting a property changes the configuration that list will write on cinnamon_bg_list_save().

Functions

cinnamon_bg_item_has_picture ()

gboolean
cinnamon_bg_item_has_picture (CinnamonBgItem *self);

Whether this item has a picture to paint over its color backdrop: a placement other than none *and* a set picture uri.

Parameters

self

a CinnamonBgItem

 

Returns

TRUE if self has a picture to paint

Types and Values

CINNAMON_TYPE_BG_ITEM

#define CINNAMON_TYPE_BG_ITEM (cinnamon_bg_item_get_type ())

CinnamonBgItem

typedef struct _CinnamonBgItem CinnamonBgItem;

Property Details

The “color-shading-type” property

  “color-shading-type”       char *

How the color backdrop is drawn: solid for a flat “primary-color”, or horizontal or vertical for a gradient between it and “secondary-color”. Exactly as the key stores it; anything unrecognized is taken as solid.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: "solid"


The “connector” property

  “connector”                char *

The connector of the monitor this entry configures, for example eDP-1. Empty on the representative entry used by mirror and spanned.

Owner: CinnamonBgItem

Flags: Read

Default value: ""


The “index” property

  “index”                    int

The logical-monitor index this entry was last seen at, or -1 if unknown. The cross-session fallback when connector names differ.

Owner: CinnamonBgItem

Flags: Read

Allowed values: >= -1

Default value: -1


The “monitor-label” property

  “monitor-label”            char *

A human-readable name for the monitor, for labeling in a UI.

Owner: CinnamonBgItem

Flags: Read

Default value: ""


The “picture-options” property

  “picture-options”          char *

How “picture-uri” is fitted to the monitor: none, wallpaper, centered, scaled, stretched or zoom.

none paints no picture, only the color background. Anything unrecognised is taken as zoom.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: "zoom"


The “picture-uri” property

  “picture-uri”              char *

The picture to paint, or "" for none. Only local file:// URIs. On a slideshow monitor the daemon rewrites this on every rotation, so it is the current image rather than a user choice.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: ""


The “primary-color” property

  “primary-color”            char *

The backdrop color, as a parse-able color string such as #000000. Always painted underneath any picture.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: "#000000"


The “secondary-color” property

  “secondary-color”          char *

The second color of the gradient. Only used when “color-shading-type” is a gradient.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: "#000000"


The “slideshow” property

  “slideshow”                gboolean

Whether the slideshow daemon rotates this monitor's picture. Per-monitor; the interval and ordering are global settings.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: FALSE


The “slideshow-source” property

  “slideshow-source”         char *

Where a slideshow draws its images from, as a type://path string: directory:// for a folder or xml:// for a wallpaper collection.

Owner: CinnamonBgItem

Flags: Read / Write

Default value: ""

See Also

CinnamonBgList