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.
This commit is contained in:
Owen W. Taylor
2013-02-14 16:24:27 -05:00
parent e2705544ab
commit 7bb07317f3
3 changed files with 6 additions and 6 deletions

View File

@ -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,