/* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ /* * hlink.c: hyperlink support * * Copyright (C) 2000-2005 Jody Goldberg (jody@gnome.org) * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) version 3. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 * USA */ #include #include #include "gnumeric.h" #include "hlink.h" #include "hlink-impl.h" #include "command-context.h" #include "workbook-control.h" #include "workbook-view.h" #include "selection.h" #include "sheet.h" #include "sheet-view.h" #include "sheet-style.h" #include "ranges.h" #include "position.h" #include "expr-name.h" #include "expr.h" #include "value.h" #include "mstyle.h" #include #include #define GET_CLASS(instance) G_TYPE_INSTANCE_GET_CLASS (instance, GNM_HLINK_TYPE, GnmHLinkClass) /* * WARNING WARNING WARNING * * The type names are used in the xml persistence DO NOT CHANGE THEM */ /** * gnm_hlink_activate: * @lnk: * @wbcg: the wbcg that activated the link * * Returns: TRUE if the link successfully activated. **/ gboolean gnm_hlink_activate (GnmHLink *lnk, WBCGtk *wbcg) { g_return_val_if_fail (IS_GNM_HLINK (lnk), FALSE); return GET_CLASS (lnk)->Activate (lnk, wbcg); } /** * sheet_hlink_find: * @sheet: #Sheet * @pos: #GcmCellPos * * Returns: (transfer none): the found #GnmHLink. **/ GnmHLink * sheet_hlink_find (Sheet const *sheet, GnmCellPos const *pos) { GnmStyle const *style = sheet_style_get (sheet, pos->col, pos->row); return gnm_style_get_hlink (style); } static void gnm_hlink_finalize (GObject *obj) { GObjectClass *parent_class; GnmHLink *lnk = (GnmHLink *)obj; g_free (lnk->target); lnk->target = NULL; g_free (lnk->tip); lnk->tip = NULL; parent_class = g_type_class_peek (G_TYPE_OBJECT); parent_class->finalize (obj); } static void gnm_hlink_class_init (GObjectClass *object_class) { object_class->finalize = gnm_hlink_finalize; } static void gnm_hlink_init (GObject *obj) { GnmHLink *lnk = (GnmHLink * )obj; lnk->target = NULL; lnk->tip = NULL; } GSF_CLASS_ABSTRACT (GnmHLink, gnm_hlink, gnm_hlink_class_init, gnm_hlink_init, G_TYPE_OBJECT) gchar const * gnm_hlink_get_target (GnmHLink const *lnk) { g_return_val_if_fail (IS_GNM_HLINK (lnk), NULL); return lnk->target; } void gnm_hlink_set_target (GnmHLink *lnk, gchar const *target) { gchar *tmp; g_return_if_fail (IS_GNM_HLINK (lnk)); tmp = g_strdup (target); g_free (lnk->target); lnk->target = tmp; } gchar const * gnm_hlink_get_tip (GnmHLink const *lnk) { g_return_val_if_fail (IS_GNM_HLINK (lnk), NULL); return lnk->tip; } void gnm_hlink_set_tip (GnmHLink *lnk, gchar const *tip) { gchar *tmp; g_return_if_fail (IS_GNM_HLINK (lnk)); tmp = g_strdup (tip); g_free (lnk->tip); lnk->tip = tmp; } /***************************************************************************/ /* Link to named regions within the current workbook */ typedef struct { GnmHLinkClass hlink; } GnmHLinkCurWBClass; typedef struct { GnmHLink hlink; } GnmHLinkCurWB; #define GNM_HLINK_CUR_WB(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), gnm_hlink_cur_wb_get_type (), GnmHLinkCurWB)) static gboolean gnm_hlink_cur_wb_activate (GnmHLink *lnk, WBCGtk *wbcg) { GnmRangeRef const *r; GnmCellPos tmp; Sheet *target_sheet; WorkbookControl *wbc = WORKBOOK_CONTROL (wbcg); Sheet *sheet = wbcg_cur_sheet (wbcg); SheetView *sv; GnmValue *target; if (!lnk->target) { go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg), _("Link target"), _("(none)")); return FALSE; } target = value_new_cellrange_str (sheet, lnk->target); /* not an address, is it a name ? */ if (target == NULL) { GnmParsePos pp; GnmNamedExpr *nexpr = expr_name_lookup ( parse_pos_init_sheet (&pp, sheet), lnk->target); if (nexpr != NULL) target = gnm_expr_top_get_range (nexpr->texpr); } if (target == NULL) { go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg), _("Link target"), lnk->target); return FALSE; } r = &target->v_range.cell; tmp.col = r->a.col; tmp.row = r->a.row; target_sheet = r->a.sheet ? r->a.sheet : sheet; sv = sheet_get_view (target_sheet, wb_control_view (wbc)); sv_selection_set (sv, &tmp, r->a.col, r->a.row, r->b.col, r->b.row); sv_make_cell_visible (sv, r->a.col, r->a.row, FALSE); if (sheet != target_sheet) wb_view_sheet_focus (wb_control_view (wbc), target_sheet); value_release (target); return TRUE; } static void gnm_hlink_cur_wb_class_init (GObjectClass *object_class) { GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class; hlink_class->Activate = gnm_hlink_cur_wb_activate; } GSF_CLASS (GnmHLinkCurWB, gnm_hlink_cur_wb, gnm_hlink_cur_wb_class_init, NULL, GNM_HLINK_TYPE) /***************************************************************************/ /* Link to arbitrary urls */ typedef struct { GnmHLinkClass hlink; } GnmHLinkURLClass; typedef struct { GnmHLink hlink; } GnmHLinkURL; static gboolean gnm_hlink_url_activate (GnmHLink *lnk, WBCGtk *wbcg) { GError *err = NULL; GdkScreen *screen; if (lnk->target == NULL) return FALSE; screen = gtk_window_get_screen (wbcg_toplevel (wbcg)); err = go_gtk_url_show (lnk->target, screen); if (err != NULL) { char *msg = g_strdup_printf (_("Unable to activate the url '%s'"), lnk->target); go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg), msg, err->message); g_free (msg); g_error_free (err); } return err == NULL; } static void gnm_hlink_url_class_init (GObjectClass *object_class) { GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class; hlink_class->Activate = gnm_hlink_url_activate; } GSF_CLASS (GnmHLinkURL, gnm_hlink_url, gnm_hlink_url_class_init, NULL, GNM_HLINK_TYPE) /***************************************************************************/ /* email is just a url, but it is cleaner to stick it in a distinct type */ typedef struct { GnmHLinkURLClass hlink; } GnmHLinkEMailClass; typedef struct { GnmHLinkURL hlink; } GnmHLinkEMail; GSF_CLASS (GnmHLinkEMail, gnm_hlink_email, NULL, NULL, gnm_hlink_url_get_type ()) /***************************************************************************/ /* Link to arbitrary urls */ typedef struct { GnmHLinkClass hlink; } GnmHLinkExternalClass; typedef struct { GnmHLink hlink; } GnmHLinkExternal; static gboolean gnm_hlink_external_activate (GnmHLink *lnk, WBCGtk *wbcg) { GError *err = NULL; gboolean res = FALSE; char *cmd; GdkScreen *screen; if (lnk->target == NULL) return FALSE; cmd = go_shell_arg_to_uri (lnk->target); screen = gtk_window_get_screen (wbcg_toplevel (wbcg)); err = go_gtk_url_show (cmd, screen); g_free (cmd); if (err != NULL) { char *msg = g_strdup_printf(_("Unable to open '%s'"), lnk->target); go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg), msg, err->message); g_free (msg); g_error_free (err); } return res; } static void gnm_hlink_external_class_init (GObjectClass *object_class) { GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class; hlink_class->Activate = gnm_hlink_external_activate; } GSF_CLASS (GnmHLinkExternal, gnm_hlink_external, gnm_hlink_external_class_init, NULL, GNM_HLINK_TYPE) void _gnm_hlink_init (void) { /* make sure that all hlink types are registered */ gnm_hlink_cur_wb_get_type (); gnm_hlink_url_get_type (); gnm_hlink_email_get_type (); gnm_hlink_external_get_type (); }