gtk.CellEditableIF source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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 General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19  
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 /*
25  * Conversion parameters:
26  * inFile  = GtkCellEditable.html
27  * outPack = gtk
28  * outFile = CellEditableIF
29  * strct   = GtkCellEditable
30  * realStrct=
31  * ctorStrct=
32  * clss    = CellEditableT
33  * interf  = CellEditableIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_cell_editable_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- gdk.Event
47  * structWrap:
48  * 	- GdkEvent* -> Event
49  * module aliases:
50  * local aliases:
51  * overrides:
52  */
53 
54 module gtk.CellEditableIF;
55 
56 public  import gtkc.gtktypes;
57 
58 private import gtkc.gtk;
59 private import glib.ConstructionException;
60 private import gobject.ObjectG;
61 
62 private import gobject.Signals;
63 public  import gtkc.gdktypes;
64 
65 private import gdk.Event;
66 
67 
68 
69 
70 /**
71  * The GtkCellEditable interface must be implemented for widgets to be usable
72  * when editing the contents of a GtkTreeView cell.
73  */
74 public interface CellEditableIF
75 {
76 	
77 	
78 	public GtkCellEditable* getCellEditableTStruct();
79 	
80 	/** the main Gtk struct as a void* */
81 	protected void* getStruct();
82 	
83 	
84 	/**
85 	 */
86 	
87 	@property void delegate(CellEditableIF)[] onEditingDoneListeners();
88 	/**
89 	 * This signal is a sign for the cell renderer to update its
90 	 * value from the cell_editable.
91 	 * Implementations of GtkCellEditable are responsible for
92 	 * emitting this signal when they are done editing, e.g.
93 	 * GtkEntry is emitting it when the user presses Enter.
94 	 * gtk_cell_editable_editing_done() is a convenience method
95 	 * for emitting "editing-done".
96 	 */
97 	void addOnEditingDone(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
98 	@property void delegate(CellEditableIF)[] onRemoveWidgetListeners();
99 	/**
100 	 * This signal is meant to indicate that the cell is finished
101 	 * editing, and the widget may now be destroyed.
102 	 * Implementations of GtkCellEditable are responsible for
103 	 * emitting this signal when they are done editing. It must
104 	 * be emitted after the "editing-done" signal,
105 	 * to give the cell renderer a chance to update the cell's value
106 	 * before the widget is removed.
107 	 * gtk_cell_editable_remove_widget() is a convenience method
108 	 * for emitting "remove-widget".
109 	 * See Also
110 	 * GtkEntry, GtkCellRenderer
111 	 */
112 	void addOnRemoveWidget(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
113 	
114 	/**
115 	 * Begins editing on a cell_editable. event is the GdkEvent that began
116 	 * the editing process. It may be NULL, in the instance that editing was
117 	 * initiated through programatic means.
118 	 * Params:
119 	 * event = A GdkEvent, or NULL. [allow-none]
120 	 */
121 	public void startEditing(Event event);
122 	
123 	/**
124 	 * Emits the "editing-done" signal.
125 	 */
126 	public void editingDone();
127 	
128 	/**
129 	 * Emits the "remove-widget" signal.
130 	 */
131 	public void removeWidget();
132 }