![]() |
![]() |
![]() |
Swfdec Reference Manual | ![]() |
---|---|---|---|---|
SwfdecGtkWidget; GtkWidget* swfdec_gtk_widget_new (SwfdecPlayer *player); SwfdecPlayer* swfdec_gtk_widget_get_player (SwfdecGtkWidget *widget); void swfdec_gtk_widget_set_player (SwfdecGtkWidget *widget, SwfdecPlayer *player); double swfdec_gtk_widget_get_current_scale (SwfdecGtkWidget *widget); double swfdec_gtk_widget_get_scale (SwfdecGtkWidget *widget); void swfdec_gtk_widget_set_scale (SwfdecGtkWidget *widget, double scale); gboolean swfdec_gtk_widget_get_interactive (SwfdecGtkWidget *widget); void swfdec_gtk_widget_set_interactive (SwfdecGtkWidget *widget, gboolean interactive); cairo_surface_type_t swfdec_gtk_widget_get_renderer (SwfdecGtkWidget *widget); gboolean swfdec_gtk_widget_uses_renderer (SwfdecGtkWidget *widget); void swfdec_gtk_widget_set_renderer (SwfdecGtkWidget *widget, cairo_surface_type_t renderer); void swfdec_gtk_widget_unset_renderer (SwfdecGtkWidget *widget);
"interactive" gboolean : Read / Write "player" SwfdecPlayer : Read / Write / Construct "renderer" guint : Read / Write "renderer-set" gboolean : Read / Write "scale" gdouble : Read / Write
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_gtk_widget_new() will probably be the only function you need.
see_also: SwfdecGtkPlayer
typedef struct _SwfdecGtkWidget SwfdecGtkWidget;
The structure for the Swfdec Gtk widget contains no public fields.
GtkWidget* swfdec_gtk_widget_new (SwfdecPlayer *player);
Creates a new SwfdecGtkWidget to display player.
player : | a SwfdecPlayer or NULL |
Returns : | the new widget that displays player |
SwfdecPlayer* swfdec_gtk_widget_get_player (SwfdecGtkWidget *widget);
Gets the player that is currently played back in this widget.
widget : | a SwfdecGtkWidget |
Returns : | the SwfdecPlayer or NULL if none |
void swfdec_gtk_widget_set_player (SwfdecGtkWidget *widget, SwfdecPlayer *player);
Sets the new player to display in widget.
widget : | a SwfdecGtkWidget |
player : | the SwfdecPlayer to display or NULL for none |
double swfdec_gtk_widget_get_current_scale (SwfdecGtkWidget *widget);
Queries the current scale factor in use. The returned value is undefined if the widget has not been allocated a size. This value is only different from the value returned by swfdec_gtk_widget_get_scale(), if automatic scaling is in effect.
widget : | a SwfdecGtkWidget |
Returns : | The current scale factor. |
double swfdec_gtk_widget_get_scale (SwfdecGtkWidget *widget);
Gets the user-set scale factor for this widget. If you want the scale factor that is currently in effect, use swfdec_gtk_widget_get_current_scale().
widget : | a SwfdecGtkWidget |
Returns : | The current scale factor or 0.0 if automatic. |
void swfdec_gtk_widget_set_scale (SwfdecGtkWidget *widget, double scale);
Sets the scale factor to use. If you set scale to 0, the movie is displayed as big as the window is.
widget : | a SwfdecGtkWidget |
scale : | scale factor to use or 0 for automatic |
gboolean swfdec_gtk_widget_get_interactive (SwfdecGtkWidget *widget);
Queries if the widget is currently interactive. See swfdec_gtk_widget_set_interactive() for details.
widget : | a SwfdecGtkWidget |
Returns : | TRUE if the widget is interactive, FALSE otherwise. |
void swfdec_gtk_widget_set_interactive (SwfdecGtkWidget *widget, gboolean 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.
widget : | a SwfdecGtkWidget |
interactive : | TRUE to make the widget interactive |
cairo_surface_type_t swfdec_gtk_widget_get_renderer (SwfdecGtkWidget *widget);
Gets the intermediate renderer that is or would be in use by widget. Use swfdec_gtk_widget_uses_renderer() to check if an intermediate renderer is in use. See swfdec_gtk_widget_set_renderer() for details.
widget : | a SwfdecGtkWidget |
Returns : | the type of the intermediate renderer |
gboolean swfdec_gtk_widget_uses_renderer (SwfdecGtkWidget *widget);
Queries if an intermediate renderer set via swfdec_gtk_widget_set_renderer() is currently in use.
widget : | a SwfdecGtkWidget |
Returns : | TRUE if an intermediate renderer is used. |
void swfdec_gtk_widget_set_renderer (SwfdecGtkWidget *widget, cairo_surface_type_t 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.
widget : | a SwfdecGtkWidget |
renderer : | a cairo_surface_type_t for the intermediate renderer |
void swfdec_gtk_widget_unset_renderer (SwfdecGtkWidget *widget);
Unsets the use of an intermediate rendering surface. See swfdec_gtk_widget_set_renderer() for details.
widget : | a SwfdecGtkWidget |
"interactive" gboolean : Read / Write
if mouse events are processed.
Default value: TRUE
"renderer" guint : Read / Write
cairo_surface_type_t of intermediate renderer to use.
Default value: 0
"renderer-set" gboolean : Read / Write
if an intermediate renderer should be used.
Default value: TRUE