gtkeditable.c 12.4 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
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * 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/. 
 */

27
#include "config.h"
28
#include <string.h>
Owen Taylor's avatar
Owen Taylor committed
29

30
#include "gtkeditable.h"
31
#include "gtkmarshalers.h"
32
#include "gtkintl.h"
33
#include "gtkalias.h"
34

35

Matthias Clasen's avatar
Matthias Clasen committed
36
static void gtk_editable_base_init (gpointer g_class);
37 38


Manish Singh's avatar
Manish Singh committed
39
GType
40
gtk_editable_get_type (void)
41
{
Manish Singh's avatar
Manish Singh committed
42
  static GType editable_type = 0;
43 44 45

  if (!editable_type)
    {
46
      const GTypeInfo editable_info =
47
      {
Owen Taylor's avatar
Owen Taylor committed
48
	sizeof (GtkEditableClass),  /* class_size */
49
	gtk_editable_base_init,	    /* base_init */
Owen Taylor's avatar
Owen Taylor committed
50
	NULL,			    /* base_finalize */
51 52
      };

53
      editable_type = g_type_register_static (G_TYPE_INTERFACE, I_("GtkEditable"),
Manish Singh's avatar
Manish Singh committed
54
					      &editable_info, 0);
55 56 57 58 59
    }

  return editable_type;
}

60 61 62 63 64 65 66
static void
gtk_editable_base_init (gpointer g_class)
{
  static gboolean initialized = FALSE;

  if (! initialized)
    {
Matthias Clasen's avatar
Matthias Clasen committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
      /**
       * 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
       * @position: 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.
       *
       * 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.
       */
86
      g_signal_new (I_("insert-text"),
87 88 89 90
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
		    G_STRUCT_OFFSET (GtkEditableClass, insert_text),
		    NULL, NULL,
91
		    _gtk_marshal_VOID__STRING_INT_POINTER,
92
		    G_TYPE_NONE, 3,
Manish Singh's avatar
Manish Singh committed
93 94 95
		    G_TYPE_STRING,
		    G_TYPE_INT,
		    G_TYPE_POINTER);
Matthias Clasen's avatar
Matthias Clasen committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

      /**
       * 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().
       */
113
      g_signal_new (I_("delete-text"),
114 115 116 117
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
		    G_STRUCT_OFFSET (GtkEditableClass, delete_text),
		    NULL, NULL,
118
		    _gtk_marshal_VOID__INT_INT,
Manish Singh's avatar
Manish Singh committed
119 120 121
		    G_TYPE_NONE, 2,
		    G_TYPE_INT,
		    G_TYPE_INT);
Matthias Clasen's avatar
Matthias Clasen committed
122 123 124 125 126 127 128 129 130 131 132 133 134
      /**
       * 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).
       */ 
135
      g_signal_new (I_("changed"),
136 137 138 139
		    GTK_TYPE_EDITABLE,
		    G_SIGNAL_RUN_LAST,
		    G_STRUCT_OFFSET (GtkEditableClass, changed),
		    NULL, NULL,
140
		    _gtk_marshal_VOID__VOID,
Manish Singh's avatar
Manish Singh committed
141
		    G_TYPE_NONE, 0);
142 143 144 145 146

      initialized = TRUE;
    }
}

147 148 149 150
/**
 * gtk_editable_insert_text:
 * @editable: a #GtkEditable
 * @new_text: the text to append
151
 * @new_text_length: the length of the text in bytes, or -1
Matthias Clasen's avatar
Matthias Clasen committed
152 153 154 155
 * @position: location of the position text will be inserted at
 *
 * Inserts @new_text_length bytes of @new_text into the contents of the 
 * widget, at position @position. 
156
 *
Matthias Clasen's avatar
Matthias Clasen committed
157 158 159
 * Note that the position is in characters, not in bytes. 
 * The function updates @position to point after the newly inserted text.
 */
160 161 162
void
gtk_editable_insert_text (GtkEditable *editable,
			  const gchar *new_text,
163 164
			  gint         new_text_length,
			  gint        *position)
