gtk2/gtk/gtkcelleditable.c
Johan Dahlin eee7bb2b2e [annotations] Add allow-none
This commit was created using a script that searched for all docstrings
containing a parameter and the string 'or %NULL'.
Gdk backends and demos excluded as they are not part of a public API

https://bugzilla.gnome.org/show_bug.cgi?id=610474
2010-04-03 20:56:15 -04:00

178 lines
5.7 KiB
C

/* 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
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include "gtkcelleditable.h"
#include "gtkmarshalers.h"
#include "gtkprivate.h"
#include "gtkintl.h"
#include "gtkalias.h"
static void gtk_cell_editable_base_init (GtkCellEditableIface *iface);
GType
gtk_cell_editable_get_type (void)
{
static GType cell_editable_type = 0;
if (! cell_editable_type)
{
const GTypeInfo cell_editable_info =
{
sizeof (GtkCellEditableIface), /* class_size */
(GBaseInitFunc) gtk_cell_editable_base_init, /* base_init */
NULL, /* base_finalize */
NULL,
NULL, /* class_finalize */
NULL, /* class_data */
0,
0,
NULL
};
cell_editable_type =
g_type_register_static (G_TYPE_INTERFACE, I_("GtkCellEditable"),
&cell_editable_info, 0);
g_type_interface_add_prerequisite (cell_editable_type, GTK_TYPE_WIDGET);
}
return cell_editable_type;
}
static void
gtk_cell_editable_base_init (GtkCellEditableIface *iface)
{
static gboolean initialized = FALSE;
if (! initialized)
{
/**
* 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,
GTK_PARAM_READWRITE));
/**
* 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.
* #GtkEntry is emitting it when the user presses Enter.
*
* gtk_cell_editable_editing_done() is a convenience method
* for emitting ::editing-done.
*/
g_signal_new (I_("editing-done"),
GTK_TYPE_CELL_EDITABLE,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkCellEditableIface, editing_done),
NULL, NULL,
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
* GtkCellEditable::remove-widget:
* @cell_editable: the object on which the signal was emitted
*
* This signal is meant to indicate that the cell is finished
* editing, and the widget may now be destroyed.
*
* 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
* for emitting ::remove-widget.
*/
g_signal_new (I_("remove-widget"),
GTK_TYPE_CELL_EDITABLE,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkCellEditableIface, remove_widget),
NULL, NULL,
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
initialized = TRUE;
}
}
/**
* gtk_cell_editable_start_editing:
* @cell_editable: A #GtkCellEditable
* @event: (allow-none): A #GdkEvent, or %NULL
*
* Begins editing on a @cell_editable. @event is the #GdkEvent that began
* the editing process. It may be %NULL, in the instance that editing was
* initiated through programatic means.
**/
void
gtk_cell_editable_start_editing (GtkCellEditable *cell_editable,
GdkEvent *event)
{
g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));
(* GTK_CELL_EDITABLE_GET_IFACE (cell_editable)->start_editing) (cell_editable, event);
}
/**
* gtk_cell_editable_editing_done:
* @cell_editable: A #GtkTreeEditable
*
* Emits the #GtkCellEditable::editing-done signal.
**/
void
gtk_cell_editable_editing_done (GtkCellEditable *cell_editable)
{
g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));
g_signal_emit_by_name (cell_editable, "editing-done");
}
/**
* gtk_cell_editable_remove_widget:
* @cell_editable: A #GtkTreeEditable
*
* Emits the #GtkCellEditable::remove-widget signal.
**/
void
gtk_cell_editable_remove_widget (GtkCellEditable *cell_editable)
{
g_return_if_fail (GTK_IS_CELL_EDITABLE (cell_editable));
g_signal_emit_by_name (cell_editable, "remove-widget");
}
#define __GTK_CELL_EDITABLE_C__
#include "gtkaliasdef.c"