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