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 module atk.TableCellIF;
26 
27 private import atk.ObjectAtk;
28 private import atk.c.functions;
29 public  import atk.c.types;
30 private import glib.PtrArray;
31 private import gobject.ObjectG;
32 
33 
34 /**
35  * Being #AtkTable a component which present elements ordered via rows
36  * and columns, an #AtkTableCell is the interface which each of those
37  * elements, so "cells" should implement.
38  * 
39  * See also #AtkTable.
40  */
41 public interface TableCellIF{
42 	/** Get the main Gtk struct */
43 	public AtkTableCell* getTableCellStruct(bool transferOwnership = false);
44 
45 	/** the main Gtk struct as a void* */
46 	protected void* getStruct();
47 
48 
49 	/** */
50 	public static GType getType()
51 	{
52 		return atk_table_cell_get_type();
53 	}
54 
55 	/**
56 	 * Returns the column headers as an array of cell accessibles.
57 	 *
58 	 * Returns: a GPtrArray of AtkObjects
59 	 *     representing the column header cells.
60 	 *
61 	 * Since: 2.12
62 	 */
63 	public PtrArray getColumnHeaderCells();
64 
65 	/**
66 	 * Returns the number of columns occupied by this cell accessible.
67 	 *
68 	 * Returns: a gint representing the number of columns occupied by this cell,
69 	 *     or 0 if the cell does not implement this method.
70 	 *
71 	 * Since: 2.12
72 	 */
73 	public int getColumnSpan();
74 
75 	/**
76 	 * Retrieves the tabular position of this cell.
77 	 *
78 	 * Params:
79 	 *     row = the row of the given cell.
80 	 *     column = the column of the given cell.
81 	 *
82 	 * Returns: TRUE if successful; FALSE otherwise.
83 	 *
84 	 * Since: 2.12
85 	 */
86 	public bool getPosition(out int row, out int column);
87 
88 	/**
89 	 * Gets the row and column indexes and span of this cell accessible.
90 	 *
91 	 * Note: If the object does not implement this function, then, by default, atk
92 	 * will implement this function by calling get_row_span and get_column_span
93 	 * on the object.
94 	 *
95 	 * Params:
96 	 *     row = the row index of the given cell.
97 	 *     column = the column index of the given cell.
98 	 *     rowSpan = the number of rows occupied by this cell.
99 	 *     columnSpan = the number of columns occupied by this cell.
100 	 *
101 	 * Returns: TRUE if successful; FALSE otherwise.
102 	 *
103 	 * Since: 2.12
104 	 */
105 	public bool getRowColumnSpan(out int row, out int column, out int rowSpan, out int columnSpan);
106 
107 	/**
108 	 * Returns the row headers as an array of cell accessibles.
109 	 *
110 	 * Returns: a GPtrArray of AtkObjects
111 	 *     representing the row header cells.
112 	 *
113 	 * Since: 2.12
114 	 */
115 	public PtrArray getRowHeaderCells();
116 
117 	/**
118 	 * Returns the number of rows occupied by this cell accessible.
119 	 *
120 	 * Returns: a gint representing the number of rows occupied by this cell,
121 	 *     or 0 if the cell does not implement this method.
122 	 *
123 	 * Since: 2.12
124 	 */
125 	public int getRowSpan();
126 
127 	/**
128 	 * Returns a reference to the accessible of the containing table.
129 	 *
130 	 * Returns: the atk object for the containing table.
131 	 *
132 	 * Since: 2.12
133 	 */
134 	public ObjectAtk getTable();
135 }