help.c File Reference

#include "system/mem_alloc.h"
#include "gui/application.h"
#include "gui/actions/menu.h"
#include "osx/osx.h"
#include "gui/actions/supervisor_window.h"
#include "control/control.h"
#include "tools/darktable_authors.h"

Include dependency graph for help.c:

Go to the source code of this file.

Functions
static gboolean	show_about_dialog (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	open_doc_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	open_chat_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	open_search_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	open_forum_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static char *	get_help_url (GtkWidget *widget)
static void	_restore_default_cursor ()
static void	_main_do_event_help (GdkEvent *event, gpointer data)
static gboolean	contextual_help_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	search_accels_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
static gboolean	supervisor_callback (GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
void	append_help (GtkWidget **menus, GList **lists, const dt_menus_t index)

Function Documentation

_main_do_event_help()

static void _main_do_event_help ( GdkEvent *  event, gpointer  data  )

static

Todo:

: find a better way to tell the user that the hovered widget has a help link

Definition at line 113 of file help.c.

References _restore_default_cursor(), dt_control_allow_change_cursor(), dt_control_change_cursor, dt_control_forbid_change_cursor(), dt_control_log(), DT_DEBUG_CONTROL, dt_gui_main_window(), dt_osx_disallow_fullscreen(), dt_print(), error(), FALSE, get_help_url(), IS_NULL_PTR, and TRUE.

Referenced by contextual_help_callback().

_restore_default_cursor()

static void _restore_default_cursor ( )

static

Definition at line 106 of file help.c.

References dt_control_allow_change_cursor(), and dt_control_change_cursor.

Referenced by _main_do_event_help().

append_help()

void append_help	(	GtkWidget **	menus,
		GList **	lists,
		const dt_menus_t	index
	)

Definition at line 230 of file help.c.

References add_menu_separator(), add_sub_menu_entry(), contextual_help_callback(), open_chat_callback(), open_doc_callback(), open_forum_callback(), open_search_callback(), search_accels_callback(), show_about_dialog(), and supervisor_callback().

Referenced by dt_ui_init_global_menu().

contextual_help_callback()

static gboolean contextual_help_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 209 of file help.c.

References _main_do_event_help(), dt_control_change_cursor, dt_control_forbid_change_cursor(), and TRUE.

Referenced by append_help().

get_help_url()

static char * get_help_url ( GtkWidget *  widget )

static

Todo:

: this doesn't work for all widgets. the reason being that the GtkEventBox we put libs/iops into catches events.

Definition at line 93 of file help.c.

Referenced by _main_do_event_help().

open_chat_callback()

static gboolean open_chat_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 71 of file help.c.

References dt_gui_main_window(), and TRUE.

Referenced by append_help().

open_doc_callback()

static gboolean open_doc_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Todo:

: use translated URL when doc gets translated

Definition at line 64 of file help.c.

References dt_gui_main_window(), and TRUE.

Referenced by append_help().

open_forum_callback()

static gboolean open_forum_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 85 of file help.c.

References dt_gui_main_window(), and TRUE.

Referenced by append_help().

open_search_callback()

static gboolean open_search_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 78 of file help.c.

References dt_gui_main_window(), and TRUE.

Referenced by append_help().

search_accels_callback()

static gboolean search_accels_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 217 of file help.c.

References dt_accels_search(), dt_gui_get_accels(), dt_gui_main_window(), main(), and TRUE.

Referenced by append_help().

show_about_dialog()

static gboolean show_about_dialog ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 29 of file help.c.

References darktable_last_commit_year, darktable_package_version, dt_free, dt_gui_main_window(), dt_osx_disallow_fullscreen(), PACKAGE_NAME, and TRUE.

Referenced by append_help().

supervisor_callback()

static gboolean supervisor_callback ( GtkAccelGroup *  group, GObject *  acceleratable, guint  keyval, GdkModifierType  mods, gpointer  user_data  )

static

Definition at line 224 of file help.c.

References dt_gui_supervisor_window_show(), and TRUE.

Referenced by append_help().