Ewl_Misc: Miscellaneous Utility Functions
Detailed Description
Provides important miscellaneous functionality such as manipulation of the main loop.
Typedefs | |
typedef void(* | Ewl_Shutdown_Hook )(void) |
Functions | |
void | ewl_canvas_destroy (void *evas) |
void | ewl_canvas_object_destroy (void *obj) |
void | ewl_configure_request (Ewl_Widget *w) |
Ask for a widget to be configured during idle loop. | |
void | ewl_debug_indent_print (int mod_dir) |
Creates a string used to indent debug messages. | |
void | ewl_destroy_request (Ewl_Widget *w) |
int | ewl_init (int *argc, char **argv) |
Initialize the internal variables of ewl to begin the program. | |
void | ewl_main (void) |
The main execution loop of EWL. | |
void | ewl_main_iterate (void) |
One iteration of the main execution loop of EWL. | |
void | ewl_main_quit (void) |
Notifies ewl to quit at the end of this pass of the main loop. | |
void | ewl_print_help (void) |
Print out the Ewl help text. | |
void | ewl_realize_cancel_request (Ewl_Widget *w) |
void | ewl_realize_request (Ewl_Widget *w) |
int | ewl_shutdown (void) |
Cleanup internal data structures used by ewl. | |
void | ewl_shutdown_add (Ewl_Shutdown_Hook hook) |
Allows a widget to hookup a shutdown callback that will be called when Ewl is shutdown. |
Typedef Documentation
typedef void(* Ewl_Shutdown_Hook)(void) |
Function Documentation
void ewl_canvas_destroy | ( | void * | evas | ) |
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, and DLEVEL_STABLE.
Referenced by ewl_window_cb_unrealize().
void ewl_canvas_object_destroy | ( | void * | obj | ) |
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, and DLEVEL_STABLE.
Referenced by ewl_container_cb_unrealize(), ewl_embed_cache_cleanup(), ewl_embed_canvas_set(), ewl_embed_cb_unrealize(), ewl_embed_object_cache(), and ewl_widget_clipped_set().
void ewl_configure_request | ( | Ewl_Widget * | w | ) |
Ask for a widget to be configured during idle loop.
- Parameters:
-
w,: the widget to register for configuration
- Returns:
- Returns no value. Ask for the widget w to be configured when the main idle loop is executed.
References Ewl_Configure_Queue::buffer, configure_active, configure_available, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DLEVEL_TESTING, DRETURN, Ewl_Configure_Queue::end, EWL_CONFIGURE_QUEUE_SIZE, EWL_EMBED, EWL_FLAG_QUEUED_PROCESS_CONFIGURE, EWL_FLAG_QUEUED_SCHEDULED_CONFIGURE, EWL_FLAG_QUEUED_SCHEDULED_DESTROY, EWL_OBJECT, ewl_object_queued_add, ewl_object_queued_has, ewl_object_toplevel_get, EWL_WIDGET_TYPE, NEW, Ewl_Widget::parent, and VISIBLE.
Referenced by ewl_widget_configure().
void ewl_debug_indent_print | ( | int | mod_dir | ) |
Creates a string used to indent debug messages.
- Parameters:
-
mod_dir,: do we add or remove from the indent
- Returns:
- Returns a string with a number of spaces equal to the current debug level
void ewl_destroy_request | ( | Ewl_Widget * | w | ) |
int ewl_init | ( | int * | argc, | |
char ** | argv | |||
) |
Initialize the internal variables of ewl to begin the program.
- Parameters:
-
argc,: the argc passed into the main function argv,: the argv passed into the main function
- Returns:
- Returns 1 or greater on success, 0 otherwise. Sets up necessary internal variables for executing ewl functions. This should be called before any other ewl functions are used.
References configure_active, configure_available, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_CALLBACK_DELETE_WINDOW, EWL_CALLBACK_EXPOSE, ewl_callback_type_add(), ewl_callbacks_init(), ewl_callbacks_shutdown(), ewl_config, ewl_config_cache_init(), EWL_CONFIG_ENGINE_NAME, ewl_config_init(), ewl_config_shutdown(), ewl_config_string_get(), ewl_dnd_init(), ewl_dnd_shutdown(), ewl_embed_list, ewl_engine_new(), ewl_engines_init(), ewl_engines_shutdown(), ewl_icon_theme_init(), ewl_icon_theme_shutdown(), ewl_io_manager_init(), ewl_io_manager_shutdown(), ewl_shutdown(), ewl_text_context_init(), ewl_text_context_shutdown(), ewl_theme_init(), ewl_theme_shutdown(), and ewl_window_list.
void ewl_main | ( | void | ) |
The main execution loop of EWL.
- Returns:
- Returns no value. This is the main execution loop of ewl. It dispatches incoming events and renders updates to the evas's used by ewl.
References DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and ewl_shutdown().
void ewl_main_iterate | ( | void | ) |
One iteration of the main execution loop of EWL.
- Returns:
- Returns no value. This is one iteration of the main execution loop of ewl. It dispatches all of the current incoming events and renders updates on the queue to the evas's used by ewl. Remember to clean up with ewl_shutdown () afterwards.
void ewl_main_quit | ( | void | ) |
Notifies ewl to quit at the end of this pass of the main loop.
- Returns:
- Returns no value. Sets ewl to exit the main execution loop after this time through the loop has been completed.
References DENTER_FUNCTION, DLEAVE_FUNCTION, and DLEVEL_STABLE.
void ewl_print_help | ( | void | ) |
Print out the Ewl help text.
- Returns:
- Returns no value
References DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_names_get(), FREE, and IF_FREE_LIST.
void ewl_realize_cancel_request | ( | Ewl_Widget * | w | ) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_TESTING, EWL_FLAG_QUEUED_SCHEDULED_REVEAL, EWL_OBJECT, ewl_object_queued_remove, and EWL_WIDGET_TYPE.
Referenced by ewl_widget_hide(), ewl_widget_realize(), and ewl_widget_unrealize().
void ewl_realize_request | ( | Ewl_Widget * | w | ) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, EWL_FLAG_PROPERTY_TOPLEVEL, EWL_FLAG_QUEUED_PROCESS_REVEAL, EWL_FLAG_QUEUED_SCHEDULED_REVEAL, EWL_OBJECT, ewl_object_flags_get, ewl_object_queued_add, ewl_object_queued_has, EWL_WIDGET_TYPE, Ewl_Widget::parent, and REALIZED.
Referenced by ewl_container_cb_realize(), ewl_embed_canvas_set(), ewl_widget_cb_reparent(), and ewl_widget_show().
int ewl_shutdown | ( | void | ) |
Cleanup internal data structures used by ewl.
This should be called to cleanup internal EWL data structures, if using ecore directly rather than using ewl_main().
References configure_active, configure_available, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, ewl_embed_list, ewl_widget_destroy(), ewl_window_list, and IF_FREE_LIST.
Referenced by ewl_init(), and ewl_main().
void ewl_shutdown_add | ( | Ewl_Shutdown_Hook | hook | ) |
Allows a widget to hookup a shutdown callback that will be called when Ewl is shutdown.
- Parameters:
-
hook,: The shutdown callback to call
- Returns:
- Returns no value
References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, and DLEVEL_STABLE.
Referenced by ewl_widget_name_set().