gitk.h File Reference

libgitk includes More...

#include <X11/Xlocale.h>
#include <dirent.h>
#include <errno.h>
#include <glib.h>
#include <gmodule.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <unistd.h>
#include <sys/types.h>
#include <libxml/parser.h>
#include <libxml/parserInternals.h>
#include <libxml/xmlmemory.h>
#include <libxml/xpath.h>
#include <libxml/xpathInternals.h>
#include <libxslt/xslt.h>
#include <libxslt/xsltInternals.h>
#include <libxslt/transform.h>
#include <libxslt/xsltutils.h>
#include <libxslt/extensions.h>
#include <langinfo.h>
#include <libintl.h>
#include "httpd.h"
#include "pthread.h"
#include <libgitk/gitkrenderer.h>
#include <libgitk/gitkcallback.h>
#include <libgitk/gitkcontext.h>
#include <libgitk/gitkdialog.h>
#include <libgitk/gitkdone.h>
#include <libgitk/gitkerrors.h>
#include <libgitk/gitkglobal.h>
#include <libgitk/gitkinit.h>
#include <libgitk/gitklayout.h>
#include <libgitk/gitkprofile.h>
#include <libgitk/gitkserver.h>
#include <libgitk/gitktemplate.h>
#include <libgitk/gitktools.h>
#include <libgitk/gitktrans.h>
#include <libgitk/gitktrans-domain.h>
#include <libgitk/gitktrans-expand.h>
#include <libgitk/gitktrans-i18n.h>
#include <libgitk/gitktrans-style.h>
#include <libgitk/gitkwidget.h>
#include <libgitk/gitkwrapper.h>
#include <libgitk/gitkversion.h>
#include <locale.h>

Include dependency graph for gitk.h:

Include dependency graph

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

Included by dependency graph

Go to the source code of this file.

Data Structures

struct  GitkCallbackNode
 general gitk event callback node More...

struct  GitkDialog
 gitk dialog, active dialog with a GitkLayout More...

struct  GitkEvent
 general gitk event More...

struct  GitkLayout
 gitk layout, keeps information of layout wich is not in the dom tree More...

struct  GitkWidget
 general GitkWidget More...


Defines

#define _(String)   (String)
 translate string argument

#define __(String)   (String)
 translate string argument

#define ANSI_COLOR_BLACK
 ansi escape sequence for color black

#define ANSI_COLOR_BLUE
 ansi escape sequence for color blue

#define ANSI_COLOR_BROWN
 ansi escape sequence for color brown

#define ANSI_COLOR_CYAN
 ansi escape sequence for color cyan

#define ANSI_COLOR_DARKGRAY
 ansi escape sequence for color dark-gray

#define ANSI_COLOR_GREEN
 ansi escape sequence for color green

#define ANSI_COLOR_LIGHTBLUE
 ansi escape sequence for color light-blue

#define ANSI_COLOR_LIGHTCYAN
 ansi escape sequence for color light-cyan

#define ANSI_COLOR_LIGHTGRAY
 ansi escape sequence for color light-gray

#define ANSI_COLOR_LIGHTGREEN
 ansi escape sequence for color light-green

#define ANSI_COLOR_LIGHTPURPLE
 ansi escape sequence for color light-purple

#define ANSI_COLOR_LIGHTRED
 ansi escape sequence for color light-red

#define ANSI_COLOR_PURPLE
 ansi escape sequence for color purple

#define ANSI_COLOR_RED
 ansi escape sequence for color red

#define ANSI_COLOR_WHITE
 ansi escape sequence for color white

#define ANSI_COLOR_YELLOW
 ansi escape sequence for color yellow

#define bindtextdomain(Package, Directory)
 bindtextdomain wrapper

#define dgettext(Domain, String)   (String)
 dgettext wrapper

#define gettext(String)   (String)
 gettext wrapper

