GnomeDesktop.BGSlideShow

g GObject.Object GObject.Object GnomeDesktop.BGSlideShow GnomeDesktop.BGSlideShow GObject.Object->GnomeDesktop.BGSlideShow

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new (filename)

get_current_slide (width, height)

get_has_multiple_sizes ()

get_num_slides ()

get_slide (frame_number, width, height)

get_start_time ()

get_total_duration ()

load ()

load_async (cancellable, callback, *user_data)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

file

Gio.File

r/w/co

File

has-multiple-sizes

bool

r

Has multiple sizes

start-time

float

r

start time

total-duration

float

r

total duration

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_object

GObject.Object

r

Class Details

class GnomeDesktop.BGSlideShow(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

GnomeDesktop.BGSlideShowClass

classmethod new(filename)
Parameters:

filename (str) – The filename of the slide show

Returns:

the new GnomeDesktop.BGSlideShow

Return type:

GnomeDesktop.BGSlideShow

Creates a new object to manage a slide show. window background between two cairo.Surfaces.

get_current_slide(width, height)
Parameters:
  • width (int) – monitor width

  • height (int) – monitor height

Returns:

progress:

slide progress

duration:

slide duration

is_fixed:

if slide is fixed

file1:

first file in slide

file2:

second file in slide

Return type:

(progress: float, duration: float, is_fixed: bool, file1: str, file2: str)

Returns the current slides progress.

get_has_multiple_sizes()
Returns:

True if multiple sizes

Return type:

bool

gets whether or not the slide show has multiple sizes for different monitors

get_num_slides()
Return type:

int

Returns number of slides in slide show

get_slide(frame_number, width, height)
Parameters:
  • frame_number (int) – frame number

  • width (int) – monitor width

  • height (int) – monitor height

Returns:

True if successful

progress:

slide progress

duration:

slide duration

is_fixed:

if slide is fixed

file1:

first file in slide

file2:

second file in slide

Return type:

(bool, progress: float, duration: float, is_fixed: bool, file1: str, file2: str)

Retrieves slide by frame number

get_start_time()
Returns:

a timestamp

Return type:

float

gets the start time of the slide show

get_total_duration()
Returns:

a timestamp

Return type:

float

gets the total duration of the slide show

load()
Raises:

GLib.Error

Returns:

True if successful

Return type:

bool

Tries to load the slide show.

load_async(cancellable, callback, *user_data)
Parameters:

Tries to load the slide show asynchronously.

Property Details

GnomeDesktop.BGSlideShow.props.file
Name:

file

Type:

Gio.File

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

File

GnomeDesktop.BGSlideShow.props.has_multiple_sizes
Name:

has-multiple-sizes

Type:

bool

Default Value:

False

Flags:

READABLE

Has multiple sizes

GnomeDesktop.BGSlideShow.props.start_time
Name:

start-time

Type:

float

Default Value:

0.0

Flags:

READABLE

start time

GnomeDesktop.BGSlideShow.props.total_duration
Name:

total-duration

Type:

float

Default Value:

0.0

Flags:

READABLE

total duration