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