2 * This file is a part of hildon
4 * Copyright (C) 2008, 2009 Nokia Corporation, all rights reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser Public License as published by
8 * the Free Software Foundation; version 2 of the license.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Lesser Public License for more details.
18 * SECTION:hildon-text-view
19 * @short_description: Text view within the Hildon framework.
21 * The #HildonTextView is a text
22 * view derived from the #GtkTextView widget that provides
23 * additional commodities specific to the Hildon framework.
25 * A #HildonTextView can also have a placeholder text. This text will
26 * be shown if the text view is empty and doesn't have the input
27 * focus, but it's otherwise ignored. Thus, calls to
28 * gtk_text_view_get_buffer() will never return the placeholder text,
29 * not even when it's being displayed.
32 * <title>Creating a HildonTextView with a placeholder</title>
35 * create_text_view (void)
37 * GtkWidget *text_view;
39 * text_view = hildon_text_view_new ();
40 * hildon_gtk_text_view_set_placeholder_text (GTK_TEXT_VIEW (text_view),
41 * "Type some text here");
49 #include "hildon-text-view.h"
52 #define HILDON_TEXT_VIEW_DRAG_THRESHOLD 16.0
54 G_DEFINE_TYPE (HildonTextView, hildon_text_view, GTK_TYPE_TEXT_VIEW);
56 #define HILDON_TEXT_VIEW_GET_PRIVATE(obj) \
57 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
58 HILDON_TYPE_TEXT_VIEW, HildonTextViewPrivate));
60 typedef struct _HildonTextViewPrivate HildonTextViewPrivate;
62 struct _HildonTextViewPrivate
64 gdouble x; /* tap x position */
65 gdouble y; /* tap y position */
70 * hildon_text_view_set_buffer:
71 * @text_view: a #HildonTextView
72 * @buffer: a #GtkTextBuffer
74 * Sets @buffer as the buffer being displayed by @text_view. The
75 * previous buffer displayed by the text view is unreferenced, and a
76 * reference is added to @buffer. If you owned a reference to @buffer
77 * before passing it to this function, you must remove that reference
82 * Deprecated: use gtk_text_view_set_buffer() instead
85 hildon_text_view_set_buffer (HildonTextView *text_view,
86 GtkTextBuffer *buffer)
88 g_return_if_fail (HILDON_IS_TEXT_VIEW (text_view));
89 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
90 gtk_text_view_set_buffer (GTK_TEXT_VIEW (text_view), buffer);
94 * hildon_text_view_get_buffer:
95 * @text_view: a #HildonTextView
97 * Returns the text buffer in @text_view. The reference count is not
98 * incremented; the caller of this function won't own a new reference.
100 * Note that the placeholder text (set using
101 * hildon_gtk_text_view_set_placeholder_text()) is never contained in
104 * Returns: a #GtkTextBuffer
108 * Deprecated: use gtk_text_view_get_buffer() instead
111 hildon_text_view_get_buffer (HildonTextView *text_view)
113 g_return_val_if_fail (HILDON_IS_TEXT_VIEW (text_view), NULL);
114 return gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
118 * hildon_text_view_set_placeholder:
119 * @text_view: a #HildonTextView
120 * @text: the new text
122 * Sets the placeholder text in @text_view to @text.
126 * Deprecated: use hildon_gtk_text_view_set_placeholder_text() instead
129 hildon_text_view_set_placeholder (HildonTextView *text_view,
132 g_return_if_fail (HILDON_IS_TEXT_VIEW (text_view) && text != NULL);
133 hildon_gtk_text_view_set_placeholder_text (GTK_TEXT_VIEW (text_view), text);
137 * hildon_text_view_new:
139 * Creates a new text view.
141 * Returns: a new #HildonTextView
146 hildon_text_view_new (void)
148 GtkWidget *entry = g_object_new (HILDON_TYPE_TEXT_VIEW, NULL);
154 hildon_text_view_button_press_event (GtkWidget *widget,
155 GdkEventButton *event)
157 HildonTextViewPrivate *priv = HILDON_TEXT_VIEW_GET_PRIVATE (widget);
159 gtk_widget_grab_focus (widget);
161 if (GTK_TEXT_VIEW (widget)->editable &&
162 hildon_gtk_im_context_filter_event (GTK_TEXT_VIEW (widget)->im_context, (GdkEvent*)event)) {
163 GTK_TEXT_VIEW (widget)->need_im_reset = TRUE;
167 if (event->button == 1 && event->type == GDK_BUTTON_PRESS) {
178 hildon_text_view_button_release_event (GtkWidget *widget,
179 GdkEventButton *event)
181 GtkTextView *text_view = GTK_TEXT_VIEW (widget);
182 HildonTextViewPrivate *priv = HILDON_TEXT_VIEW_GET_PRIVATE (widget);
186 if (text_view->editable &&
187 hildon_gtk_im_context_filter_event (text_view->im_context, (GdkEvent*)event)) {
188 text_view->need_im_reset = TRUE;
192 if (event->button == 1 && event->type == GDK_BUTTON_RELEASE) {
193 if (fabs (priv->x - event->x) < HILDON_TEXT_VIEW_DRAG_THRESHOLD &&
194 fabs (priv->y - event->y) < HILDON_TEXT_VIEW_DRAG_THRESHOLD) {
195 GtkTextWindowType window_type;
196 GtkTextBuffer *buffer;
198 window_type = gtk_text_view_get_window_type (text_view, event->window);
199 gtk_text_view_window_to_buffer_coords (text_view,
203 gtk_text_view_get_iter_at_location (text_view, &iter, x, y);
204 buffer = gtk_text_view_get_buffer (text_view);
205 if (gtk_text_buffer_get_char_count (buffer))
206 gtk_text_buffer_place_cursor (buffer, &iter);
208 gtk_widget_grab_focus (GTK_WIDGET (text_view));
217 hildon_text_view_class_init (HildonTextViewClass *klass)
219 GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
221 widget_class->motion_notify_event = NULL;
222 widget_class->button_press_event = hildon_text_view_button_press_event;
223 widget_class->button_release_event = hildon_text_view_button_release_event;
225 g_type_class_add_private (klass, sizeof (HildonTextViewPrivate));
228 hildon_text_view_init (HildonTextView *self)