GnomeDesktop.BGCrossfade¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/co |
Height of window to fade on |
||
r/w/co |
Width of window to fade |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
When a crossfade finishes, window will have a copy of the end surface as its background, and this signal will get emitted. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_object |
r |
Class Details¶
- class GnomeDesktop.BGCrossfade(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new(width, height)¶
- Parameters:
- Returns:
the new
GnomeDesktop.BGCrossfade
- Return type:
Creates a new object to manage crossfading a window background between two
cairo.Surfaces
.
- is_started()¶
-
This function reveals whether or not self is currently running on a window. See
GnomeDesktop.BGCrossfade.start
() for information on how to initiate a crossfade.
- set_end_surface(surface)¶
- Parameters:
surface (
cairo.Surface
) – The cairo surface to fade to- Returns:
True
if successful, orFalse
if the surface could not be copied.- Return type:
Before initiating a crossfade with
GnomeDesktop.BGCrossfade.start
() a start and end surface have to be set. This function sets the surface shown at the end of the crossfade effect.
- set_start_surface(surface)¶
- Parameters:
surface (
cairo.Surface
) – The cairo surface to fade from- Returns:
True
if successful, orFalse
if the surface could not be copied.- Return type:
Before initiating a crossfade with
GnomeDesktop.BGCrossfade.start
() a start and end surface have to be set. This function sets the surface shown at the beginning of the crossfade effect.
- start(window)¶
- Parameters:
window (
Gdk.Window
) – TheGdk.Window
to draw crossfade on
This function initiates a quick crossfade between two surfaces on the background of window. Before initiating the crossfade both
GnomeDesktop.BGCrossfade.start
() and gnome_bg_crossfade_end() need to be called. If animations are disabled, the crossfade is skipped, and the window background is set immediately to the end surface.
- stop()¶
This function stops any in progress crossfades that may be happening. It’s harmless to call this function if self is already stopped.
- do_finished(window) virtual¶
- Parameters:
window (
Gdk.Window
) –
Signal Details¶
- GnomeDesktop.BGCrossfade.signals.finished(b_g_crossfade, window)¶
- Signal Name:
finished
- Flags:
- Parameters:
b_g_crossfade (
GnomeDesktop.BGCrossfade
) – The object which received the signalwindow (
GObject.Object
) – theGdk.Window
the crossfade happend on.
When a crossfade finishes, window will have a copy of the end surface as its background, and this signal will get emitted.
Property Details¶
- GnomeDesktop.BGCrossfade.props.height¶
- Name:
height
- Type:
- Default Value:
0
- Flags:
When a crossfade is running, this is height of the fading surface.
- GnomeDesktop.BGCrossfade.props.width¶
- Name:
width
- Type:
- Default Value:
0
- Flags:
When a crossfade is running, this is width of the fading surface.