#define GIML_PATH   GIML_ROOT_PATH""PACKAGE""G_DIR_SEPARATOR_S
 this is the path component that should be used to reference package local GIML dialog ressources

#define GIML_ROOT_PATH   DATADIR""G_DIR_SEPARATOR_S"giml"G_DIR_SEPARATOR_S
 this is the path component that should be used to reference GIML dialog ressources

#define GITK_CONTROL_ID_MAXLEN   50
 maximum length of widget id strings

#define gitk_dump(str)
 unformated debug-log output

#define gitk_dump1(fmt, par1)
 unformated debug-log output with one parameter

#define gitk_dump2(fmt, par1, par2)
 unformated debug-log output with two parameters

#define gitk_err(str)
 formated error-log output

#define gitk_err1(fmt, par1)
 formated error-log output with one parameter

#define gitk_err2(fmt, par1, par2)
 formated error-log output with two parameters

#define gitk_err3(fmt, par1, par2, par3)
 formated error-log output with three parameters

#define gitk_err4(fmt, par1, par2, par3, par4)
 formated error-log output with four parameters

#define gitk_log(str)
 formated debug-log output

#define gitk_log1(fmt, par1)
 formated debug-log output with one parameter

#define gitk_log2(fmt, par1, par2)
 formated debug-log output with two parameters

#define gitk_log3(fmt, par1, par2, par3)
 formated debug-log output with three parameters

#define gitk_log4(fmt, par1, par2, par3, par4)
 formated debug-log output with four parameters

#define gitk_log_intro()
 log that function starts

#define gitk_log_outro()
 log that function ends

#define GITK_NS_PREFIX   "giml"
 default gitk xml namespace prefix

#define GITK_NS_URL   "http://gitk.sourceforge.net/"
 default gitk xml namespace url

#define gitk_save_get_string(str)   (((void *)str)?(const char *)str:"[NULL]")
 wrap a string for save debug-log output

#define GitkLayoutFields
 from giml/dialog[focus]

#define GitkWidgetFields
 what kind of widget is it

#define I18N_NS_PREFIX   "i18n"
 default i18n xml namespace prefix

#define I18N_NS_URL   "http://apache.org/cocoon/i18n/2.0"
 default i18n xml namespace url

#define N_(String)   (String)
 do not translate string argument

#define print_ansi(code)
 wrapper to enable/disable ANSI color sequences in log output

#define textdomain(Domain)
 textdomain wrapper

#define XSL_PATH   XSL_ROOT_PATH""PACKAGE""G_DIR_SEPARATOR_S
 this is the path component that should be used to reference package local XSL files

#define XSL_ROOT_PATH   DATADIR""G_DIR_SEPARATOR_S"xsl"G_DIR_SEPARATOR_S
 this is the path component that should be used to reference XSL files


Typedefs

typedef GitkCallbackNode GitkCallbackNode
 gitk event callback node

typedef GitkCallbackNodeGitkCallbackNodePtr
 pointer to GitkCallbackNode

typedef gboolean(* GitkCallbackPtr )(GitkDialogPtr dialog, gchar *widget_id, GitkEventPtr event, gpointer user_data)
 gitk event callback

typedef GitkDialog GitkDialog
 gitk dialog, active dialog with a GitkLayout

typedef enum GitkDialogAccessType GitkDialogAccessType
 modifiers for dialog access

typedef GitkDialogGitkDialogPtr
 a pointer to GitkDialog

typedef GitkEvent GitkEvent
 gitk event

typedef GitkEventGitkEventPtr
 pointer to GitkEvent

typedef enum GitkEventType GitkEventType
 gitk event types

typedef enum GitkFocusType GitkFocusType
 gitk focus types

typedef GitkLayout GitkLayout
 gitk layout, keeps information of layout wich is not in the dom tree

typedef GitkLayoutGitkLayoutPtr
 pointer to gitk layout

typedef GitkWidget GitkWidget
 gitk widget

typedef GitkWidgetGitkWidgetPtr
 pointer to gitk widget

