1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2001. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28 #include "gtktextutil.h"
29 #include "gtktextview.h"
31 #define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
33 #include "gtktextdisplay.h"
34 #include "gtktextbuffer.h"
35 #include "gtkmenuitem.h"
39 #define DRAG_ICON_MAX_WIDTH 250
40 #define DRAG_ICON_MAX_HEIGHT 250
41 #define DRAG_ICON_LAYOUT_BORDER 5
42 #define DRAG_ICON_MAX_LINES 7
43 #define ELLIPSIS_CHARACTER "\xe2\x80\xa6"
45 typedef struct _GtkUnicodeMenuEntry GtkUnicodeMenuEntry;
46 typedef struct _GtkTextUtilCallbackInfo GtkTextUtilCallbackInfo;
48 struct _GtkUnicodeMenuEntry {
53 struct _GtkTextUtilCallbackInfo
55 GtkTextUtilCharChosenFunc func;
59 static const GtkUnicodeMenuEntry bidi_menu_entries[] = {
60 { N_("LRM _Left-to-right mark"), 0x200E },
61 { N_("RLM _Right-to-left mark"), 0x200F },
62 { N_("LRE Left-to-right _embedding"), 0x202A },
63 { N_("RLE Right-to-left e_mbedding"), 0x202B },
64 { N_("LRO Left-to-right _override"), 0x202D },
65 { N_("RLO Right-to-left o_verride"), 0x202E },
66 { N_("PDF _Pop directional formatting"), 0x202C },
67 { N_("ZWS _Zero width space"), 0x200B },
68 { N_("ZWJ Zero width _joiner"), 0x200D },
69 { N_("ZWNJ Zero width _non-joiner"), 0x200C }
73 activate_cb (GtkWidget *menu_item,
76 GtkUnicodeMenuEntry *entry;
77 GtkTextUtilCallbackInfo *info = data;
80 entry = g_object_get_data (G_OBJECT (menu_item), "gtk-unicode-menu-entry");
82 buf[g_unichar_to_utf8 (entry->ch, buf)] = '\0';
84 (* info->func) (buf, info->data);
88 * _gtk_text_util_append_special_char_menuitems
89 * @menushell: a #GtkMenuShell
90 * @callback: call this when an item is chosen
91 * @data: data for callback
93 * Add menuitems for various bidi control characters to a menu;
94 * the menuitems, when selected, will call the given function
95 * with the chosen character.
97 * This function is private/internal in GTK 2.0, the functionality may
98 * become public sometime, but it probably needs more thought first.
99 * e.g. maybe there should be a way to just get the list of items,
100 * instead of requiring the menu items to be created.
103 _gtk_text_util_append_special_char_menuitems (GtkMenuShell *menushell,
104 GtkTextUtilCharChosenFunc func,
109 for (i = 0; i < G_N_ELEMENTS (bidi_menu_entries); i++)
112 GtkTextUtilCallbackInfo *info;
114 /* wasteful to have a bunch of copies, but simplifies mem management */
115 info = g_new (GtkTextUtilCallbackInfo, 1);
119 menuitem = gtk_menu_item_new_with_mnemonic (_(bidi_menu_entries[i].label));
120 g_object_set_data (G_OBJECT (menuitem), I_("gtk-unicode-menu-entry"),
121 (gpointer)&bidi_menu_entries[i]);
123 g_signal_connect_data (menuitem, "activate",
124 G_CALLBACK (activate_cb),
125 info, (GClosureNotify) g_free, 0);
127 gtk_widget_show (menuitem);
128 gtk_menu_shell_append (menushell, menuitem);
133 append_n_lines (GString *str, const gchar *text, GSList *lines, gint n_lines)
135 PangoLayoutLine *line;
138 for (i = 0; i < n_lines; i++)
141 g_string_append_len (str, &text[line->start_index], line->length);
147 limit_layout_lines (PangoLayout *layout)
151 GSList *lines, *elem;
154 n_lines = pango_layout_get_line_count (layout);
156 if (n_lines >= DRAG_ICON_MAX_LINES)
158 text = pango_layout_get_text (layout);
159 str = g_string_new (NULL);
160 lines = pango_layout_get_lines_readonly (layout);
162 /* get first lines */
164 append_n_lines (str, text, elem,
165 DRAG_ICON_MAX_LINES / 2);
167 g_string_append (str, "\n" ELLIPSIS_CHARACTER "\n");
170 elem = g_slist_nth (lines, n_lines - DRAG_ICON_MAX_LINES / 2);
171 append_n_lines (str, text, elem,
172 DRAG_ICON_MAX_LINES / 2);
174 pango_layout_set_text (layout, str->str, -1);
175 g_string_free (str, TRUE);
180 * _gtk_text_util_create_drag_icon
181 * @widget: #GtkWidget to extract the pango context
182 * @text: a #gchar to render the icon
183 * @len: length of @text, or -1 for NUL-terminated text
185 * Creates a drag and drop icon from @text.
188 _gtk_text_util_create_drag_icon (GtkWidget *widget,
192 GdkDrawable *drawable = NULL;
193 PangoContext *context;
195 gint pixmap_height, pixmap_width;
196 gint layout_width, layout_height;
198 g_return_val_if_fail (widget != NULL, NULL);
199 g_return_val_if_fail (text != NULL, NULL);
201 context = gtk_widget_get_pango_context (widget);
202 layout = pango_layout_new (context);
204 pango_layout_set_text (layout, text, len);
205 pango_layout_set_wrap (layout, PANGO_WRAP_WORD_CHAR);
206 pango_layout_get_size (layout, &layout_width, &layout_height);
208 layout_width = MIN (layout_width, DRAG_ICON_MAX_WIDTH * PANGO_SCALE);
209 pango_layout_set_width (layout, layout_width);
211 limit_layout_lines (layout);
213 /* get again layout extents, they may have changed */
214 pango_layout_get_size (layout, &layout_width, &layout_height);
216 pixmap_width = layout_width / PANGO_SCALE + DRAG_ICON_LAYOUT_BORDER * 2;
217 pixmap_height = layout_height / PANGO_SCALE + DRAG_ICON_LAYOUT_BORDER * 2;
219 drawable = gdk_pixmap_new (widget->window,
224 gdk_draw_rectangle (drawable,
225 widget->style->base_gc [GTK_WIDGET_STATE (widget)],
231 gdk_draw_layout (drawable,
232 widget->style->text_gc [GTK_WIDGET_STATE (widget)],
233 1 + DRAG_ICON_LAYOUT_BORDER,
234 1 + DRAG_ICON_LAYOUT_BORDER,
237 gdk_draw_rectangle (drawable,
238 widget->style->black_gc,
244 g_object_unref (layout);
250 gtk_text_view_set_attributes_from_style (GtkTextView *text_view,
251 GtkTextAttributes *values,
254 values->appearance.bg_color = style->base[GTK_STATE_NORMAL];
255 values->appearance.fg_color = style->text[GTK_STATE_NORMAL];
258 pango_font_description_free (values->font);
260 values->font = pango_font_description_copy (style->font_desc);
264 _gtk_text_util_create_rich_drag_icon (GtkWidget *widget,
265 GtkTextBuffer *buffer,
269 GdkDrawable *drawable = NULL;
270 gint pixmap_height, pixmap_width;
271 gint layout_width, layout_height;
272 GtkTextBuffer *new_buffer;
273 GtkTextLayout *layout;
274 GtkTextAttributes *style;
275 PangoContext *ltr_context, *rtl_context;
278 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
279 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
280 g_return_val_if_fail (start != NULL, NULL);
281 g_return_val_if_fail (end != NULL, NULL);
283 new_buffer = gtk_text_buffer_new (gtk_text_buffer_get_tag_table (buffer));
284 gtk_text_buffer_get_start_iter (new_buffer, &iter);
286 gtk_text_buffer_insert_range (new_buffer, &iter, start, end);
288 gtk_text_buffer_get_start_iter (new_buffer, &iter);
290 layout = gtk_text_layout_new ();
292 ltr_context = gtk_widget_create_pango_context (widget);
293 pango_context_set_base_dir (ltr_context, PANGO_DIRECTION_LTR);
294 rtl_context = gtk_widget_create_pango_context (widget);
295 pango_context_set_base_dir (rtl_context, PANGO_DIRECTION_RTL);
297 gtk_text_layout_set_contexts (layout, ltr_context, rtl_context);
299 g_object_unref (ltr_context);
300 g_object_unref (rtl_context);
302 style = gtk_text_attributes_new ();
304 layout_width = widget->allocation.width;
306 if (GTK_IS_TEXT_VIEW (widget))
308 gtk_widget_ensure_style (widget);
309 gtk_text_view_set_attributes_from_style (GTK_TEXT_VIEW (widget),
310 style, widget->style);
312 layout_width = layout_width
313 - gtk_text_view_get_border_window_size (GTK_TEXT_VIEW (widget), GTK_TEXT_WINDOW_LEFT)
314 - gtk_text_view_get_border_window_size (GTK_TEXT_VIEW (widget), GTK_TEXT_WINDOW_RIGHT);
317 style->direction = gtk_widget_get_direction (widget);
318 style->wrap_mode = PANGO_WRAP_WORD_CHAR;
320 gtk_text_layout_set_default_style (layout, style);
321 gtk_text_attributes_unref (style);
323 gtk_text_layout_set_buffer (layout, new_buffer);
324 gtk_text_layout_set_cursor_visible (layout, FALSE);
325 gtk_text_layout_set_screen_width (layout, layout_width);
327 gtk_text_layout_validate (layout, DRAG_ICON_MAX_HEIGHT);
328 gtk_text_layout_get_size (layout, &layout_width, &layout_height);
330 layout_width = MIN (layout_width, DRAG_ICON_MAX_WIDTH);
331 layout_height = MIN (layout_height, DRAG_ICON_MAX_HEIGHT);
333 pixmap_width = layout_width + DRAG_ICON_LAYOUT_BORDER * 2;
334 pixmap_height = layout_height + DRAG_ICON_LAYOUT_BORDER * 2;
336 drawable = gdk_pixmap_new (widget->window,
337 pixmap_width + 2, pixmap_height + 2, -1);
339 gdk_draw_rectangle (drawable,
340 widget->style->base_gc [GTK_WIDGET_STATE (widget)],
346 gtk_text_layout_draw (layout, widget, drawable,
347 widget->style->text_gc [GTK_WIDGET_STATE (widget)],
348 - (1 + DRAG_ICON_LAYOUT_BORDER),
349 - (1 + DRAG_ICON_LAYOUT_BORDER),
351 pixmap_width, pixmap_height, NULL);
353 gdk_draw_rectangle (drawable,
354 widget->style->black_gc,
360 g_object_unref (layout);
361 g_object_unref (new_buffer);
368 layout_get_char_width (PangoLayout *layout)
371 PangoFontMetrics *metrics;
372 const PangoFontDescription *font_desc;
373 PangoContext *context = pango_layout_get_context (layout);
375 font_desc = pango_layout_get_font_description (layout);
377 font_desc = pango_context_get_font_description (context);
379 metrics = pango_context_get_metrics (context, font_desc, NULL);
380 width = pango_font_metrics_get_approximate_char_width (metrics);
381 pango_font_metrics_unref (metrics);
387 * _gtk_text_util_get_block_cursor_location
388 * @layout: a #PangoLayout
389 * @index: index at which cursor is located
390 * @rect: cursor location
392 * Returns: whether cursor should actually be drawn as a rectangle.
393 * It may not be the case if character at index is invisible.
396 _gtk_text_util_get_block_cursor_location (PangoLayout *layout,
399 gboolean *at_line_end)
401 PangoRectangle strong_pos, weak_pos;
402 PangoLayoutLine *layout_line;
406 g_return_val_if_fail (layout != NULL, FALSE);
407 g_return_val_if_fail (index >= 0, FALSE);
408 g_return_val_if_fail (pos != NULL, FALSE);
410 pango_layout_index_to_pos (layout, index, pos);
414 /* cursor is at some visible character, good */
416 *at_line_end = FALSE;
419 pos->x += pos->width;
420 pos->width = -pos->width;
425 pango_layout_index_to_line_x (layout, index, FALSE, &line_no, NULL);
426 g_return_val_if_fail (line_no >= 0, FALSE);
427 layout_line = pango_layout_get_line_readonly (layout, line_no);
429 /* end of layout, get last line */
433 layout_line = pango_layout_get_line_readonly (layout, line_no);
436 g_return_val_if_fail (layout_line != NULL, FALSE);
438 if (index < layout_line->start_index + layout_line->length)
440 /* cursor points to some zero-width character, do not
441 * bother with block cursor */
445 /* Cursor is at the line end. It may be an empty line, or it could
446 * be on the left or on the right depending on text direction, or it
447 * even could be in the middle of visual layout in bidi text. */
449 pango_layout_get_cursor_pos (layout, index, &strong_pos, &weak_pos);
451 if (strong_pos.x != weak_pos.x)
453 /* do not show block cursor in this case, since the character typed
454 * in may or may not appear at the cursor position */
458 /* In case when index points to the end of line, pos->x is always most right
459 * pixel of the layout line, so we need to correct it for RTL text. */
460 if (layout_line->length)
466 text = pango_layout_get_text (layout);
467 p = g_utf8_prev_char (text + index);
469 pango_layout_line_index_to_x (layout_line, p - text, FALSE, &left);
470 pango_layout_line_index_to_x (layout_line, p - text, TRUE, &right);
472 if (MIN (left, right) <= 0)
474 /* last character is on the left, RTL */
476 PangoLayoutIter *iter;
477 PangoRectangle line_rect;
480 iter = pango_layout_get_iter (layout);
481 for (i = 0; i < line_no; i++)
482 pango_layout_iter_next_line (iter);
483 pango_layout_iter_get_line_extents (iter, NULL, &line_rect);
484 pango_layout_iter_free (iter);
487 pos->x = MIN (left, right) + line_rect.x;
494 PangoContext *context = pango_layout_get_context (layout);
495 rtl = pango_context_get_base_dir (context) == PANGO_DIRECTION_RTL;
498 pos->width = layout_get_char_width (layout);
501 pos->x -= pos->width - 1;
506 return pos->width != 0;