GnomeDesktop.BG

g GObject.Object GObject.Object GnomeDesktop.BG GnomeDesktop.BG GObject.Object->GnomeDesktop.BG

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

changes_with_time ()

create_frame_thumbnail (factory, screen, dest_width, dest_height, frame_num)

create_surface (window, width, height)

create_thumbnail (factory, screen, dest_width, dest_height)

draw (dest)

get_filename ()

get_image_size (factory, best_width, best_height, width, height)

get_placement ()

get_rgba (type, primary, secondary)

has_multiple_sizes ()

is_dark (dest_width, dest_height)

load_from_preferences (settings)

save_to_preferences (settings)

set_filename (filename)

set_placement (placement)

set_rgba (type, primary, secondary)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Name

Short Description

changed

transitioned

Fields

Inherited:

GObject.Object (1)

Class Details

class GnomeDesktop.BG(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

GnomeDesktop.BGClass

classmethod new()
Return type:

GnomeDesktop.BG

changes_with_time()
Return type:

bool

create_frame_thumbnail(factory, screen, dest_width, dest_height, frame_num)
Parameters:
Returns:

the newly created thumbnail or or None if frame_num is out of bounds.

Return type:

GdkPixbuf.Pixbuf

Creates a thumbnail for a certain frame, where ‘frame’ is somewhat vaguely defined as ‘suitable point to show while single-stepping through the slideshow’.

create_surface(window, width, height)
Parameters:
Returns:

None on error (e.g. out of X connections)

Return type:

cairo.Surface

Create a surface that can be set as background for window.

create_thumbnail(factory, screen, dest_width, dest_height)
Parameters:
Returns:

a GdkPixbuf.Pixbuf showing the background as a thumbnail

Return type:

GdkPixbuf.Pixbuf

draw(dest)
Parameters:

dest (GdkPixbuf.Pixbuf) –

get_filename()
Return type:

str

get_image_size(factory, best_width, best_height, width, height)
Parameters:
Return type:

bool

get_placement()
Return type:

GDesktopEnums.BackgroundStyle

get_rgba(type, primary, secondary)
Parameters:
has_multiple_sizes()
Return type:

bool

is_dark(dest_width, dest_height)
Parameters:
  • dest_width (int) –

  • dest_height (int) –

Return type:

bool

load_from_preferences(settings)
Parameters:

settings (Gio.Settings) –

save_to_preferences(settings)
Parameters:

settings (Gio.Settings) –

set_filename(filename)
Parameters:

filename (str) –

set_placement(placement)
Parameters:

placement (GDesktopEnums.BackgroundStyle) –

set_rgba(type, primary, secondary)
Parameters:

Signal Details

GnomeDesktop.BG.signals.changed(b_g)
Signal Name:

changed

Flags:

RUN_LAST

Parameters:

b_g (GnomeDesktop.BG) – The object which received the signal

GnomeDesktop.BG.signals.transitioned(b_g)
Signal Name:

transitioned

Flags:

RUN_LAST

Parameters:

b_g (GnomeDesktop.BG) – The object which received the signal