165 166
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));
Owen Taylor's avatar
Owen Taylor committed
167
  g_return_if_fail (position != NULL);
168

169 170 171
  if (new_text_length < 0)
    new_text_length = strlen (new_text);
  
172
  GTK_EDITABLE_GET_CLASS (editable)->do_insert_text (editable, new_text, new_text_length, position);
173 174
}

175 176 177 178 179 180
/**
 * gtk_editable_delete_text:
 * @editable: a #GtkEditable
 * @start_pos: start position
 * @end_pos: end position
 *
Matthias Clasen's avatar
Matthias Clasen committed
181 182 183 184 185 186 187
 * 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.
 */
188 189
void
gtk_editable_delete_text (GtkEditable *editable,
190 191
			  gint         start_pos,
			  gint         end_pos)
192 193 194
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

195
  GTK_EDITABLE_GET_CLASS (editable)->do_delete_text (editable, start_pos, end_pos);
196 197
}

198 199 200
/**
 * gtk_editable_get_chars:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
201 202
 * @start_pos: start of text
 * @end_pos: end of text
203
 *
Matthias Clasen's avatar
Matthias Clasen committed
204 205 206 207 208
 * 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.
 * 
209 210 211 212 213
 * 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
214
 */
215
gchar *    
Owen Taylor's avatar
Owen Taylor committed
216
gtk_editable_get_chars (GtkEditable *editable,
Matthias Clasen's avatar
Matthias Clasen committed
217 218
			gint         start_pos,
			gint         end_pos)
219
{
220
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), NULL);
221

Matthias Clasen's avatar
Matthias Clasen committed
222
  return GTK_EDITABLE_GET_CLASS (editable)->get_chars (editable, start_pos, end_pos);
223 224
}

225 226 227
/**
 * gtk_editable_set_position:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
228
 * @position: the position of the cursor 
229 230
 *
 * Sets the cursor position in the editable to the given value.
Matthias Clasen's avatar
Matthias Clasen committed
231 232 233 234 235 236 237
 *
 * 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
238
void
239 240
gtk_editable_set_position (GtkEditable      *editable,
			   gint              position)
Owen Taylor's avatar
Owen Taylor committed
241 242 243
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

Owen Taylor's avatar
Owen Taylor committed
244
  GTK_EDITABLE_GET_CLASS (editable)->set_position (editable, position);
Owen Taylor's avatar
Owen Taylor committed
245 246
}

247 248 249 250 251
/**
 * 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
252 253 254
 * of the content of the editable. 
 * 
 * Note that this position is in characters, not in bytes.
255 256
 *
 * Return value: the cursor position
Matthias Clasen's avatar
Matthias Clasen committed
257
 */
Owen Taylor's avatar
Owen Taylor committed
258
gint
259
gtk_editable_get_position (GtkEditable *editable)
Owen Taylor's avatar
Owen Taylor committed
260
{
Owen Taylor's avatar
Owen Taylor committed
261
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), 0);
Owen Taylor's avatar
Owen Taylor committed
262

Owen Taylor's avatar
Owen Taylor committed
263
  return GTK_EDITABLE_GET_CLASS (editable)->get_position (editable);
264 265
}

266 267 268
/**
 * gtk_editable_get_selection_bounds:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
269 270
 * @start_pos: location to store the starting position, or %NULL 
 * @end_pos: location to store the end position, or %NULL 
271
 *
Matthias Clasen's avatar
Matthias Clasen committed
272 273 274
 * Retrieves the selection bound of the editable. start_pos will be filled
 * 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. 
275
 *
Matthias Clasen's avatar
Matthias Clasen committed
276
 * Note that positions are specified in characters, not bytes.
277
 *
Matthias Clasen's avatar
Matthias Clasen committed
278 279
 * Return value: %TRUE if an area is selected, %FALSE otherwise
 */
Owen Taylor's avatar
Owen Taylor committed
280 281 282 283
gboolean
gtk_editable_get_selection_bounds (GtkEditable *editable,
				   gint        *start_pos,
				   gint        *end_pos)