typedef enum GitkWidgetType GitkWidgetType
 gitk widget types


Enumerations

enum  GitkDialogAccessType { GITK_DIALOG_ACCESS_RENDERER = 0, GITK_DIALOG_ACCESS_CLIENT }
 modifiers for dialog access More...

enum  GitkEventType {
  GITK_EVENT_TYPE_ON_CLOSE = 0, GITK_EVENT_TYPE_ON_DIALOG_SHOW, GITK_EVENT_TYPE_ON_DIALOG_HIDE, GITK_EVENT_TYPE_ON_CLICKED,
  GITK_EVENT_TYPE_ON_CHANGED
}
 gitk event types More...

enum  GitkFocusType { GITK_FOCUS_TYPE_MAIN = 0, GITK_FOCUS_TYPE_CTRL }
 gitk focus types More...

enum  GitkWidgetType {
  GITK_WIDGET_TYPE_UNDEF = 0, GITK_WIDGET_TYPE_ACTION, GITK_WIDGET_TYPE_CHARACTERINPUT, GITK_WIDGET_TYPE_CHARACTERINPUT_NUMERIC,
  GITK_WIDGET_TYPE_CHARACTERINPUT_ALPHABETIC, GITK_WIDGET_TYPE_OPTIONCHOICE, GITK_WIDGET_TYPE_OPTIONCHOICE_BOOLEAN, GITK_WIDGET_TYPE_OPTIONCHOICE_SINGLE,
  GITK_WIDGET_TYPE_OPTIONCHOICE_SINGLE_COMPACT, GITK_WIDGET_TYPE_LABEL
}
 gitk widget types More...


Detailed Description

libgitk includes

Id
gitk.h,v 1.62 2004/10/28 08:54:03 ensonic Exp

Author:
Stefan Kost <ensonic@users.sf.net>
Date:
Fri Jun 29 15:19:01 2001

Definition in file gitk.h.


Define Documentation

#define _ String   )     (String)
 

translate string argument

Definition at line 71 of file gitk.h.

Referenced by gitk_dialog_new_from_parser_context(), gitk_dialog_validate(), gitk_init_process_commandline(), gitk_template_message_with_title(), gitkr_init(), gitkr_init_process_commandline(), gitkr_widget_optionchoice_value_output(), handle_dialog_ctrl_widgets(), handle_dialog_main_widgets(), info_show(), main(), main_on_changed(), and main_show().

#define __ String   )     (String)
 

translate string argument

Definition at line 73 of file gitk.h.

#define bindtextdomain Package,
Directory   ) 
 

bindtextdomain wrapper

Definition at line 89 of file gitk.h.

Referenced by gitk_init(), gitk_renderer_activate(), index_html(), and main().

#define dgettext Domain,
String   )     (String)
 

dgettext wrapper

Definition at line 85 of file gitk.h.

Referenced by gitk_dialog_trans_i18n_walker().

#define gettext String   )     (String)
 

gettext wrapper

Definition at line 80 of file gitk.h.

#define GIML_PATH   GIML_ROOT_PATH""PACKAGE""G_DIR_SEPARATOR_S
 

this is the path component that should be used to reference package local GIML dialog ressources

Definition at line 114 of file gitk.h.

Referenced by gitk_template_message_with_title(), and main_show().

#define GIML_ROOT_PATH   DATADIR""G_DIR_SEPARATOR_S"giml"G_DIR_SEPARATOR_S
 

this is the path component that should be used to reference GIML dialog ressources

Definition at line 112 of file gitk.h.

Referenced by main_show().

#define GITK_CONTROL_ID_MAXLEN   50
 

maximum length of widget id strings

Definition at line 191 of file gitk.h.

Referenced by gitk_get_widget_child_xpath_expression(), and gitk_get_widget_xpath_expression().

#define GITK_NS_PREFIX   "giml"
 

default gitk xml namespace prefix

Definition at line 102 of file gitk.h.

