gtkcelleditable.c 5.51 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* gtkcelleditable.c
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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
/**
 * SECTION:gtkcelleditable
20
 * @Short_description: Interface for widgets that can be used for editing cells
21
 * @Title: GtkCellEditable
22
 * @See_also: #GtkCellRenderer
23 24
 *
 * The #GtkCellEditable interface must be implemented for widgets to be usable
25 26
 * to edit the contents of a #GtkTreeView cell. It provides a way to specify how
 * temporary widgets should be configured for editing, get the new value, etc.
27
 */
28

29
#include "config.h"
30
#include "gtkcelleditable.h"
31
#include "gtkmarshalers.h"
32
#include "gtkprivate.h"
33
#include "gtkintl.h"
34

35

36 37
typedef GtkCellEditableIface GtkCellEditableInterface;
G_DEFINE_INTERFACE(GtkCellEditable, gtk_cell_editable, GTK_TYPE_WIDGET)
38 39

static void
40
gtk_cell_editable_default_init (GtkCellEditableInterface *iface)
41
{
42 43 44 45 46 47 48 49 50 51 52 53
  /**
   * GtkCellEditable:editing-canceled:
   *
   * Indicates whether editing on the cell has been canceled.
   *
   * Since: 2.20
   */
  g_object_interface_install_property (iface,
                                       g_param_spec_boolean ("editing-canceled",
                                       P_("Editing Canceled"),
                                       P_("Indicates that editing has been canceled"),
                                       FALSE,
54
                                       GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
55

56 57 58 59 60 61 62 63 64
  /**
   * GtkCellEditable::editing-done:
   * @cell_editable: the object on which the signal was emitted
   *
   * This signal is a sign for the cell renderer to update its
   * value from the @cell_editable.
   *
   * Implementations of #GtkCellEditable are responsible for
   * emitting this signal when they are done editing, e.g.
65 66 67
   * #GtkEntry emits this signal when the user presses Enter. Typical things to
   * do in a handler for ::editing-done are to capture the edited value,
   * disconnect the @cell_editable from signals on the #GtkCellRenderer, etc.
68 69
   *
   * gtk_cell_editable_editing_done() is a convenience method
70
   * for emitting #GtkCellEditable::editing-done.
71 72 73 74 75 76
   */
  g_signal_new (I_("editing-done"),
                GTK_TYPE_CELL_EDITABLE,
                G_SIGNAL_RUN_LAST,
                G_STRUCT_OFFSET (GtkCellEditableIface, editing_done),
                NULL, NULL,
77
                NULL,
78
                G_TYPE_NONE, 0);
79

80 81 82 83 84
  /**
   * GtkCellEditable::remove-widget:
   * @cell_editable: the object on which the signal was emitted
   *
   * This signal is meant to indicate that the cell is finished
85 86
   * editing, and the @cell_editable widget is being removed and may
   * subsequently be destroyed.
87 88 89 90 91 92 93 94
   *
   * Implementations of #GtkCellEditable are responsible for
   * emitting this signal when they are done editing. It must
   * be emitted after the #GtkCellEditable::editing-done signal,
   * to give the cell renderer a chance to update the cell's value
   * before the widget is removed.
   *
   * gtk_cell_editable_remove_widget() is a convenience method
95
   * for emitting #GtkCellEditable::remove-widget.
96 97 98 99 100 101
   */
  g_signal_new (I_("remove-widget"),
                GTK_TYPE_CELL_EDITABLE,
                G_SIGNAL_RUN_LAST,
                G_STRUCT_OFFSET (GtkCellEditableIface, remove_widget),
                NULL, NULL,
102
                NULL,
103
                G_TYPE_NONE, 0);
104 105
}

Jonathan Blandford's avatar
Jonathan Blandford committed
106 107 108
/**
 * gtk_cell_editable_start_editing:
 * @cell_editable: A #GtkCellEditable
109 110
 * @event: (nullable): The #GdkEvent that began the editing process, or
 *   %NULL if editing was initiated programmatically
Jonathan Blandford's avatar
Jonathan Blandford committed
111
 * 
112
 * Begins editing on a @cell_editable.
113 114 115 116 117 118 119 120 121
 *
 * The #GtkCellRenderer for the cell creates and returns a #GtkCellEditable from
 * gtk_cell_renderer_start_editing(), configured for the #GtkCellRenderer type.
 *
 * gtk_cell_editable_start_editing() can then set up @cell_editable suitably for
 * editing a cell, e.g. making the Esc key emit #GtkCellEditable::editing-done.
 *
 * Note that the @cell_editable is created on-demand for the current edit; its
 * lifetime is temporary and does not persist across other edits and/or cells.
Jonathan Blandford's avatar
Jonathan Blandford committed
122
 **/
123 124 125 126
void
gtk_cell_editable_start_editing (GtkCellEditable *cell_editable,
				 GdkEvent        *event)
{
127
  g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));
128

129
  (* GTK_CELL_EDITABLE_GET_IFACE (cell_editable)->start_editing) (cell_editable, event);
130 131
}

Jonathan Blandford's avatar
Jonathan Blandford committed
132 133
/**
 * gtk_cell_editable_editing_done:
134
 * @cell_editable: A #GtkCellEditable
Jonathan Blandford's avatar
Jonathan Blandford committed
135
 * 
136
 * Emits the #GtkCellEditable::editing-done signal. 
Jonathan Blandford's avatar
Jonathan Blandford committed
137
 **/
138 139 140
void
gtk_cell_editable_editing_done (GtkCellEditable *cell_editable)
{
141 142
  g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));

143
  g_signal_emit_by_name (cell_editable, "editing-done");
144 145
}

Jonathan Blandford's avatar
Jonathan Blandford committed
146 147
/**
 * gtk_cell_editable_remove_widget:
148
 * @cell_editable: A #GtkCellEditable
Jonathan Blandford's avatar
Jonathan Blandford committed
149
 * 
150
 * Emits the #GtkCellEditable::remove-widget signal.  
Jonathan Blandford's avatar
Jonathan Blandford committed
151
 **/
152 153 154
void
gtk_cell_editable_remove_widget (GtkCellEditable *cell_editable)
{
155
  g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));
156

157
  g_signal_emit_by_name (cell_editable, "remove-widget");
158
}