gtkeditable.c 14 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
12
 * Lesser General Public License for more details.
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21 22 23 24
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

25 26 27 28 29 30
/**
 * SECTION:gtkeditable
 * @Short_description: Interface for text-editing widgets
 * @Title: GtkEditable
 *
 * The #GtkEditable interface is an interface which should be implemented by
31
 * text editing widgets, such as #GtkEntry and #GtkSpinButton. It contains functions
32 33 34 35 36
 * for generically manipulating an editable widget, a large number of action
 * signals used for key bindings, and several signals that an application can
 * connect to to modify the behavior of a widget.
 *
 * As an example of the latter usage, by connecting
37
 * the following handler to #GtkEditable::insert-text, an application
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 * can convert all entry into a widget into uppercase.
 *
 * <example>
 * <title>Forcing entry to uppercase.</title>
 * <programlisting>
 * #include &lt;ctype.h&gt;
 *
 * void
 * insert_text_handler (GtkEditable &ast;editable,
 *                      const gchar &ast;text,
 *                      gint         length,
 *                      gint        &ast;position,
 *                      gpointer     data)
 * {
 *   gchar &ast;result = g_utf8_strup (text, length);
 *
 *   g_signal_handlers_block_by_func (editable,
 *                                (gpointer) insert_text_handler, data);
 *   gtk_editable_insert_text (editable, result, length, position);
 *   g_signal_handlers_unblock_by_func (editable,
 *                                      (gpointer) insert_text_handler, data);
 *
 *   g_signal_stop_emission_by_name (editable, "insert_text");
 *
 *   g_free (result);
 * }
 * </programlisting>
 * </example>
 */

68
#include "config.h"
69
#include <string.h>
Owen Taylor's avatar
Owen Taylor committed
70

71
#include "gtkeditable.h"
72
#include "gtkmarshalers.h"
Matthias Clasen's avatar
Matthias Clasen committed
73
#include "gtkintl.h"
74

75

Matthias Clasen's avatar
Matthias Clasen committed
76
static void gtk_editable_base_init (gpointer g_class);
77 78


Manish Singh's avatar
Manish Singh committed
79
GType
80
gtk_editable_get_type (void)
81
{
Manish Singh's avatar
Manish Singh committed
82
  static GType editable_type = 0;
83 84 85

  if (!editable_type)
    {
86
      const GTypeInfo editable_info =
87
      {
88
	sizeof (GtkEditableInterface),  /* class_size */
89
	gtk_editable_base_init,	    /* base_init */
Owen Taylor's avatar
Owen Taylor committed
90
	NULL,			    /* base_finalize */
91 92
      };

Matthias Clasen's avatar
Matthias Clasen committed
93
      editable_type = g_type_register_static (G_TYPE_INTERFACE, I_("GtkEditable"),
Manish Singh's avatar
Manish Singh committed
94
					      &editable_info, 0);
95 96 97 98 99
    }

  return editable_type;
}