Referenced by gitk__cxpath_get_object(), gitk__dialog_attach_callback(), gitk_dialog_detach_callback(), gitk_dialog_trans_callback(), gitk_get_widget_child_xpath_expression(), gitk_get_widget_xpath_expression(), gitk_init_common_xpath_expressions(), gitkr_dialog_generate_dialog_widgets(), gitkr_dialog_generate_layout(), gitkr_dialog_generate_sequential_layout(), gitkr_dialog_output_layout(), gitkr_widget_optionchoice_get_choices(), and gitkr_widget_optionchoice_get_ids().

#define GITK_NS_URL   "http://gitk.sourceforge.net/"
 

default gitk xml namespace url

Definition at line 104 of file gitk.h.

Referenced by gitk__cxpath_get_object(), gitk_dialog_trans(), gitk_dialog_trans_initial(), gitk_dialog_validate(), gitkr_select_context(), and main_show().

#define gitk_save_get_string str   )     (((void *)str)?(const char *)str:"[NULL]")
 

wrap a string for save debug-log output

Definition at line 509 of file gitk.h.

Referenced by gitk__dialog_attach_callback(), gitk__widget_get_value(), gitk_dialog_validate(), gitkr_dialog_free_layout(), gitkr_dialog_generate_layout(), index_html(), and main_on_changed().

#define GitkLayoutFields
 

Value:

gchar *title; \
  GitkFocusType focus;  
from giml/dialog[focus]

Definition at line 141 of file gitk.h.

#define GitkWidgetFields
 

Value:

gchar *id; \
  GitkDialogPtr dialog; \
  GitkWidgetType type; 
what kind of widget is it

Definition at line 303 of file gitk.h.

#define I18N_NS_PREFIX   "i18n"
 

default i18n xml namespace prefix

Definition at line 107 of file gitk.h.

#define I18N_NS_URL   "http://apache.org/cocoon/i18n/2.0"
 

default i18n xml namespace url

Definition at line 109 of file gitk.h.

Referenced by gitk_dialog_trans_i18n_walker(), gitk_done_xsl(), gitk_init_xsl(), gitkr_select_context(), and main_show().

#define N_ String   )     (String)
 

do not translate string argument

Definition at line 75 of file gitk.h.

#define print_ansi code   ) 
 

wrapper to enable/disable ANSI color sequences in log output

Definition at line 518 of file gitk.h.

Referenced by gitk_dialog_dump(), and gitk_dialog_dump_walker().

#define textdomain Domain   ) 
 

textdomain wrapper

Definition at line 87 of file gitk.h.

Referenced by gitk_init(), index_html(), and main().

#define XSL_PATH   XSL_ROOT_PATH""PACKAGE""G_DIR_SEPARATOR_S
 

this is the path component that should be used to reference package local XSL files

Definition at line 119 of file gitk.h.

Referenced by gitk_init_xsl().

#define XSL_ROOT_PATH   DATADIR""G_DIR_SEPARATOR_S"xsl"G_DIR_SEPARATOR_S
 

this is the path component that should be used to reference XSL files

Definition at line 117 of file gitk.h.

Referenced by gitk_dialog_trans_domain(), gitk_dialog_trans_style(), gitk_init_xsl_domain(), gitk_init_xsl_style(), and index_html().


Typedef Documentation

typedef enum GitkDialogAccessType GitkDialogAccessType
 

modifiers for dialog access

Referenced by gitk__cxpath_get_node(), gitk__cxpath_get_object(), gitk__cxpath_get_string(), gitk__dialog_get_doc(), gitk__dialog_get_widget(), gitk__dialog_set_title(), gitk__widget_get_value(), gitk__widget_set_value(), gitk__xpath_get_node(), gitk__xpath_get_object(), gitk__xpath_get_string(), gitk_dialog_set_content(), and gitk_toggle_access_type().

typedef struct GitkEvent GitkEvent
 

gitk event

Definition at line 223 of file gitk.h.

