This group provides functions that deal with the freezing of input event processing of an Evas canvas.

Remarks:

There might be scenarios during a graphical user interface program's use when the developer wishes the users would not be able to deliver input events to this application. It may, for example, be the time for it to populate a view or to change some layout. Assuming proper behavior with user interaction during this exact time would be hard, as things are in a changing state. The programmer can then tell the canvas to ignore input events, bringing it back to normal behavior when he or she wants.

Most of the time, the freezing events is used like this:

 evas_event_freeze(my_evas_canvas);
 function_that_does_work_which_cant_be_interrupted_by_events();
 evas_event_thaw(my_evas_canvas);

Functions
void	evas_event_default_flags_set (Evas *e, Evas_Event_Flags flags)
	Sets the default set of flags an event begins with.
Evas_Event_Flags	evas_event_default_flags_get (const Evas *e)
	Gets the default set of flags an event begins with.
void	evas_event_freeze (Evas *e)
	Freezes all input events processing.
void	evas_event_thaw (Evas *e)
	Thaws a canvas out after freezing (for input events).
int	evas_event_freeze_get (const Evas *e)
	Gets the freeze count on input events of a given canvas.
void	evas_event_thaw_eval (Evas *e)
	Re-evaluates the state of objects and call callbacks after thaw of a canvas.

Function Documentation

Evas_Event_Flags evas_event_default_flags_get ( const Evas * e )

Gets the default set of flags an event begins with.

Since (EFL) :: 1.2

Since :: 2.3.1

Remarks:: This gets the default event flags with which the events are produced.

Parameters:

[in] e The canvas to get the default event flags from

Returns:: The default event flags for that canvas

See also:: evas_event_default_flags_set()

void evas_event_default_flags_set	(	Evas *	e,
		Evas_Event_Flags	flags
	)

Sets the default set of flags an event begins with.

Since (EFL) :: 1.2

Since :: 2.3.1

Remarks:: Events in evas can have an event_flags member. This starts out with an initial value (no flags). This lets you set the default flags that an event begins with to be flags.

Parameters:

[in]	e	The canvas to set the default event flags of
[in]	flags	The default flags to use

void evas_event_freeze ( Evas * e )

Freezes all input events processing.

Since :: 2.3.1

Remarks:: This function indicates to Evas that the canvas e is to have all input event processing frozen until a matching evas_event_thaw() function is called on the same canvas. All events of this kind during the freeze get discarded. Every freeze call must be matched by a thaw call in order to completely thaw out a canvas (i.e. these calls may be nested). The most common use is when you do not want the user to interact with your user interface when you are populating a view or changing the layout.

Parameters:

[in] e The canvas to freeze input events processing on

int evas_event_freeze_get ( const Evas * e )

Gets the freeze count on input events of a given canvas.

Since :: 2.3.1

Remarks:

This returns the number of times the canvas has been told to freeze input events. It is possible to call evas_event_freeze() multiple times, and these must be matched by evas_event_thaw() calls. This call allows the program to discover just how many times things have been frozen in case it may want to break out of a deep freeze state where the count is high.

The following is an example:

 extern Evas *evas;

 while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas);

Parameters:

[in] e The canvas to fetch the freeze count from

Returns:: The freeze count

void evas_event_thaw ( Evas * e )

Thaws a canvas out after freezing (for input events).

Since :: 2.3.1

Remarks:: This thaws out a canvas after a matching evas_event_freeze() call. If this call completely thaws out a canvas, i.e., there is no other unbalanced call to evas_event_freeze(), events start to be processed again, but any "missed" events are not be evaluated.

Parameters:

[in] e The canvas to thaw out

See also:: evas_event_freeze() for an example.

void evas_event_thaw_eval ( Evas * e )

Re-evaluates the state of objects and call callbacks after thaw of a canvas.

Since :: 2.3.1

Remarks:: This is normally called after evas_event_thaw() to re-evaluate mouse containment and other states and thus also call callbacks for mouse in and out on new objects if the state change demands it.

Parameters:

[in] e The canvas to evaluate after a thaw

Functions

Function Documentation