100 101 102 103 104 105 106
static void
gtk_editable_base_init (gpointer g_class)
{
  static gboolean initialized = FALSE;

  if (! initialized)
    {
Matthias Clasen's avatar
Matthias Clasen committed
107 108 109 110 111 112
      /**
       * GtkEditable::insert-text:
       * @editable: the object which received the signal
       * @new_text: the new text to insert
       * @new_text_length: the length of the new text, in bytes,
       *     or -1 if new_text is nul-terminated
113 114 115 116
       * @position: (inout) (type int): the position, in characters,
       *     at which to insert the new text. this is an in-out
       *     parameter.  After the signal emission is finished, it
       *     should point after the newly inserted text.
Matthias Clasen's avatar
Matthias Clasen committed
117 118 119 120 121 122 123 124 125
       *
       * This signal is emitted when text is inserted into
       * the widget by the user. The default handler for
       * this signal will normally be responsible for inserting
       * the text, so by connecting to this signal and then
       * stopping the signal with g_signal_stop_emission(), it
       * is possible to modify the inserted text, or prevent
       * it from being inserted entirely.
       */
126
      g_signal_new (I_("insert-text"),
127 128
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
129
		    G_STRUCT_OFFSET (GtkEditableInterface, insert_text),
130
		    NULL, NULL,
131
		    _gtk_marshal_VOID__STRING_INT_POINTER,
132
		    G_TYPE_NONE, 3,
Manish Singh's avatar
Manish Singh committed
133 134 135
		    G_TYPE_STRING,
		    G_TYPE_INT,
		    G_TYPE_POINTER);
Matthias Clasen's avatar
Matthias Clasen committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

      /**
       * GtkEditable::delete-text:
       * @editable: the object which received the signal
       * @start_pos: the starting position
       * @end_pos: the end position
       * 
       * This signal is emitted when text is deleted from
       * the widget by the user. The default handler for
       * this signal will normally be responsible for deleting
       * the text, so by connecting to this signal and then
       * stopping the signal with g_signal_stop_emission(), it
       * is possible to modify the range of deleted text, or
       * prevent it from being deleted entirely. The @start_pos
       * and @end_pos parameters are interpreted as for
       * gtk_editable_delete_text().
       */
153
      g_signal_new (I_("delete-text"),
154 155
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
156
		    G_STRUCT_OFFSET (GtkEditableInterface, delete_text),
157
		    NULL, NULL,
158
		    _gtk_marshal_VOID__INT_INT,
Manish Singh's avatar
Manish Singh committed
159 160 161
		    G_TYPE_NONE, 2,
		    G_TYPE_INT,
		    G_TYPE_INT);
Matthias Clasen's avatar
Matthias Clasen committed
162 163 164 165 166 167 168 169 170 171 172 173 174
      /**
       * GtkEditable::changed:
       * @editable: the object which received the signal
       *
       * The ::changed signal is emitted at the end of a single
       * user-visible operation on the contents of the #GtkEditable.
       *
       * E.g., a paste operation that replaces the contents of the
       * selection will cause only one signal emission (even though it
       * is implemented by first deleting the selection, then inserting
       * the new content, and may cause multiple ::notify::text signals
       * to be emitted).
       */ 
Matthias Clasen's avatar
Matthias Clasen committed
175
      g_signal_new (I_("changed"),
176 177
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
178
		    G_STRUCT_OFFSET (GtkEditableInterface, changed),
179
		    NULL, NULL,
180
		    _gtk_marshal_VOID__VOID,
Manish Singh's avatar
Manish Singh committed
181
		    G_TYPE_NONE, 0);
182 183 184 185 186

      initialized = TRUE;
    }
}

187 188 189 190
/**
 * gtk_editable_insert_text:
 * @editable: a #GtkEditable
 * @new_text: the text to append
191
 * @new_text_length: the length of the text in bytes, or -1
192
 * @position: (inout): location of the position text will be inserted at
Matthias Clasen's avatar
Matthias Clasen committed
193
 *
194 195
 * Inserts @new_text_length bytes of @new_text into the contents of the
 * widget, at position @position.
196
 *
Matthias Clasen's avatar
Matthias Clasen committed
197 198
 * Note that the position is in characters, not in bytes. 
 * The function updates @position to point after the newly inserted text.
199 200
 *
 * Virtual: do_insert_text
Matthias Clasen's avatar
Matthias Clasen committed
201
 */
202 203 204
void
gtk_editable_insert_text (GtkEditable *editable,
			  const gchar *new_text,
205 206
			  gint         new_text_length,
			  gint        *position)
207 208
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));
Owen Taylor's avatar
Owen Taylor committed
209
  g_return_if_fail (position != NULL);
Owen Taylor's avatar
Owen Taylor committed
210

211 212 213
  if (new_text_length < 0)
    new_text_length = strlen (new_text);
  
214
  GTK_EDITABLE_GET_IFACE (editable)->do_insert_text (editable, new_text, new_text_length, position);
215 216
}

217 218 219 220 221 222
/**
 * gtk_editable_delete_text:
 * @editable: a #GtkEditable
 * @start_pos: start position
 * @end_pos: end position
 *
Matthias Clasen's avatar
Matthias Clasen committed
223 224 225 226 227 228
 * Deletes a sequence of characters. The characters that are deleted are 
 * those characters at positions from @start_pos up to, but not including 
 * @end_pos. If @end_pos is negative, then the the characters deleted
 * are those from @start_pos to the end of the text.
 *
 * Note that the positions are specified in characters, not bytes.
229 230
 *
 * Virtual: do_delete_text
Matthias Clasen's avatar
Matthias Clasen committed
231
 */
232 233
void
gtk_editable_delete_text (GtkEditable *editable,
234 235
			  gint         start_pos,
			  gint         end_pos)
236 237 238
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

239
  GTK_EDITABLE_GET_IFACE (editable)->do_delete_text (editable, start_pos, end_pos);
240 241
}

