debian man page for lqr_progress_set_init

LQR_PROGRESS_SET_INIT(3)				     LqR library API reference					  LQR_PROGRESS_SET_INIT(3)

NAME
       lqr_progress_set_init - execude custom code before each rescaling operation

SYNOPSIS
       #include <lqr.h>

       LqrRetVal lqr_progress_set_init(LqrProgress* p, LqrProgressFuncInit init_func);

DESCRIPTION
       The function lqr_progress_set_init sets the hook init_func to the LqrProgress object pointed to by p.

       The function init_func is of type LqrProgressFuncInit, whose prototype is defined by:

	   typedef LqrRetVal (*LqrProgressFuncInit) (const gchar* init_message);

       Each time that the function lqr_carver_resize(3) performs a rescale operation (recall that it can perform more than one rescale operation
       at each call) this function will be called first, with a string argument passed through the parameter init_message, which is different for
       horizontal and vertical rescalings.

       The message arguments can be set with the functions lqr_progress_set_init_width_message(3) and lqr_progress_set_init_height_message(3).

       The default values for newly created LqrProgress objects are:

       Horizontal:

	   "Resizing width..."

       Vertical:

	   "Resizing height..."

RETURN VALUE
       The return value follows the Liquid Rescale library signalling system.

SEE ALSO
       LqrRetVal(3), lqr_progress_new(3), lqr_progress_set_update(3), lqr_progress_set_end(3), lqr_progress_set_init_width_message(3),
       lqr_progress_set_init_height_message(3), lqr_progress_set_end_width_message(3), lqr_progress_set_end_height_message(3),
       lqr_progress_set_update_step(3), lqr_carver_set_progress(3)

COPYRIGHT
       Copyright (C) 2007-2009 Carlo Baldassi

LqR library 0.4.1 API (3:1:3)					    10 Maj 2009 					  LQR_PROGRESS_SET_INIT(3)