* Copyright Owen Taylor 4/9/97
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * 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
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the Free
- * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+
+/*
+ * Modified by the GTK+ Team and others 1997-2001. 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/.
+ */
+
+/**
+ * SECTION:gtkaspectframe
+ * @Short_description: A frame that constrains its child to a particular aspect ratio
+ * @Title: GtkAspectFrame
+ *
+ * The #GtkAspectFrame is useful when you want
+ * pack a widget so that it can resize but always retains
+ * the same aspect ratio. For instance, one might be
+ * drawing a small preview of a larger image. #GtkAspectFrame
+ * derives from #GtkFrame, so it can draw a label and
+ * a frame around the child. The frame will be
+ * "shrink-wrapped" to the size of the child.
+ */
+
+#include "config.h"
+
#include "gtkaspectframe.h"
-static void gtk_aspect_frame_class_init (GtkAspectFrameClass *klass);
-static void gtk_aspect_frame_init (GtkAspectFrame *aspect_frame);
-static void gtk_aspect_frame_draw (GtkWidget *widget,
- GdkRectangle *area);
-static void gtk_aspect_frame_paint (GtkWidget *widget,
- GdkRectangle *area);
-static gint gtk_aspect_frame_expose (GtkWidget *widget,
- GdkEventExpose *event);
-static void gtk_aspect_frame_size_allocate (GtkWidget *widget,
- GtkAllocation *allocation);
+#include "gtksizerequest.h"
+
+#include "gtkprivate.h"
+#include "gtkintl.h"
-#define MAX_RATIO 10000.0
-#define MIN_RATIO 0.0001
-guint
-gtk_aspect_frame_get_type ()
+
+struct _GtkAspectFramePrivate
{
- static guint aspect_frame_type = 0;
+ GtkAllocation center_allocation;
+
+ gboolean obey_child;
+ gfloat xalign;
+ gfloat yalign;
+ gfloat ratio;
+};
+
+
+enum {
+ PROP_0,
+ PROP_XALIGN,
+ PROP_YALIGN,
+ PROP_RATIO,
+ PROP_OBEY_CHILD
+};
+
+static void gtk_aspect_frame_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_aspect_frame_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void gtk_aspect_frame_compute_child_allocation (GtkFrame *frame,
+ GtkAllocation *child_allocation);
- if (!aspect_frame_type)
- {
- GtkTypeInfo aspect_frame_info =
- {
- "GtkAspectFrame",
- sizeof (GtkAspectFrame),
- sizeof (GtkAspectFrameClass),
- (GtkClassInitFunc) gtk_aspect_frame_class_init,
- (GtkObjectInitFunc) gtk_aspect_frame_init,
- (GtkArgFunc) NULL,
- };
-
- aspect_frame_type = gtk_type_unique (gtk_frame_get_type (), &aspect_frame_info);
- }
+#define MAX_RATIO 10000.0
+#define MIN_RATIO 0.0001
- return aspect_frame_type;
-}
+G_DEFINE_TYPE (GtkAspectFrame, gtk_aspect_frame, GTK_TYPE_FRAME)
static void
gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
{
- GtkWidgetClass *widget_class;
-
- widget_class = (GtkWidgetClass*) class;
-
- widget_class->draw = gtk_aspect_frame_draw;
- widget_class->expose_event = gtk_aspect_frame_expose;
- widget_class->size_allocate = gtk_aspect_frame_size_allocate;
+ GObjectClass *gobject_class;
+ GtkFrameClass *frame_class;
+
+ gobject_class = (GObjectClass*) class;
+ frame_class = (GtkFrameClass*) class;
+
+ gobject_class->set_property = gtk_aspect_frame_set_property;
+ gobject_class->get_property = gtk_aspect_frame_get_property;
+
+ frame_class->compute_child_allocation = gtk_aspect_frame_compute_child_allocation;
+
+ g_object_class_install_property (gobject_class,
+ PROP_XALIGN,
+ g_param_spec_float ("xalign",
+ P_("Horizontal Alignment"),
+ P_("X alignment of the child"),
+ 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_("Y alignment of the child"),
+ 0.0, 1.0, 0.5,
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (gobject_class,
+ PROP_RATIO,
+ g_param_spec_float ("ratio",
+ P_("Ratio"),
+ P_("Aspect ratio if obey_child is FALSE"),
+ MIN_RATIO, MAX_RATIO, 1.0,
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (gobject_class,
+ PROP_OBEY_CHILD,
+ g_param_spec_boolean ("obey-child",
+ P_("Obey child"),
+ P_("Force aspect ratio to match that of the frame's child"),
+ TRUE,
+ GTK_PARAM_READWRITE));
+
+ g_type_class_add_private (class, sizeof (GtkAspectFramePrivate));
}
static void
gtk_aspect_frame_init (GtkAspectFrame *aspect_frame)
{
- aspect_frame->xalign = 0.5;
- aspect_frame->yalign = 0.5;
- aspect_frame->ratio = 1.0;
- aspect_frame->obey_child = 1;
- aspect_frame->center_allocation.x = -1;
- aspect_frame->center_allocation.y = -1;
- aspect_frame->center_allocation.width = 1;
- aspect_frame->center_allocation.height = 1;
-}
+ GtkAspectFramePrivate *priv;
-GtkWidget*
-gtk_aspect_frame_new (const gchar *label,
- gfloat xalign,
- gfloat yalign,
- gfloat ratio,
- gint obey_child)
-{
- GtkAspectFrame *aspect_frame;
-
- aspect_frame = gtk_type_new (gtk_aspect_frame_get_type ());
-
- aspect_frame->xalign = CLAMP (xalign, 0.0, 1.0);
- aspect_frame->yalign = CLAMP (yalign, 0.0, 1.0);
- aspect_frame->ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
- aspect_frame->obey_child = obey_child;
+ aspect_frame->priv = G_TYPE_INSTANCE_GET_PRIVATE (aspect_frame,
+ GTK_TYPE_ASPECT_FRAME,
+ GtkAspectFramePrivate);
+ priv = aspect_frame->priv;
- gtk_frame_set_label (GTK_FRAME(aspect_frame), label);
-
- return GTK_WIDGET (aspect_frame);
+ priv->xalign = 0.5;
+ priv->yalign = 0.5;
+ priv->ratio = 1.0;
+ priv->obey_child = TRUE;
}
-void
-gtk_aspect_frame_set (GtkAspectFrame *aspect_frame,
- gfloat xalign,
- gfloat yalign,
- gfloat ratio,
- gint obey_child)
+static void
+gtk_aspect_frame_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
- g_return_if_fail (aspect_frame != NULL);
- g_return_if_fail (GTK_IS_ASPECT_FRAME (aspect_frame));
-
- xalign = CLAMP (xalign, 0.0, 1.0);
- yalign = CLAMP (yalign, 0.0, 1.0);
- ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
-
- if ((aspect_frame->xalign != xalign) ||
- (aspect_frame->yalign != yalign) ||
- (aspect_frame->ratio != ratio) ||
- (aspect_frame->obey_child != obey_child))
+ GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
+
+ switch (prop_id)
{
- aspect_frame->xalign = xalign;
- aspect_frame->yalign = yalign;
- aspect_frame->ratio = ratio;
- aspect_frame->obey_child = obey_child;
-
- gtk_widget_size_allocate (GTK_WIDGET (aspect_frame), &(GTK_WIDGET (aspect_frame)->allocation));
- gtk_widget_queue_draw (GTK_WIDGET (aspect_frame));
+ /* g_object_notify is handled by the _frame_set function */
+ case PROP_XALIGN:
+ gtk_aspect_frame_set (aspect_frame,
+ g_value_get_float (value),
+ priv->yalign,
+ priv->ratio,
+ priv->obey_child);
+ break;
+ case PROP_YALIGN:
+ gtk_aspect_frame_set (aspect_frame,
+ priv->xalign,
+ g_value_get_float (value),
+ priv->ratio,
+ priv->obey_child);
+ break;
+ case PROP_RATIO:
+ gtk_aspect_frame_set (aspect_frame,
+ priv->xalign,
+ priv->yalign,
+ g_value_get_float (value),
+ priv->obey_child);
+ break;
+ case PROP_OBEY_CHILD:
+ gtk_aspect_frame_set (aspect_frame,
+ priv->xalign,
+ priv->yalign,
+ priv->ratio,
+ g_value_get_boolean (value));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
}
static void
-gtk_aspect_frame_paint (GtkWidget *widget,
- GdkRectangle *area)
+gtk_aspect_frame_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- GtkFrame *frame;
- GtkStateType state;
- gint height_extra;
- gint label_area_width;
- gint x, y;
- GtkAllocation *allocation;
-
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_ASPECT_FRAME (widget));
- g_return_if_fail (area != NULL);
-
- if (GTK_WIDGET_DRAWABLE (widget))
+ GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
+
+ switch (prop_id)
{
- frame = GTK_FRAME (widget);
- allocation = >K_ASPECT_FRAME(widget)->center_allocation;
-
- state = widget->state;
- if (!GTK_WIDGET_IS_SENSITIVE (widget))
- state = GTK_STATE_INSENSITIVE;
-
- height_extra = frame->label_height - widget->style->klass->xthickness;
- height_extra = MAX (height_extra, 0);
-
- x = GTK_CONTAINER (frame)->border_width;
- y = GTK_CONTAINER (frame)->border_width;
-
- gtk_draw_shadow (widget->style, widget->window,
- GTK_STATE_NORMAL, frame->shadow_type,
- allocation->x + x,
- allocation->y + y + height_extra / 2,
- allocation->width - x * 2,
- allocation->height - y * 2 - height_extra / 2);
-
- if (frame->label)
- {
- label_area_width = (allocation->width +
- GTK_CONTAINER (frame)->border_width * 2 -
- widget->style->klass->xthickness * 2);
-
- x = ((label_area_width - frame->label_width) * frame->label_xalign +
- GTK_CONTAINER (frame)->border_width + widget->style->klass->xthickness);
- y = (GTK_CONTAINER (frame)->border_width + widget->style->font->ascent);
-
- gdk_window_clear_area (widget->window,
- allocation->x + x + 2,
- allocation->y + GTK_CONTAINER (frame)->border_width,
- frame->label_width - 4, frame->label_height);
- gtk_draw_string (widget->style, widget->window, state,
- allocation->x + x + 3,
- allocation->y + y,
- frame->label);
- }
+ case PROP_XALIGN:
+ g_value_set_float (value, priv->xalign);
+ break;
+ case PROP_YALIGN:
+ g_value_set_float (value, priv->yalign);
+ break;
+ case PROP_RATIO:
+ g_value_set_float (value, priv->ratio);
+ break;
+ case PROP_OBEY_CHILD:
+ g_value_set_boolean (value, priv->obey_child);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
}
-/* the only modification to the next two routines is to call
- gtk_aspect_frame_paint instead of gtk_frame_paint */
-
-static void
-gtk_aspect_frame_draw (GtkWidget *widget,
- GdkRectangle *area)
+/**
+ * gtk_aspect_frame_new:
+ * @label: Label text.
+ * @xalign: Horizontal alignment of the child within the allocation of
+ * the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+ * to 1.0 (right aligned)
+ * @yalign: Vertical alignment of the child within the allocation of
+ * the #GtkAspectFrame. This ranges from 0.0 (top aligned)
+ * to 1.0 (bottom aligned)
+ * @ratio: The desired aspect ratio.
+ * @obey_child: If %TRUE, @ratio is ignored, and the aspect
+ * ratio is taken from the requistion of the child.
+ *
+ * Create a new #GtkAspectFrame.
+ *
+ * Returns: the new #GtkAspectFrame.
+ */
+GtkWidget*
+gtk_aspect_frame_new (const gchar *label,
+ gfloat xalign,
+ gfloat yalign,
+ gfloat ratio,
+ gboolean obey_child)
{
- GtkBin *bin;
- GdkRectangle child_area;
+ GtkAspectFrame *aspect_frame;
+ GtkAspectFramePrivate *priv;
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_ASPECT_FRAME (widget));
- g_return_if_fail (area != NULL);
+ aspect_frame = g_object_new (GTK_TYPE_ASPECT_FRAME, NULL);
- if (GTK_WIDGET_DRAWABLE (widget))
- {
- bin = GTK_BIN (widget);
+ priv = aspect_frame->priv;
- gtk_aspect_frame_paint (widget, area);
+ priv->xalign = CLAMP (xalign, 0.0, 1.0);
+ priv->yalign = CLAMP (yalign, 0.0, 1.0);
+ priv->ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
+ priv->obey_child = obey_child != FALSE;
- if (bin->child && gtk_widget_intersect (bin->child, area, &child_area))
- gtk_widget_draw (bin->child, &child_area);
- }
+ gtk_frame_set_label (GTK_FRAME(aspect_frame), label);
+
+ return GTK_WIDGET (aspect_frame);
}
-static gint
-gtk_aspect_frame_expose (GtkWidget *widget,
- GdkEventExpose *event)
+/**
+ * gtk_aspect_frame_set:
+ * @aspect_frame: a #GtkAspectFrame
+ * @xalign: Horizontal alignment of the child within the allocation of
+ * the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+ * to 1.0 (right aligned)
+ * @yalign: Vertical alignment of the child within the allocation of
+ * the #GtkAspectFrame. This ranges from 0.0 (top aligned)
+ * to 1.0 (bottom aligned)
+ * @ratio: The desired aspect ratio.
+ * @obey_child: If %TRUE, @ratio is ignored, and the aspect
+ * ratio is taken from the requistion of the child.
+ *
+ * Set parameters for an existing #GtkAspectFrame.
+ */
+void
+gtk_aspect_frame_set (GtkAspectFrame *aspect_frame,
+ gfloat xalign,
+ gfloat yalign,
+ gfloat ratio,
+ gboolean obey_child)
{
- GtkBin *bin;
- GdkEventExpose child_event;
+ GtkAspectFramePrivate *priv;
- g_return_val_if_fail (widget != NULL, FALSE);
- g_return_val_if_fail (GTK_IS_ASPECT_FRAME (widget), FALSE);
- g_return_val_if_fail (event != NULL, FALSE);
+ g_return_if_fail (GTK_IS_ASPECT_FRAME (aspect_frame));
- if (GTK_WIDGET_DRAWABLE (widget))
+ priv = aspect_frame->priv;
+
+ xalign = CLAMP (xalign, 0.0, 1.0);
+ yalign = CLAMP (yalign, 0.0, 1.0);
+ ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
+ obey_child = obey_child != FALSE;
+
+ if (priv->xalign != xalign
+ || priv->yalign != yalign
+ || priv->ratio != ratio
+ || priv->obey_child != obey_child)
{
- bin = GTK_BIN (widget);
-
- gtk_aspect_frame_paint (widget, &event->area);
-
- child_event = *event;
- if (bin->child &&
- GTK_WIDGET_NO_WINDOW (bin->child) &&
- gtk_widget_intersect (bin->child, &event->area, &child_event.area))
- gtk_widget_event (bin->child, (GdkEvent*) &child_event);
+ g_object_freeze_notify (G_OBJECT (aspect_frame));
+
+ if (priv->xalign != xalign)
+ {
+ priv->xalign = xalign;
+ g_object_notify (G_OBJECT (aspect_frame), "xalign");
+ }
+ if (priv->yalign != yalign)
+ {
+ priv->yalign = yalign;
+ g_object_notify (G_OBJECT (aspect_frame), "yalign");
+ }
+ if (priv->ratio != ratio)
+ {
+ priv->ratio = ratio;
+ g_object_notify (G_OBJECT (aspect_frame), "ratio");
+ }
+ if (priv->obey_child != obey_child)
+ {
+ priv->obey_child = obey_child;
+ g_object_notify (G_OBJECT (aspect_frame), "obey-child");
+ }
+ g_object_thaw_notify (G_OBJECT (aspect_frame));
+
+ gtk_widget_queue_resize (GTK_WIDGET (aspect_frame));
}
-
- return FALSE;
}
static void
-gtk_aspect_frame_size_allocate (GtkWidget *widget,
- GtkAllocation *allocation)
+gtk_aspect_frame_compute_child_allocation (GtkFrame *frame,
+ GtkAllocation *child_allocation)
{
- GtkFrame *frame;
- GtkAspectFrame *aspect_frame;
- GtkBin *bin;
-
- GtkAllocation child_allocation;
- gint x,y;
- gint width,height;
+ GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (frame);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
+ GtkBin *bin = GTK_BIN (frame);
+ GtkWidget *child;
gdouble ratio;
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_ASPECT_FRAME (widget));
- g_return_if_fail (allocation != NULL);
-
- aspect_frame = GTK_ASPECT_FRAME (widget);
- frame = GTK_FRAME (widget);
- bin = GTK_BIN (widget);
-
- if (GTK_WIDGET_MAPPED (widget) &&
- ((widget->allocation.x != allocation->x) ||
- (widget->allocation.y != allocation->y) ||
- (widget->allocation.width != allocation->width) ||
- (widget->allocation.height != allocation->height)) &&
- (widget->allocation.width != 0) &&
- (widget->allocation.height != 0))
- gdk_window_clear_area (widget->window,
- widget->allocation.x,
- widget->allocation.y,
- widget->allocation.width,
- widget->allocation.height);
-
- widget->allocation = *allocation;
-
- if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
+ child = gtk_bin_get_child (bin);
+ if (child && gtk_widget_get_visible (child))
{
- if (aspect_frame->obey_child)
+ GtkAllocation full_allocation;
+
+ if (priv->obey_child)
{
- if (bin->child->requisition.height != 0)
+ GtkRequisition child_requisition;
+
+ gtk_widget_get_preferred_size (child, &child_requisition, NULL);
+ if (child_requisition.height != 0)
{
- ratio = (gdouble)bin->child->requisition.width /
- bin->child->requisition.height;
- if (ratio < MIN_RATIO) ratio = MIN_RATIO;
+ ratio = ((gdouble) child_requisition.width /
+ child_requisition.height);
+ if (ratio < MIN_RATIO)
+ ratio = MIN_RATIO;
}
- else
- if (bin->child->requisition.height != 0)
- ratio = MAX_RATIO;
+ else if (child_requisition.width != 0)
+ ratio = MAX_RATIO;
else
ratio = 1.0;
}
else
- ratio = aspect_frame->ratio;
-
- x = (GTK_CONTAINER (frame)->border_width +
- GTK_WIDGET (frame)->style->klass->xthickness);
- width = allocation->width - x * 2;
+ ratio = priv->ratio;
- y = (GTK_CONTAINER (frame)->border_width +
- MAX (frame->label_height, GTK_WIDGET (frame)->style->klass->ythickness));
- height = (allocation->height - y -
- GTK_CONTAINER (frame)->border_width -
- GTK_WIDGET (frame)->style->klass->ythickness);
-
- if (ratio * height > width)
+ GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, &full_allocation);
+
+ if (ratio * full_allocation.height > full_allocation.width)
{
- child_allocation.width = width;
- child_allocation.height = width/ratio;
+ child_allocation->width = full_allocation.width;
+ child_allocation->height = full_allocation.width / ratio + 0.5;
}
else
{
- child_allocation.width = ratio*height;
- child_allocation.height = height;
+ child_allocation->width = ratio * full_allocation.height + 0.5;
+ child_allocation->height = full_allocation.height;
}
-
- child_allocation.x = aspect_frame->xalign * (width - child_allocation.width) + allocation->x + x;
- child_allocation.y = aspect_frame->yalign * (height - child_allocation.height) + allocation->y + y;
-
- aspect_frame->center_allocation.width = child_allocation.width + 2*x;
- aspect_frame->center_allocation.x = child_allocation.x - x;
- aspect_frame->center_allocation.height = child_allocation.height + y +
- GTK_CONTAINER (frame)->border_width +
- GTK_WIDGET (frame)->style->klass->ythickness;
- aspect_frame->center_allocation.y = child_allocation.y - y;
-
- gtk_widget_size_allocate (bin->child, &child_allocation);
+
+ child_allocation->x = full_allocation.x + priv->xalign * (full_allocation.width - child_allocation->width);
+ child_allocation->y = full_allocation.y + priv->yalign * (full_allocation.height - child_allocation->height);
}
+ else
+ GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, child_allocation);
}
projects / ~andy / gtk / blobdiff