242 243 244
/**
 * gtk_editable_get_chars:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
245 246
 * @start_pos: start of text
 * @end_pos: end of text
247
 *
Matthias Clasen's avatar
Matthias Clasen committed
248 249 250 251 252
 * Retrieves a sequence of characters. The characters that are retrieved 
 * are those characters at positions from @start_pos up to, but not 
 * including @end_pos. If @end_pos is negative, then the the characters 
 * retrieved are those characters from @start_pos to the end of the text.
 * 
253 254 255 256 257
 * Note that positions are specified in characters, not bytes.
 *
 * Return value: a pointer to the contents of the widget as a
 *      string. This string is allocated by the #GtkEditable
 *      implementation and should be freed by the caller.
Matthias Clasen's avatar
Matthias Clasen committed
258
 */
259
gchar *    
Owen Taylor's avatar
Owen Taylor committed
260
gtk_editable_get_chars (GtkEditable *editable,
Matthias Clasen's avatar
Matthias Clasen committed
261 262
			gint         start_pos,
			gint         end_pos)
263
{
264
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), NULL);
265

266
  return GTK_EDITABLE_GET_IFACE (editable)->get_chars (editable, start_pos, end_pos);
267 268
}

269 270 271
/**
 * gtk_editable_set_position:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
272
 * @position: the position of the cursor 
273 274
 *
 * Sets the cursor position in the editable to the given value.
Matthias Clasen's avatar
Matthias Clasen committed
275 276 277 278 279 280 281
 *
 * The cursor is displayed before the character with the given (base 0) 
 * index in the contents of the editable. The value must be less than or 
 * equal to the number of characters in the editable. A value of -1 
 * indicates that the position should be set after the last character 
 * of the editable. Note that @position is in characters, not in bytes.
 */
Owen Taylor's avatar
Owen Taylor committed
282
void
Tim Janik's avatar
Tim Janik committed
283 284
gtk_editable_set_position (GtkEditable      *editable,
			   gint              position)
Owen Taylor's avatar
Owen Taylor committed
285 286 287
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

288
  GTK_EDITABLE_GET_IFACE (editable)->set_position (editable, position);
Owen Taylor's avatar
Owen Taylor committed
289 290
}

291 292 293 294 295
/**
 * gtk_editable_get_position:
 * @editable: a #GtkEditable
 *
 * Retrieves the current position of the cursor relative to the start
Matthias Clasen's avatar
Matthias Clasen committed
296 297 298
 * of the content of the editable. 
 * 
 * Note that this position is in characters, not in bytes.
299 300
 *
 * Return value: the cursor position
Matthias Clasen's avatar
Matthias Clasen committed
301
 */
Owen Taylor's avatar
Owen Taylor committed
302
gint
303
gtk_editable_get_position (GtkEditable *editable)
Owen Taylor's avatar
Owen Taylor committed
304
{
Owen Taylor's avatar
Owen Taylor committed
305
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), 0);
Owen Taylor's avatar
Owen Taylor committed
306

307
  return GTK_EDITABLE_GET_IFACE (editable)->get_position (editable);
308 309
}

310 311 312
/**
 * gtk_editable_get_selection_bounds:
 * @editable: a #GtkEditable
313 314
 * @start_pos: (out) (allow-none): location to store the starting position, or %NULL
 * @end_pos: (out) (allow-none): location to store the end position, or %NULL
315
 *
Matthias Clasen's avatar
Matthias Clasen committed
316
 * Retrieves the selection bound of the editable. start_pos will be filled
317 318
 * with the start of the selection and @end_pos with end. If no text was
 * selected both will be identical and %FALSE will be returned.
319
 *
Matthias Clasen's avatar
Matthias Clasen committed
320
 * Note that positions are specified in characters, not bytes.
321
 *
Matthias Clasen's avatar
Matthias Clasen committed
322 323
 * Return value: %TRUE if an area is selected, %FALSE otherwise
 */
Owen Taylor's avatar
Owen Taylor committed
324 325 326 327
gboolean
gtk_editable_get_selection_bounds (GtkEditable *editable,
				   gint        *start_pos,
				   gint        *end_pos)
328
{
Owen Taylor's avatar
Owen Taylor committed
329 330
  gint tmp_start, tmp_end;
  gboolean result;
331
  
Owen Taylor's avatar
Owen Taylor committed
332
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), FALSE);
333

334
  result = GTK_EDITABLE_GET_IFACE (editable)->get_selection_bounds (editable, &tmp_start, &tmp_end);
335

Owen Taylor's avatar
Owen Taylor committed
336 337 338 339
  if (start_pos)
    *start_pos = MIN (tmp_start, tmp_end);
  if (end_pos)
    *end_pos = MAX (tmp_start, tmp_end);
340

Owen Taylor's avatar
Owen Taylor committed
341
  return result;
