Commit 7bb07317 authored by Owen W. Taylor's avatar Owen W. Taylor

GtkTickCallback: document use of G_SOURCE_CONTINUE/REMOVE for return value

Document that G_SOURCE_CONTINUE and G_SOURCE_REMOVE are the preferred
return values from a tick callback.
parent e2705544
......@@ -4584,9 +4584,9 @@ gtk_widget_on_frame_clock_update (GdkFrameClock *frame_clock,
ref_tick_callback_info (info);
if (!info->destroyed)
{
if (!info->callback (widget,
frame_clock,
info->user_data))
if (info->callback (widget,
frame_clock,
info->user_data) == G_SOURCE_REMOVE)
{
destroy_tick_callback_info (widget, info, l);
}
......
......@@ -94,8 +94,8 @@ typedef void (*GtkCallback) (GtkWidget *widget,
*
* Callback type for adding a function to update animations. See gtk_widget_add_tick_callback().
*
* Returns: %TRUE if the tick callback should continue to be called,
* %FALSE if the tick callback should be removed.
* Returns: %G_SOURCE_CONTINUE if the tick callback should continue to be called,
* %G_SOURCE_REMOVE if the tick callback should be removed.
*/
typedef gboolean (*GtkTickCallback) (GtkWidget *widget,
GdkFrameClock *frame_clock,
......
......@@ -251,7 +251,7 @@ tick_callback (GtkWidget *widget,
scaled_time = (frame_time - start_frame_time) / (CYCLE_TIME * 1000000);
on_frame (scaled_time - floor (scaled_time));
return TRUE;
return G_SOURCE_CONTINUE;
}
static gboolean
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment