gitk rendering modules

Files
file	gitkrenderer.h
	libgitk renderer api and plugin routines
Modules
group	libgitk gtk+ renderer
group	libgitk html mode renderer
group	libgitk phone mode renderer
group	libgitk text mode renderer
Typedefs
typedef void(*	GitkrDonePtr )(void)
	functionpointer for renderers gitkr_done(). After using the renderer this function will be called to let the renderer do the cleaning up.
typedef void(*	GitkrElementsHidePtr )(GitkDialogPtr dialog)
	functionpointer for renderers gitkr_dialog_hide(). When the dialog has been finished, this function gets called, so that the renderer can free the resources consumed by the dialog representation.
typedef void(*	GitkrElementsShowPtr )(GitkDialogPtr dialog)
	functionpointer for renderers gitkr_dialog_show(). Whenever a dialog needs to be opened this function will be called. The renderer should now prepare a presenation (generate a graphical UI or setup a voice dialog) and present it to the communication partner (user).
typedef void(*	GitkrEventLoopEndPtr )(void)
	functionpointer for renderers gitkr_event_loop_end(). When properties such as language or style of the dialog change due to external influence, the dialog needs to be rebuild. This function is called by the core in such a case.
typedef void(*	GitkrEventLoopRestartPtr )(void)
	functionpointer for renderers gitkr_event_loop_restart(). This function should end the event loop.
typedef void(*	GitkrEventLoopStartPtr )(void)
	functionpointer for renderers gitkr_event_loop_start(). When the dialog is open and callback have been connected, the application will start to allow interaction. Then this function will be called. The renderer should now go into a loop, driving the interaction with the communication partner.
typedef enum GitkrInfo	GitkrInfo
	gitkr info key. A renderer should be able to inform about these subjects. The core library will use these fields e.g. for renderer selection.
typedef gchar *(*	GitkrInfoPtr )(GitkrInfo)
	functionpointer for renderers gitkr_info(). The core library will call this function to query information from the renderer. The function must be available at any time (even before gitkr_init() has been called).
typedef gboolean(*	GitkrInitPtr )(guint *argc, gchar ***argv)
	functionpointer for renderers gitkr_init(). This function is initially called from the core before any dialogs are opened. The plugin should open all resources it needs here and return true on success and false else.
Enumerations
enum	GitkrInfo { GITKR_INFO_LOCALEDIR, GITKR_INFO_PACKAGE, GITKR_INFO_MEDIA_DOMAIN, GITKR_INFO_INTERFACE_LOCATION }
	gitkr info key. A renderer should be able to inform about these subjects. The core library will use these fields e.g. for renderer selection. More...

---

Detailed Description

The gitk library utilises rendering modules to achive the multi modality. Each rendering plugin is a module that runs a interface on a set of input/ouput devices. It contains all the know-how to adapt a generic interface specification to the requirements imposed by the suppoted devices.

Technically each renderer is an own shared object (library) and to be uned as a plugin it needs to adhere to a defined API, which means it needs to implement a certain set of functions. Have a look at already defined renderers such as gtk+ and text to see what the API entry points do.
The renderer plugin will be loaded in gitk_init() in the core library.
The overall life-cycle for a rendering-plugin consists of gitkr_init() and gitkr_done(). Most other entry points relate to the life-cycle of a dialog which consists of: gitkr_dialog_init(), gitkr_dialog_show(), renderers gitkr_dialog_hide() and gitkr_dialog_done(). Some settings fro renderers that are common to all renderers are already handled by the core library. Look at the gitk_init_process_commandline() function to find out more about them.

---

Typedef Documentation

typedef void(* GitkrDonePtr)(void)

functionpointer for renderers gitkr_done(). After using the renderer this function will be called to let the renderer do the cleaning up. Definition at line 109 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

typedef void(* GitkrElementsHidePtr)(GitkDialogPtr dialog)

functionpointer for renderers gitkr_dialog_hide(). When the dialog has been finished, this function gets called, so that the renderer can free the resources consumed by the dialog representation. Definition at line 145 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

typedef void(* GitkrElementsShowPtr)(GitkDialogPtr dialog)

functionpointer for renderers gitkr_dialog_show(). Whenever a dialog needs to be opened this function will be called. The renderer should now prepare a presenation (generate a graphical UI or setup a voice dialog) and present it to the communication partner (user). Definition at line 139 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

typedef void(* GitkrEventLoopEndPtr)(void)

functionpointer for renderers gitkr_event_loop_end(). When properties such as language or style of the dialog change due to external influence, the dialog needs to be rebuild. This function is called by the core in such a case. Definition at line 125 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

typedef void(* GitkrEventLoopRestartPtr)(void)

functionpointer for renderers gitkr_event_loop_restart(). This function should end the event loop. Definition at line 130 of file gitkrenderer.h.

typedef void(* GitkrEventLoopStartPtr)(void)

functionpointer for renderers gitkr_event_loop_start(). When the dialog is open and callback have been connected, the application will start to allow interaction. Then this function will be called. The renderer should now go into a loop, driving the interaction with the communication partner. Definition at line 118 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

typedef enum GitkrInfo GitkrInfo

gitkr info key. A renderer should be able to inform about these subjects. The core library will use these fields e.g. for renderer selection. See also: GitkrInfoPtr Referenced by gitkr_info().

typedef gchar*(* GitkrInfoPtr)(GitkrInfo)

functionpointer for renderers gitkr_info(). The core library will call this function to query information from the renderer. The function must be available at any time (even before gitkr_init() has been called). Definition at line 95 of file gitkrenderer.h.

typedef gboolean(* GitkrInitPtr)(guint *argc, gchar ***argv)

functionpointer for renderers gitkr_init(). This function is initially called from the core before any dialogs are opened. The plugin should open all resources it needs here and return true on success and false else. Definition at line 103 of file gitkrenderer.h. Referenced by gitk_renderer_activate().

---

Enumeration Type Documentation

enum GitkrInfo

gitkr info key. A renderer should be able to inform about these subjects. The core library will use these fields e.g. for renderer selection. See also: GitkrInfoPtr Enumeration values: GITKR_INFO_LOCALEDIR  the renderer locale directory GITKR_INFO_PACKAGE  the renderer package name GITKR_INFO_MEDIA_DOMAIN  which mime-type like medias are covered by the renderer. This can be e.g. text, audio, image, video. GITKR_INFO_INTERFACE_LOCATION  will the interface be presented localy or remote. Supported values are GITKR_INFO_INTERFACE_LOCATION_LOCAL and GITKR_INFO_INTERFACE_LOCATION_REMOTE. Definition at line 57 of file gitkrenderer.h.

---