284
{
Owen Taylor's avatar
Owen Taylor committed
285 286
  gint tmp_start, tmp_end;
  gboolean result;
287
  
Owen Taylor's avatar
Owen Taylor committed
288
  g_return_val_if_fail (GTK_IS_EDITABLE (editable), FALSE);
289

Owen Taylor's avatar
Owen Taylor committed
290
  result = GTK_EDITABLE_GET_CLASS (editable)->get_selection_bounds (editable, &tmp_start, &tmp_end);
291

Owen Taylor's avatar
Owen Taylor committed
292 293 294 295
  if (start_pos)
    *start_pos = MIN (tmp_start, tmp_end);
  if (end_pos)
    *end_pos = MAX (tmp_start, tmp_end);
296

Owen Taylor's avatar
Owen Taylor committed
297
  return result;
298 299
}

300 301 302 303 304
/**
 * gtk_editable_delete_selection:
 * @editable: a #GtkEditable
 *
 * Deletes the currently selected text of the editable.
Matthias Clasen's avatar
Matthias Clasen committed
305 306
 * This call doesn't do anything if there is no selected text.
 */
307 308 309
void
gtk_editable_delete_selection (GtkEditable *editable)
{
Owen Taylor's avatar
Owen Taylor committed
310
  gint start, end;
311

312 313
  g_return_if_fail (GTK_IS_EDITABLE (editable));

Owen Taylor's avatar
Owen Taylor committed
314 315
  if (gtk_editable_get_selection_bounds (editable, &start, &end))
    gtk_editable_delete_text (editable, start, end);
316 317
}

318 319 320
/**
 * gtk_editable_select_region:
 * @editable: a #GtkEditable
Matthias Clasen's avatar
Matthias Clasen committed
321 322
 * @start_pos: start of region
 * @end_pos: end of region
323
 *
Matthias Clasen's avatar
Matthias Clasen committed
324 325 326 327 328 329 330 331
 * 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.
 */
332 333
void
gtk_editable_select_region (GtkEditable *editable,
Matthias Clasen's avatar
Matthias Clasen committed
334 335
			    gint         start_pos,
			    gint         end_pos)
336
{
337 338
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
Matthias Clasen's avatar
Matthias Clasen committed
339
  GTK_EDITABLE_GET_CLASS (editable)->set_selection_bounds (editable, start_pos, end_pos);
340 341
}

342 343 344 345 346 347
/**
 * 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
348
 */
349
void
350
gtk_editable_cut_clipboard (GtkEditable *editable)
351
{
352 353
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
354
  g_signal_emit_by_name (editable, "cut-clipboard");
355 356
}

357 358 359 360 361 362
/**
 * 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
363
 */
364 365 366
void
gtk_editable_copy_clipboard (GtkEditable *editable)
{
367 368
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
369
  g_signal_emit_by_name (editable, "copy-clipboard");
370 371
}

372 373 374 375 376 377
/**
 * 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
378
 */
379
void
380
gtk_editable_paste_clipboard (GtkEditable *editable)
381
{
382 383
  g_return_if_fail (GTK_IS_EDITABLE (editable));
  
384
  g_signal_emit_by_name (editable, "paste-clipboard");
385 386
}

387 388 389 390 391 392 393 394
/**
 * 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
395
 */
396 397 398 399 400 401
void
gtk_editable_set_editable (GtkEditable    *editable,
			   gboolean        is_editable)
{
  g_return_if_fail (GTK_IS_EDITABLE (editable));

402
  g_object_set (editable,
Manish Singh's avatar
Manish Singh committed
403 404
		"editable", is_editable != FALSE,
		NULL);
405
}
406 407 408 409 410 411 412 413 414

/**
 * 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
415
 */
416 417 418 419 420 421 422
gboolean
gtk_editable_get_editable (GtkEditable *editable)
{
  gboolean value;

  g_return_val_if_fail (GTK_IS_EDITABLE (editable), FALSE);

423
  g_object_get (editable, "editable", &value, NULL);
424 425 426

  return value;
}
427 428 429

#define __GTK_EDITABLE_C__
#include "gtkaliasdef.c"