------------------------------------------------------------------------------
-- --
-- Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet --
-- Copyright (C) 2000-2014, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify it --
-- under terms of the GNU General Public License as published by the Free --
-- Software Foundation; either version 3, 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 MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception, --
-- version 3.1, as published by the Free Software Foundation. --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
------------------------------------------------------------------------------
-- <description>
-- The Gtk.Table.Gtk_Table functions allow the programmer to arrange widgets
-- in rows and columns, making it easy to align many widgets next to each
-- other, horizontally and vertically.
--
-- Tables are created with a call to Gtk.Table.Gtk_New, the size of which can
-- later be changed with Gtk.Table.Resize.
--
-- Widgets can be added to a table using Gtk.Table.Attach or the more
-- convenient (but slightly less flexible) Gtk.Table.Attach_Defaults.
--
-- To alter the space next to a specific row, use Gtk.Table.Set_Row_Spacing,
-- and for a column, Gtk.Table.Set_Col_Spacing. The gaps between *all* rows or
-- columns can be changed by calling Gtk.Table.Set_Row_Spacings or
-- Gtk.Table.Set_Col_Spacings respectively. Note that spacing is added
-- *between* the children, while padding added by Gtk.Table.Attach is added
-- *on either side* of the widget it belongs to.
--
-- Gtk.Table.Set_Homogeneous, can be used to set whether all cells in the
-- table will resize themselves to the size of the largest widget in the
-- table.
--
-- Note: Gtk.Table.Gtk_Table has been deprecated. Use Gtk.Grid.Gtk_Grid
-- instead. It provides the same capabilities as GtkTable for arranging
-- widgets in a rectangular grid, but does support height-for-width geometry
-- management.
--
-- </description>
-- <group>Layout containers</group>
pragma Ada_2005;
pragma Warnings (Off, "*is already use-visible*");
with Glib; use Glib;
with Glib.Properties; use Glib.Properties;
with Glib.Types; use Glib.Types;
with Gtk.Buildable; use Gtk.Buildable;
with Gtk.Container; use Gtk.Container;
with Gtk.Enums; use Gtk.Enums;
with Gtk.Widget; use Gtk.Widget;
package Gtk.Table is
type Gtk_Table_Record is new Gtk_Container_Record with null record;
type Gtk_Table is access all Gtk_Table_Record'Class;
------------------
-- Constructors --
------------------
procedure Gtk_New
(Table : out Gtk_Table;
Rows : Guint;
Columns : Guint;
Homogeneous : Boolean);
procedure Initialize
(Table : not null access Gtk_Table_Record'Class;
Rows : Guint;
Columns : Guint;
Homogeneous : Boolean);
-- Create a new table. The width allocated to the table is divided into
-- Columns columns, which all have the same width if Homogeneous is True.
-- If Homogeneous is False, the width will be calculated with the children
-- contained in the table. Same behavior for the rows.
-- "rows": The number of rows the new table should have.
-- "columns": The number of columns the new table should have.
-- "homogeneous": If set to True, all table cells are resized to the size
-- of the cell containing the largest widget.
function Gtk_Table_New
(Rows : Guint;
Columns : Guint;
Homogeneous : Boolean) return Gtk_Table;
-- Create a new table. The width allocated to the table is divided into
-- Columns columns, which all have the same width if Homogeneous is True.
-- If Homogeneous is False, the width will be calculated with the children
-- contained in the table. Same behavior for the rows.
-- "rows": The number of rows the new table should have.
-- "columns": The number of columns the new table should have.
-- "homogeneous": If set to True, all table cells are resized to the size
-- of the cell containing the largest widget.
function Get_Type return Glib.GType;
pragma Import (C, Get_Type, "gtk_table_get_type");
-------------
-- Methods --
-------------
procedure Attach
(Table : not null access Gtk_Table_Record;
Child : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Left_Attach : Guint;
Right_Attach : Guint;
Top_Attach : Guint;
Bottom_Attach : Guint;
Xoptions : Gtk.Enums.Gtk_Attach_Options := Expand or Fill;
Yoptions : Gtk.Enums.Gtk_Attach_Options := Expand or Fill;
Xpadding : Guint := 0;
Ypadding : Guint := 0);
pragma Obsolescent (Attach);
-- Insert a new widget in the table. All the attachments are relative to
-- the separations between columns and rows (for instance, to insert a
-- widget spanning the first two columns in the table, you should put
-- Left_Attach=0 and Right_Attach=2). Same behavior for the rows. Xoptions
-- and Yoptions indicate the behavior of the child when the table is
-- resized (whether the child can shrink or expand). See the description in
-- Gtk.Box for more information on the possible values. Xpadding and
-- Ypadding are the amount of space left around the child.
-- Deprecated since 3.4, Use Gtk.Grid.Attach with Gtk.Grid.Gtk_Grid. Note
-- that the attach arguments differ between those two functions.
-- "child": The widget to add.
-- "left_attach": the column number to attach the left side of a child
-- widget to.
-- "right_attach": the column number to attach the right side of a child
-- widget to.
-- "top_attach": the row number to attach the top of a child widget to.
-- "bottom_attach": the row number to attach the bottom of a child widget
-- to.
-- "xoptions": Used to specify the properties of the child widget when the
-- table is resized.
-- "yoptions": The same as xoptions, except this field determines
-- behaviour of vertical resizing.
-- "xpadding": An integer value specifying the padding on the left and
-- right of the widget being added to the table.
-- "ypadding": The amount of padding above and below the child widget.
procedure Attach_Defaults
(Table : not null access Gtk_Table_Record;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Left_Attach : Guint;
Right_Attach : Guint;
Top_Attach : Guint;
Bottom_Attach : Guint);
pragma Obsolescent (Attach_Defaults);
-- Insert a new widget in the table, with default values. No padding is
-- put around the child, and the options are set to Expand and Fill. This
-- call is similar to Attach with default values and is only provided for
-- compatibility.
-- Deprecated since 3.4, Use Gtk.Grid.Attach with Gtk.Grid.Gtk_Grid. Note
-- that the attach arguments differ between those two functions.
-- "widget": The child widget to add.
-- "left_attach": The column number to attach the left side of the child
-- widget to.
-- "right_attach": The column number to attach the right side of the child
-- widget to.
-- "top_attach": The row number to attach the top of the child widget to.
-- "bottom_attach": The row number to attach the bottom of the child
-- widget to.
function Get_Col_Spacing
(Table : not null access Gtk_Table_Record;
Column : Guint) return Guint;
pragma Obsolescent (Get_Col_Spacing);
-- Gets the amount of space between column Col, and column Col + 1. See
-- Gtk.Table.Set_Col_Spacing.
-- Deprecated since 3.4, Gtk.Grid.Gtk_Grid does not offer a replacement
-- for this functionality.
-- "column": a column in the table, 0 indicates the first column
procedure Set_Col_Spacing
(Table : not null access Gtk_Table_Record;
Column : Guint;
Spacing : Guint);
pragma Obsolescent (Set_Col_Spacing);
-- Set the spacing in pixels between Column and the next one.
-- Deprecated since 3.4, Use Gtk.Widget.Set_Margin_Left and
-- Gtk.Widget.Set_Margin_Right on the widgets contained in the row if you
-- need this functionality. Gtk.Grid.Gtk_Grid does not support per-row
-- spacing.
-- "column": the column whose spacing should be changed.
-- "spacing": number of pixels that the spacing should take up.
function Get_Default_Col_Spacing
(Table : not null access Gtk_Table_Record) return Guint;
pragma Obsolescent (Get_Default_Col_Spacing);
-- Gets the default column spacing for the table. This is the spacing that
-- will be used for newly added columns. (See Gtk.Table.Set_Col_Spacings)
-- Deprecated since 3.4, Use Gtk.Grid.Get_Column_Spacing with
-- Gtk.Grid.Gtk_Grid.
function Get_Default_Row_Spacing
(Table : not null access Gtk_Table_Record) return Guint;
pragma Obsolescent (Get_Default_Row_Spacing);
-- Gets the default row spacing for the table. This is the spacing that
-- will be used for newly added rows. (See Gtk.Table.Set_Row_Spacings)
-- Deprecated since 3.4, Use Gtk.Grid.Get_Row_Spacing with
-- Gtk.Grid.Gtk_Grid.
function Get_Homogeneous
(Table : not null access Gtk_Table_Record) return Boolean;
pragma Obsolescent (Get_Homogeneous);
-- Returns whether the table cells are all constrained to the same width
-- and height. (See gtk_table_set_homogenous ())
-- Deprecated since 3.4, Use Gtk.Grid.Get_Row_Homogeneous and
-- Gtk.Grid.Get_Column_Homogeneous with Gtk.Grid.Gtk_Grid.
procedure Set_Homogeneous
(Table : not null access Gtk_Table_Record;
Homogeneous : Boolean);
pragma Obsolescent (Set_Homogeneous);
-- Indicate the homogeneous status of the table. If Homogeneous is True,
-- the rows and columns of the table will all be allocated the same width
-- or height.
-- Deprecated since 3.4, Use Gtk.Grid.Set_Row_Homogeneous and
-- Gtk.Grid.Set_Column_Homogeneous with Gtk.Grid.Gtk_Grid.
-- "homogeneous": Set to True to ensure all table cells are the same size.
-- Set to False if this is not your desired behaviour.
function Get_Row_Spacing
(Table : not null access Gtk_Table_Record;
Row : Guint) return Guint;
pragma Obsolescent (Get_Row_Spacing);
-- Gets the amount of space between row Row, and row Row + 1. See
-- Gtk.Table.Set_Row_Spacing.
-- Deprecated since 3.4, Gtk.Grid.Gtk_Grid does not offer a replacement
-- for this functionality.
-- "row": a row in the table, 0 indicates the first row
procedure Set_Row_Spacing
(Table : not null access Gtk_Table_Record;
Row : Guint;
Spacing : Guint);
pragma Obsolescent (Set_Row_Spacing);
-- Changes the space between a given table row and the subsequent row.
-- Deprecated since 3.4, Use Gtk.Widget.Set_Margin_Top and
-- Gtk.Widget.Set_Margin_Bottom on the widgets contained in the row if you
-- need this functionality. Gtk.Grid.Gtk_Grid does not support per-row
-- spacing.
-- "row": row number whose spacing will be changed.
-- "spacing": number of pixels that the spacing should take up.
procedure Get_Size
(Table : not null access Gtk_Table_Record;
Rows : out Guint;
Columns : out Guint);
pragma Obsolescent (Get_Size);
-- Gets the number of rows and columns in the table.
-- Since: gtk+ 2.22
-- Deprecated since 3.4, Gtk.Grid.Gtk_Grid does not expose the number of
-- columns and rows.
-- "rows": return location for the number of rows, or null
-- "columns": return location for the number of columns, or null
procedure Resize
(Table : not null access Gtk_Table_Record;
Rows : Guint;
Columns : Guint);
pragma Obsolescent (Resize);
-- If you need to change a table's size *after* it has been created, this
-- function allows you to do so.
-- Deprecated since 3.4, Gtk.Grid.Gtk_Grid resizes automatically.
-- "rows": The new number of rows.
-- "columns": The new number of columns.
procedure Set_Col_Spacings
(Table : not null access Gtk_Table_Record;
Spacing : Guint);
pragma Obsolescent (Set_Col_Spacings);
-- Sets the space between every column in Table equal to Spacing.
-- Deprecated since 3.4, Use Gtk.Grid.Set_Column_Spacing with
-- Gtk.Grid.Gtk_Grid.
-- "spacing": the number of pixels of space to place between every column
-- in the table.
procedure Set_Row_Spacings
(Table : not null access Gtk_Table_Record;
Spacing : Guint);
pragma Obsolescent (Set_Row_Spacings);
-- Sets the space between every row in Table equal to Spacing.
-- Deprecated since 3.4, Use Gtk.Grid.Set_Row_Spacing with
-- Gtk.Grid.Gtk_Grid.
-- "spacing": the number of pixels of space to place between every row in
-- the table.
----------------
-- Properties --
----------------
-- The following properties are defined for this widget. See
-- Glib.Properties for more information on properties)
Column_Spacing_Property : constant Glib.Properties.Property_Uint;
Homogeneous_Property : constant Glib.Properties.Property_Boolean;
N_Columns_Property : constant Glib.Properties.Property_Uint;
N_Rows_Property : constant Glib.Properties.Property_Uint;
Row_Spacing_Property : constant Glib.Properties.Property_Uint;
----------------
-- Interfaces --
----------------
-- This class implements several interfaces. See Glib.Types
--
-- - "Buildable"
package Implements_Gtk_Buildable is new Glib.Types.Implements
(Gtk.Buildable.Gtk_Buildable, Gtk_Table_Record, Gtk_Table);
function "+"
(Widget : access Gtk_Table_Record'Class)
return Gtk.Buildable.Gtk_Buildable
renames Implements_Gtk_Buildable.To_Interface;
function "-"
(Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Table
renames Implements_Gtk_Buildable.To_Object;
private
Row_Spacing_Property : constant Glib.Properties.Property_Uint :=
Glib.Properties.Build ("row-spacing");
N_Rows_Property : constant Glib.Properties.Property_Uint :=
Glib.Properties.Build ("n-rows");
N_Columns_Property : constant Glib.Properties.Property_Uint :=
Glib.Properties.Build ("n-columns");
Homogeneous_Property : constant Glib.Properties.Property_Boolean :=
Glib.Properties.Build ("homogeneous");
Column_Spacing_Property : constant Glib.Properties.Property_Uint :=
Glib.Properties.Build ("column-spacing");
end Gtk.Table;