gtk2/gtk/gtkalignment.c
Tristan Van Berkom 85a55b2921 Implement GtkExtendedLayout on Alignment
GtkAlignment is already using the height for width api to align
the child in the cases where space is available, but also needed
to implement the extended layout in order to reflect natural sizes
to parent widgets.
2010-04-06 20:47:15 -04:00

622 lines
20 KiB
C

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, 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
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkalignment.h"
#include "gtkextendedlayout.h"
#include "gtkprivate.h"
#include "gtkintl.h"
#include "gtkalias.h"
enum {
PROP_0,
PROP_XALIGN,
PROP_YALIGN,
PROP_XSCALE,
PROP_YSCALE,
PROP_TOP_PADDING,
PROP_BOTTOM_PADDING,
PROP_LEFT_PADDING,
PROP_RIGHT_PADDING
};
#define GTK_ALIGNMENT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_ALIGNMENT, GtkAlignmentPrivate))
struct _GtkAlignmentPrivate
{
guint padding_top;
guint padding_bottom;
guint padding_left;
guint padding_right;
};
static void gtk_alignment_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
static void gtk_alignment_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_alignment_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gtk_alignment_extended_layout_init (GtkExtendedLayoutIface *iface);
static void gtk_alignment_get_desired_size (GtkExtendedLayout *layout,
GtkRequisition *minimum_size,
GtkRequisition *natural_size);
G_DEFINE_TYPE_WITH_CODE (GtkAlignment, gtk_alignment, GTK_TYPE_BIN,
G_IMPLEMENT_INTERFACE (GTK_TYPE_EXTENDED_LAYOUT,
gtk_alignment_extended_layout_init))
static void
gtk_alignment_class_init (GtkAlignmentClass *class)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
gobject_class = (GObjectClass*) class;
widget_class = (GtkWidgetClass*) class;
gobject_class->set_property = gtk_alignment_set_property;
gobject_class->get_property = gtk_alignment_get_property;
widget_class->size_allocate = gtk_alignment_size_allocate;
g_object_class_install_property (gobject_class,
PROP_XALIGN,
g_param_spec_float("xalign",
P_("Horizontal alignment"),
P_("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
0.0,
1.0,
0.5,
GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_YALIGN,
g_param_spec_float("yalign",
P_("Vertical alignment"),
P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
0.0,
1.0,
0.5,
GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_XSCALE,
g_param_spec_float("xscale",
P_("Horizontal scale"),
P_("If available horizontal space is bigger than needed for the child, how much of it to use for the child. 0.0 means none, 1.0 means all"),
0.0,
1.0,
1.0,
GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_YSCALE,
g_param_spec_float("yscale",
P_("Vertical scale"),
P_("If available vertical space is bigger than needed for the child, how much of it to use for the child. 0.0 means none, 1.0 means all"),
0.0,
1.0,
1.0,
GTK_PARAM_READWRITE));
/**
* GtkAlignment:top-padding:
*
* The padding to insert at the top of the widget.
*
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
PROP_TOP_PADDING,
g_param_spec_uint("top-padding",
P_("Top Padding"),
P_("The padding to insert at the top of the widget."),
0,
G_MAXINT,
0,
GTK_PARAM_READWRITE));
/**
* GtkAlignment:bottom-padding:
*
* The padding to insert at the bottom of the widget.
*
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
PROP_BOTTOM_PADDING,
g_param_spec_uint("bottom-padding",
P_("Bottom Padding"),
P_("The padding to insert at the bottom of the widget."),
0,
G_MAXINT,
0,
GTK_PARAM_READWRITE));
/**
* GtkAlignment:left-padding:
*
* The padding to insert at the left of the widget.
*
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
PROP_LEFT_PADDING,
g_param_spec_uint("left-padding",
P_("Left Padding"),
P_("The padding to insert at the left of the widget."),
0,
G_MAXINT,
0,
GTK_PARAM_READWRITE));
/**
* GtkAlignment:right-padding:
*
* The padding to insert at the right of the widget.
*
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
PROP_RIGHT_PADDING,
g_param_spec_uint("right-padding",
P_("Right Padding"),
P_("The padding to insert at the right of the widget."),
0,
G_MAXINT,
0,
GTK_PARAM_READWRITE));
g_type_class_add_private (gobject_class, sizeof (GtkAlignmentPrivate));
}
static void
gtk_alignment_init (GtkAlignment *alignment)
{
GtkAlignmentPrivate *priv;
gtk_widget_set_has_window (GTK_WIDGET (alignment), FALSE);
gtk_widget_set_redraw_on_allocate (GTK_WIDGET (alignment), FALSE);
alignment->xalign = 0.5;
alignment->yalign = 0.5;
alignment->xscale = 1.0;
alignment->yscale = 1.0;
/* Initialize padding with default values: */
priv = GTK_ALIGNMENT_GET_PRIVATE (alignment);
priv->padding_top = 0;
priv->padding_bottom = 0;
priv->padding_left = 0;
priv->padding_right = 0;
}
GtkWidget*
gtk_alignment_new (gfloat xalign,
gfloat yalign,
gfloat xscale,
gfloat yscale)
{
GtkAlignment *alignment;
alignment = g_object_new (GTK_TYPE_ALIGNMENT, NULL);
alignment->xalign = CLAMP (xalign, 0.0, 1.0);
alignment->yalign = CLAMP (yalign, 0.0, 1.0);
alignment->xscale = CLAMP (xscale, 0.0, 1.0);
alignment->yscale = CLAMP (yscale, 0.0, 1.0);
return GTK_WIDGET (alignment);
}
static void
gtk_alignment_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkAlignment *alignment;
GtkAlignmentPrivate *priv;
alignment = GTK_ALIGNMENT (object);
priv = GTK_ALIGNMENT_GET_PRIVATE (alignment);
switch (prop_id)
{
case PROP_XALIGN:
gtk_alignment_set (alignment,
g_value_get_float (value),
alignment->yalign,
alignment->xscale,
alignment->yscale);
break;
case PROP_YALIGN:
gtk_alignment_set (alignment,
alignment->xalign,
g_value_get_float (value),
alignment->xscale,
alignment->yscale);
break;
case PROP_XSCALE:
gtk_alignment_set (alignment,
alignment->xalign,
alignment->yalign,
g_value_get_float (value),
alignment->yscale);
break;
case PROP_YSCALE:
gtk_alignment_set (alignment,
alignment->xalign,
alignment->yalign,
alignment->xscale,
g_value_get_float (value));
break;
/* Padding: */
case PROP_TOP_PADDING:
gtk_alignment_set_padding (alignment,
g_value_get_uint (value),
priv->padding_bottom,
priv->padding_left,
priv->padding_right);
break;
case PROP_BOTTOM_PADDING:
gtk_alignment_set_padding (alignment,
priv->padding_top,
g_value_get_uint (value),
priv->padding_left,
priv->padding_right);
break;
case PROP_LEFT_PADDING:
gtk_alignment_set_padding (alignment,
priv->padding_top,
priv->padding_bottom,
g_value_get_uint (value),
priv->padding_right);
break;
case PROP_RIGHT_PADDING:
gtk_alignment_set_padding (alignment,
priv->padding_top,
priv->padding_bottom,
priv->padding_left,
g_value_get_uint (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_alignment_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkAlignment *alignment;
GtkAlignmentPrivate *priv;
alignment = GTK_ALIGNMENT (object);
priv = GTK_ALIGNMENT_GET_PRIVATE (alignment);
switch (prop_id)
{
case PROP_XALIGN:
g_value_set_float(value, alignment->xalign);
break;
case PROP_YALIGN:
g_value_set_float(value, alignment->yalign);
break;
case PROP_XSCALE:
g_value_set_float(value, alignment->xscale);
break;
case PROP_YSCALE:
g_value_set_float(value, alignment->yscale);
break;
/* Padding: */
case PROP_TOP_PADDING:
g_value_set_uint (value, priv->padding_top);
break;
case PROP_BOTTOM_PADDING:
g_value_set_uint (value, priv->padding_bottom);
break;
case PROP_LEFT_PADDING:
g_value_set_uint (value, priv->padding_left);
break;
case PROP_RIGHT_PADDING:
g_value_set_uint (value, priv->padding_right);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
void
gtk_alignment_set (GtkAlignment *alignment,
gfloat xalign,
gfloat yalign,
gfloat xscale,
gfloat yscale)
{
g_return_if_fail (GTK_IS_ALIGNMENT (alignment));
xalign = CLAMP (xalign, 0.0, 1.0);
yalign = CLAMP (yalign, 0.0, 1.0);
xscale = CLAMP (xscale, 0.0, 1.0);
yscale = CLAMP (yscale, 0.0, 1.0);
if ( (alignment->xalign != xalign)
|| (alignment->yalign != yalign)
|| (alignment->xscale != xscale)
|| (alignment->yscale != yscale))
{
g_object_freeze_notify (G_OBJECT (alignment));
if (alignment->xalign != xalign)
{
alignment->xalign = xalign;
g_object_notify (G_OBJECT (alignment), "xalign");
}
if (alignment->yalign != yalign)
{
alignment->yalign = yalign;
g_object_notify (G_OBJECT (alignment), "yalign");
}
if (alignment->xscale != xscale)
{
alignment->xscale = xscale;
g_object_notify (G_OBJECT (alignment), "xscale");
}
if (alignment->yscale != yscale)
{
alignment->yscale = yscale;
g_object_notify (G_OBJECT (alignment), "yscale");
}
g_object_thaw_notify (G_OBJECT (alignment));
if (GTK_BIN (alignment)->child)
gtk_widget_queue_resize (GTK_BIN (alignment)->child);
gtk_widget_queue_draw (GTK_WIDGET (alignment));
}
}
static void
gtk_alignment_size_allocate (GtkWidget *widget,
GtkAllocation *allocation)
{
GtkAlignment *alignment;
GtkBin *bin;
GtkAllocation child_allocation;
GtkRequisition child_requisition;
gint width, height;
gint border_width;
gint padding_horizontal, padding_vertical;
GtkAlignmentPrivate *priv;
padding_horizontal = 0;
padding_vertical = 0;
widget->allocation = *allocation;
alignment = GTK_ALIGNMENT (widget);
bin = GTK_BIN (widget);
if (bin->child && gtk_widget_get_visible (bin->child))
{
GtkExtendedLayout *layout = GTK_EXTENDED_LAYOUT (bin->child);
gtk_extended_layout_get_desired_size (layout, NULL, &child_requisition);
border_width = GTK_CONTAINER (alignment)->border_width;
priv = GTK_ALIGNMENT_GET_PRIVATE (widget);
padding_horizontal = priv->padding_left + priv->padding_right;
padding_vertical = priv->padding_top + priv->padding_bottom;
width = MAX (1, allocation->width - padding_horizontal - 2 * border_width);
height = MAX (1, allocation->height - padding_vertical - 2 * border_width);
if (child_requisition.width > width)
gtk_extended_layout_get_height_for_width (layout, width, NULL,
&child_requisition.height);
else if (child_requisition.height > height)
gtk_extended_layout_get_width_for_height (layout, height, NULL,
&child_requisition.width);
if (width > child_requisition.width)
child_allocation.width = (child_requisition.width *
(1.0 - alignment->xscale) +
width * alignment->xscale);
else
child_allocation.width = width;
if (height > child_requisition.height)
child_allocation.height = (child_requisition.height *
(1.0 - alignment->yscale) +
height * alignment->yscale);
else
child_allocation.height = height;
if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
child_allocation.x = (1.0 - alignment->xalign) * (width - child_allocation.width) + allocation->x + border_width + priv->padding_right;
else
child_allocation.x = alignment->xalign * (width - child_allocation.width) + allocation->x + border_width + priv->padding_left;
child_allocation.y = alignment->yalign * (height - child_allocation.height) + allocation->y + border_width + priv->padding_top;
gtk_widget_size_allocate (bin->child, &child_allocation);
}
}
static void
gtk_alignment_extended_layout_init (GtkExtendedLayoutIface *iface)
{
iface->get_desired_size = gtk_alignment_get_desired_size;
}
static void
gtk_alignment_get_desired_size (GtkExtendedLayout *layout,
GtkRequisition *minimum_size,
GtkRequisition *natural_size)
{
GtkWidget *child;
GtkAlignmentPrivate *priv;
priv = GTK_ALIGNMENT_GET_PRIVATE (layout);
minimum_size->width = GTK_CONTAINER (layout)->border_width * 2;
minimum_size->height = GTK_CONTAINER (layout)->border_width * 2;
*natural_size = *minimum_size;
if ((child = gtk_bin_get_child (GTK_BIN (layout))) && gtk_widget_get_visible (child))
{
GtkRequisition child_min, child_nat;
/* Request extra space for the padding: */
minimum_size->width += (priv->padding_left + priv->padding_right);
minimum_size->height += (priv->padding_top + priv->padding_bottom);
*natural_size = *minimum_size;
gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (child),
&child_min, &child_nat);
minimum_size->width += child_min.width;
minimum_size->height += child_min.height;
natural_size->width += child_nat.width;
natural_size->height += child_nat.height;
}
}
/**
* gtk_alignment_set_padding:
* @alignment: a #GtkAlignment
* @padding_top: the padding at the top of the widget
* @padding_bottom: the padding at the bottom of the widget
* @padding_left: the padding at the left of the widget
* @padding_right: the padding at the right of the widget.
*
* Sets the padding on the different sides of the widget.
* The padding adds blank space to the sides of the widget. For instance,
* this can be used to indent the child widget towards the right by adding
* padding on the left.
*
* Since: 2.4
*/
void
gtk_alignment_set_padding (GtkAlignment *alignment,
guint padding_top,
guint padding_bottom,
guint padding_left,
guint padding_right)
{
GtkAlignmentPrivate *priv;
g_return_if_fail (GTK_IS_ALIGNMENT (alignment));
priv = GTK_ALIGNMENT_GET_PRIVATE (alignment);
g_object_freeze_notify (G_OBJECT (alignment));
if (priv->padding_top != padding_top)
{
priv->padding_top = padding_top;
g_object_notify (G_OBJECT (alignment), "top-padding");
}
if (priv->padding_bottom != padding_bottom)
{
priv->padding_bottom = padding_bottom;
g_object_notify (G_OBJECT (alignment), "bottom-padding");
}
if (priv->padding_left != padding_left)
{
priv->padding_left = padding_left;
g_object_notify (G_OBJECT (alignment), "left-padding");
}
if (priv->padding_right != padding_right)
{
priv->padding_right = padding_right;
g_object_notify (G_OBJECT (alignment), "right-padding");
}
g_object_thaw_notify (G_OBJECT (alignment));
/* Make sure that the widget and children are redrawn with the new setting: */
if (GTK_BIN (alignment)->child)
gtk_widget_queue_resize (GTK_BIN (alignment)->child);
gtk_widget_queue_draw (GTK_WIDGET (alignment));
}
/**
* gtk_alignment_get_padding:
* @alignment: a #GtkAlignment
* @padding_top: (allow-none): location to store the padding for the top of the widget, or %NULL
* @padding_bottom: (allow-none): location to store the padding for the bottom of the widget, or %NULL
* @padding_left: (allow-none): location to store the padding for the left of the widget, or %NULL
* @padding_right: (allow-none): location to store the padding for the right of the widget, or %NULL
*
* Gets the padding on the different sides of the widget.
* See gtk_alignment_set_padding ().
*
* Since: 2.4
*/
void
gtk_alignment_get_padding (GtkAlignment *alignment,
guint *padding_top,
guint *padding_bottom,
guint *padding_left,
guint *padding_right)
{
GtkAlignmentPrivate *priv;
g_return_if_fail (GTK_IS_ALIGNMENT (alignment));
priv = GTK_ALIGNMENT_GET_PRIVATE (alignment);
if(padding_top)
*padding_top = priv->padding_top;
if(padding_bottom)
*padding_bottom = priv->padding_bottom;
if(padding_left)
*padding_left = priv->padding_left;
if(padding_right)
*padding_right = priv->padding_right;
}
#define __GTK_ALIGNMENT_C__
#include "gtkaliasdef.c"