swfdec.ui.Widget

swfdec.ui.Widget
Prev	PySwfdec Gtk Reference	Next

Synopsis

class swfdec.ui.Widget(gtk.Widget):
    swfdec.ui.Widget()
    def get_interactive()
    def get_player()
    def get_renderer()
    def set_interactive(interactive)
    def set_player(player)
    def set_renderer(renderer)
    def unset_renderer()
    def uses_renderer()

Ancestry

+-- gobject.GObject
    +-- gtk.Widget
        +-- swfdec.ui.Widget

swfdec.ui.Widget Properties

"interactive"	Read/Write	If mouse events are processed. Default value: True.
"player"	Read/Write/Construct	Player that is displayed.
"renderer"	Read/Write	cairo_surface_type_t of intermediate renderer to use.
"renderer-set"	Read/Write	If an intermediate renderer should be used. Default value: True

Description

This is a widget for playing Flash movies rendered with Swfdec in a Gtk application. It supports a lot of advanced features, if you want to use them. If you don't want to use them and just want to embed a movie in your application, swfdec.ui.Widget() will probably be the only function you need.

Constructor

    swfdec.ui.Widget(player=None)

`player` :	a `swfdec.Player` or `None`
Returns :	A new `swfdec.ui.Widget`

Creates a new swfdec.ui.Widget.

Methods

swfdec.ui.Widget.get_interactive

    def get_interactive()

Returns :

True if the widget is interactive, False otherwise.

Queries if the widget is currently interactive. See swfdec.ui.Wideget.set_interactive() for details.

swfdec.ui.Widget.get_player

    def get_player()

Returns :

The swfdec.Player or None if none

Gets the player that is currently played back in this widget.

swfdec.ui.Widget.get_renderer

    def get_renderer()

Returns :

the type of the intermediate renderer

Gets the intermediate renderer that is or would be in use by widget. Use swfdec.ui.Widget.uses_renderer() to check if an intermediate renderer is in use. See swfdec.ui.Widget.set_renderer() for details.

swfdec.ui.Widget.set_interactive

    def set_interactive(interactive)

interactive :

True to make the widget interactive.

Sets the widget to be interactive or not. An interactive widget processes mouse and keyboard events, while a non-interactive widget does not care about user input. Widgets are interactive by default.

swfdec.ui.Widget.set_player

    def set_player(player)

player :

the swfdec.Player to display or None.

Sets the new player to display in widget.

swfdec.ui.Widget.set_renderer

    def set_renderer(renderer)

renderer :

A cairo_surface_type_t for the intermediate renderer.

Tells widget to use an intermediate surface for rendering. This is useful for debugging or performance measurements inside swfdec and is probably not interesting for anyone else.

swfdec.ui.Widget.set_scale

    def set_scale(scale)

scale :

Scale factor to use or 0 for automatic.

Sets the scale factor to use. If you set scale to 0, the movie is displayed as big as the window is.

swfdec.ui.Widget.unset_renderer

    def unset_renderer()

Unsets the use of an intermediate rendering surface.

swfdec.ui.Widget.uses_renderer

    def uses_renderer()

Returns :

True if an intermediate renderer is used.

Queries if an intermediate renderer set via swfdec.ui.Widget.set_renderer() is currently in use.

Prev	Up	Next
swfdec.ui.Player	Home	swfdec.ui.Loader