gitkrenderer.h File Reference

libgitk renderer api and plugin routines More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GitkRenderer
	gitk renderer plugin. This structure keeps all data related to a single renderer instance. More...
Defines
#define	GITKR_INFO_INTERFACE_LOCATION_LOCAL   "local"
	Return value for GITKR_INFO_INTERFACE_LOCATION, that informs that the renderer presents the interface localy (e.g. on screen).
#define	GITKR_INFO_INTERFACE_LOCATION_REMOTE   "remote"
	Return value for GITKR_INFO_INTERFACE_LOCATION, that informs that the renderer presents the interface remote (e.g. via browser).
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 GitkRenderer	GitkRenderer
	renderer plugin handle
typedef GitkRenderer *	GitkRendererPtr
	a pointer to GitkRenderer
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...
Functions
gboolean	gitk_renderer_activate (guint *const argc, gchar ***const argv)
	try to initialise an renderer
void	gitk_renderer_done (void)
gboolean	gitk_renderer_init (guint *const argc, gchar ***const argv, gboolean info_only)
	try to initialise a renderer according to the seetings of commandline option or environment variable.

---

Detailed Description

libgitk renderer api and plugin routines

Id

gitkrenderer.h,v 1.25 2004/09/07 17:46:55 ensonic Exp

Author:

Stefan Kost <ensonic@users.sf.net>

Date:

Mon Aug 20 11:15:18 2001

Definition in file gitkrenderer.h.

---

Define Documentation

#define GITKR_INFO_INTERFACE_LOCATION_LOCAL   "local"

Return value for GITKR_INFO_INTERFACE_LOCATION, that informs that the renderer presents the interface localy (e.g. on screen). Note: Ofcouse screen and/or console output can be watched remote as well. Definition at line 80 of file gitkrenderer.h. Referenced by gitkr_info().

#define GITKR_INFO_INTERFACE_LOCATION_REMOTE   "remote"

Return value for GITKR_INFO_INTERFACE_LOCATION, that informs that the renderer presents the interface remote (e.g. via browser). Definition at line 85 of file gitkrenderer.h. Referenced by gitkr_info().

---

Function Documentation

gboolean gitk_renderer_activate (  guint *const  argc, gchar ***const  argv )

try to initialise an renderer Definition at line 120 of file gitkrenderer.c. References bindtextdomain, check_mode, gitk_err2, gitk_log, gitk_log1, gitk_log2, gitk_renderer, gitk_renderer_done(), gitk_renderer_name, GitkRenderer::gitkr_dialog_hide, GitkRenderer::gitkr_dialog_show, GitkRenderer::gitkr_done, GitkRenderer::gitkr_event_loop_end, GitkRenderer::gitkr_event_loop_restart, GitkRenderer::gitkr_event_loop_start, GitkRenderer::gitkr_info, GITKR_INFO_LOCALEDIR, GITKR_INFO_PACKAGE, GitkRenderer::gitkr_init, GitkrDonePtr, GitkrElementsHidePtr, GitkrElementsShowPtr, GitkrEventLoopEndPtr, GitkrEventLoopStartPtr, GitkrInitPtr, gitkrnull_dialog_hide(), gitkrnull_dialog_show(), gitkrnull_done(), gitkrnull_event_loop_end(), gitkrnull_event_loop_start(), gitkrnull_init(), and GitkRenderer::plugin. Referenced by gitk_event_loop_exchange(), and gitk_renderer_init().

Here is the call graph for this function:

void gitk_renderer_done (  void   )

free the renderer plugin, if there was one active Definition at line 191 of file gitkrenderer.c. References gitk_renderer, GitkRenderer::gitkr_done, and GitkRenderer::plugin. Referenced by gitk_done(), gitk_event_loop_exchange(), gitk_exit_func(), and gitk_renderer_activate().

gboolean gitk_renderer_init (  guint *const  argc, gchar ***const  argv, gboolean  info_only )

try to initialise a renderer according to the seetings of commandline option or environment variable. Definition at line 37 of file gitkrenderer.c. References gitk_log, gitk_log1, gitk_renderer_activate(), and gitk_renderer_name. Referenced by gitk_init().

Here is the call graph for this function:

---