342 343
}

344 345 346 347 348
/**
 * gtk_editable_delete_selection:
 * @editable: a #GtkEditable
 *
 * Deletes the currently selected text of the editable.
Matthias Clasen's avatar
Matthias Clasen committed
349 350
 * This call doesn't do anything if there is no selected text.
 */
351 352 353
void
gtk_editable_delete_selection (GtkEditable *editable)
{
Owen Taylor's avatar
Owen Taylor committed
354
  gint start, end;
355

356 357
  g_return_if_fail (GTK_IS_EDITABLE (editable));

Owen Taylor's avatar
Owen Taylor committed
358 359
  if (gtk_editable_get_selection_bounds (editable, &start, &end))
    gtk_editable_delete_text (editable, start, end);
360 361
}

362 363 364
/**
 * gtk_editable_select_region:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
365 366
 * @start_pos: start of region
 * @end_pos: end of region
367
 *
Matthias Clasen's avatar
Matthias Clasen committed
368 369 370 371 372 373 374
 * Selects a region of text. The characters that are selected are 
 * those characters at positions from @start_pos up to, but not 
 * including @end_pos. If @end_pos is negative, then the the 
 * characters selected are those characters from @start_pos to 
 * the end of the text.
 * 
 * Note that positions are specified in characters, not bytes.
375 376
 *
 * Virtual: set_selection_bounds
Matthias Clasen's avatar
Matthias Clasen committed
377
 */
378 379
void
gtk_editable_select_region (GtkEditable *editable,
Matthias Clasen's avatar
Matthias Clasen committed
380 381
			    gint         start_pos,
			    gint         end_pos)
382
{
383 384
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
385
  GTK_EDITABLE_GET_IFACE (editable)->set_selection_bounds (editable, start_pos, end_pos);
386 387
}

388 389 390 391 392 393
/**
 * gtk_editable_cut_clipboard:
 * @editable: a #GtkEditable
 *
 * Removes the contents of the currently selected content in the editable and
 * puts it on the clipboard.
Matthias Clasen's avatar
Matthias Clasen committed
394
 */
395
void
396
gtk_editable_cut_clipboard (GtkEditable *editable)
397
{
398 399
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
400
  g_signal_emit_by_name (editable, "cut-clipboard");
401 402
}

403 404 405 406 407 408
/**
 * gtk_editable_copy_clipboard:
 * @editable: a #GtkEditable
 *
 * Copies the contents of the currently selected content in the editable and
 * puts it on the clipboard.
Matthias Clasen's avatar
Matthias Clasen committed
409
 */
410 411 412
void
gtk_editable_copy_clipboard (GtkEditable *editable)
{
413 414
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
415
  g_signal_emit_by_name (editable, "copy-clipboard");
416 417
}

418 419 420 421 422 423
/**
 * gtk_editable_paste_clipboard:
 * @editable: a #GtkEditable
 *
 * Pastes the content of the clipboard to the current position of the
 * cursor in the editable.
Matthias Clasen's avatar
Matthias Clasen committed
424
 */
425
void
426
gtk_editable_paste_clipboard (GtkEditable *editable)
427
{
428 429
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
430
  g_signal_emit_by_name (editable, "paste-clipboard");
431 432
}

433 434 435 436 437 438 439 440
/**
 * gtk_editable_set_editable:
 * @editable: a #GtkEditable
 * @is_editable: %TRUE if the user is allowed to edit the text
 *   in the widget
 *
 * Determines if the user can edit the text in the editable
 * widget or not. 
Matthias Clasen's avatar
Matthias Clasen committed
441
 */
442 443 444 445 446 447
void
gtk_editable_set_editable (GtkEditable    *editable,
			   gboolean        is_editable)
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

448
  g_object_set (editable,
Manish Singh's avatar
Manish Singh committed
449 450
		"editable", is_editable != FALSE,
		NULL);
451
}
452 453 454 455 456 457 458 459 460

/**
 * gtk_editable_get_editable:
 * @editable: a #GtkEditable
 *
 * Retrieves whether @editable is editable. See
 * gtk_editable_set_editable().
 *
 * Return value: %TRUE if @editable is editable.
Matthias Clasen's avatar
Matthias Clasen committed
461
 */
462 463 464 465 466 467 468
gboolean
gtk_editable_get_editable (GtkEditable *editable)
{
  gboolean value;

  g_return_val_if_fail (GTK_IS_EDITABLE (editable), FALSE);

469
  g_object_get (editable, "editable", &value, NULL);
470 471 472

  return value;
}