typedef GitkEvent* GitkEventPtr
 

pointer to GitkEvent

Definition at line 225 of file gitk.h.

Referenced by dialog_on_clicked(), gitk_dialog_process_event(), global_on_close(), global_on_dialog_hide(), global_on_dialog_show(), main_on_changed(), and main_on_clicked().

typedef enum GitkEventType GitkEventType
 

gitk event types

Todo:
should we separate event types for dialogs and widgets ?

Referenced by gitk__dialog_attach_callback(), gitk_dialog_detach_callback(), and gitk_get_callback_node().

typedef enum GitkFocusType GitkFocusType
 

gitk focus types

typedef struct GitkLayout GitkLayout
 

gitk layout, keeps information of layout wich is not in the dom tree

Definition at line 136 of file gitk.h.

typedef GitkLayout* GitkLayoutPtr
 

pointer to gitk layout

Definition at line 138 of file gitk.h.

Referenced by gitkr_dialog_generate_layout().

typedef struct GitkWidget GitkWidget
 

gitk widget

Definition at line 298 of file gitk.h.

typedef GitkWidget* GitkWidgetPtr
 

pointer to gitk widget

Definition at line 300 of file gitk.h.

Referenced by gitk_dialog_move_focus(), handle_dialog_main_widgets(), next_widget(), and prev_widget().

typedef enum GitkWidgetType GitkWidgetType
 

gitk widget types

Referenced by gitk_widget_get_type().


Enumeration Type Documentation

enum GitkDialogAccessType
 

modifiers for dialog access

Enumeration values:
GITK_DIALOG_ACCESS_RENDERER  renders will access dst-data in dialog
GITK_DIALOG_ACCESS_CLIENT  clients will access src-data in dialog

Definition at line 181 of file gitk.h.

enum GitkEventType
 

gitk event types

Todo:
should we separate event types for dialogs and widgets ?
Enumeration values:
GITK_EVENT_TYPE_ON_CLOSE  global event, that signals that a dialog will be closed (window close, ctrl-c)
GITK_EVENT_TYPE_ON_DIALOG_SHOW  global event, called at the end of gitk_dialog_show with the respective dialog as user_data
GITK_EVENT_TYPE_ON_DIALOG_HIDE  global event, called at the begin of gitk_dialog_hide with the respective dialog as user_data
GITK_EVENT_TYPE_ON_CLICKED  local event that signals that a widget has been clicked (action)
GITK_EVENT_TYPE_ON_CHANGED  local event that signals that a widget has been changed (data entered/option selected)

Definition at line 199 of file gitk.h.

enum GitkFocusType
 

gitk focus types

Enumeration values:
GITK_FOCUS_TYPE_MAIN  initial focus on dialog widgets
GITK_FOCUS_TYPE_CTRL  initial focus on dialog control widgets

Definition at line 126 of file gitk.h.

enum GitkWidgetType
 

gitk widget types

Enumeration values:
GITK_WIDGET_TYPE_UNDEF  unknown widget
GITK_WIDGET_TYPE_ACTION  button, menu-item, command
GITK_WIDGET_TYPE_CHARACTERINPUT  character input widget
GITK_WIDGET_TYPE_CHARACTERINPUT_NUMERIC  character input widget
GITK_WIDGET_TYPE_CHARACTERINPUT_ALPHABETIC  character input widget
GITK_WIDGET_TYPE_OPTIONCHOICE  option chooser
GITK_WIDGET_TYPE_OPTIONCHOICE_BOOLEAN  option chooser
GITK_WIDGET_TYPE_OPTIONCHOICE_SINGLE  option chooser
GITK_WIDGET_TYPE_OPTIONCHOICE_SINGLE_COMPACT  option chooser
GITK_WIDGET_TYPE_LABEL  text label

Definition at line 268 of file gitk.h.


Generated on Thu Oct 28 10:59:23 2004 for gitk by doxygen 1.3.6