* 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* 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"
+
+#include "gtksizerequest.h"
+
+#include "gtkprivate.h"
#include "gtkintl.h"
+
+
+struct _GtkAspectFramePrivate
+{
+ GtkAllocation center_allocation;
+
+ gboolean obey_child;
+ gfloat xalign;
+ gfloat yalign;
+ gfloat ratio;
+};
+
+
enum {
PROP_0,
PROP_XALIGN,
PROP_OBEY_CHILD
};
-static void gtk_aspect_frame_class_init (GtkAspectFrameClass *klass);
-static void gtk_aspect_frame_init (GtkAspectFrame *aspect_frame);
static void gtk_aspect_frame_set_property (GObject *object,
guint prop_id,
const GValue *value,
#define MAX_RATIO 10000.0
#define MIN_RATIO 0.0001
-static GtkFrameClass *parent_class = NULL;
-
-GtkType
-gtk_aspect_frame_get_type (void)
-{
- static GtkType aspect_frame_type = 0;
-
- if (!aspect_frame_type)
- {
- static const GtkTypeInfo aspect_frame_info =
- {
- "GtkAspectFrame",
- sizeof (GtkAspectFrame),
- sizeof (GtkAspectFrameClass),
- (GtkClassInitFunc) gtk_aspect_frame_class_init,
- (GtkObjectInitFunc) gtk_aspect_frame_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) NULL,
- };
-
- aspect_frame_type = gtk_type_unique (GTK_TYPE_FRAME, &aspect_frame_info);
- }
-
- return aspect_frame_type;
-}
+G_DEFINE_TYPE (GtkAspectFrame, gtk_aspect_frame, GTK_TYPE_FRAME)
static void
gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
{
GObjectClass *gobject_class;
- GtkObjectClass *object_class;
GtkFrameClass *frame_class;
- parent_class = gtk_type_class (GTK_TYPE_FRAME);
-
gobject_class = (GObjectClass*) class;
- object_class = (GtkObjectClass*) class;
frame_class = (GtkFrameClass*) class;
gobject_class->set_property = gtk_aspect_frame_set_property;
g_object_class_install_property (gobject_class,
PROP_XALIGN,
g_param_spec_float ("xalign",
- _("Horizontal Alignment"),
- _("X alignment of the child"),
+ P_("Horizontal Alignment"),
+ P_("X alignment of the child"),
0.0, 1.0, 0.5,
- G_PARAM_READABLE | G_PARAM_WRITABLE ));
+ GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_YALIGN,
g_param_spec_float ("yalign",
- _("Vertical Alignment"),
- _("Y alignment of the child"),
+ P_("Vertical Alignment"),
+ P_("Y alignment of the child"),
0.0, 1.0, 0.5,
- G_PARAM_READABLE | G_PARAM_WRITABLE ));
+ GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_RATIO,
g_param_spec_float ("ratio",
- _("Ratio"),
- _("Aspect ratio if obey_child is FALSE"),
- 0.0, 1.0, 0.5,
- G_PARAM_READABLE | G_PARAM_WRITABLE ));
+ 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",
- _("Obey child"),
- _("Force aspect ratio to match that of the frame's child"),
+ g_param_spec_boolean ("obey-child",
+ P_("Obey child"),
+ P_("Force aspect ratio to match that of the frame's child"),
TRUE,
- G_PARAM_READABLE | G_PARAM_WRITABLE));
+ 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 = TRUE;
+ GtkAspectFramePrivate *priv;
+
+ aspect_frame->priv = G_TYPE_INSTANCE_GET_PRIVATE (aspect_frame,
+ GTK_TYPE_ASPECT_FRAME,
+ GtkAspectFramePrivate);
+ priv = aspect_frame->priv;
+
+ priv->xalign = 0.5;
+ priv->yalign = 0.5;
+ priv->ratio = 1.0;
+ priv->obey_child = TRUE;
}
static void
GParamSpec *pspec)
{
GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
switch (prop_id)
{
case PROP_XALIGN:
gtk_aspect_frame_set (aspect_frame,
g_value_get_float (value),
- aspect_frame->yalign,
- aspect_frame->ratio,
- aspect_frame->obey_child);
+ priv->yalign,
+ priv->ratio,
+ priv->obey_child);
break;
case PROP_YALIGN:
gtk_aspect_frame_set (aspect_frame,
- aspect_frame->xalign,
+ priv->xalign,
g_value_get_float (value),
- aspect_frame->ratio,
- aspect_frame->obey_child);
+ priv->ratio,
+ priv->obey_child);
break;
case PROP_RATIO:
gtk_aspect_frame_set (aspect_frame,
- aspect_frame->xalign,
- aspect_frame->yalign,
+ priv->xalign,
+ priv->yalign,
g_value_get_float (value),
- aspect_frame->obey_child);
+ priv->obey_child);
break;
case PROP_OBEY_CHILD:
gtk_aspect_frame_set (aspect_frame,
- aspect_frame->xalign,
- aspect_frame->yalign,
- aspect_frame->ratio,
+ priv->xalign,
+ priv->yalign,
+ priv->ratio,
g_value_get_boolean (value));
break;
default:
GParamSpec *pspec)
{
GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
switch (prop_id)
{
case PROP_XALIGN:
- g_value_set_float (value, aspect_frame->xalign);
+ g_value_set_float (value, priv->xalign);
break;
case PROP_YALIGN:
- g_value_set_float (value, aspect_frame->yalign);
+ g_value_set_float (value, priv->yalign);
break;
case PROP_RATIO:
- g_value_set_float (value, aspect_frame->ratio);
+ g_value_set_float (value, priv->ratio);
break;
case PROP_OBEY_CHILD:
- g_value_set_boolean (value, aspect_frame->obey_child);
+ g_value_set_boolean (value, priv->obey_child);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
+/**
+ * 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,
gboolean obey_child)
{
GtkAspectFrame *aspect_frame;
+ GtkAspectFramePrivate *priv;
+
+ aspect_frame = g_object_new (GTK_TYPE_ASPECT_FRAME, NULL);
- aspect_frame = gtk_type_new (gtk_aspect_frame_get_type ());
+ priv = aspect_frame->priv;
- 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 != FALSE;
+ 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;
gtk_frame_set_label (GTK_FRAME(aspect_frame), label);
return GTK_WIDGET (aspect_frame);
}
+/**
+ * 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 ratio,
gboolean obey_child)
{
- gboolean needs_resize = FALSE;
-
+ GtkAspectFramePrivate *priv;
+
g_return_if_fail (GTK_IS_ASPECT_FRAME (aspect_frame));
+
+ 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 (aspect_frame->xalign != xalign)
- {
- aspect_frame->xalign = xalign;
- g_object_notify (G_OBJECT (aspect_frame), "xalign");
- needs_resize = TRUE;
- }
- if (aspect_frame->yalign != yalign)
- {
- aspect_frame->yalign = yalign;
- g_object_notify (G_OBJECT (aspect_frame), "yalign");
- needs_resize = TRUE;
- }
- if (aspect_frame->ratio != ratio)
- {
- aspect_frame->ratio = ratio;
- g_object_notify (G_OBJECT (aspect_frame), "ratio");
- needs_resize = TRUE;
- }
- if (aspect_frame->obey_child != obey_child)
+ if (priv->xalign != xalign
+ || priv->yalign != yalign
+ || priv->ratio != ratio
+ || priv->obey_child != obey_child)
{
- aspect_frame->obey_child = obey_child;
- g_object_notify (G_OBJECT (aspect_frame), "obey_child");
- needs_resize = TRUE;
+ 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));
}
-
- if (needs_resize == TRUE)
- gtk_widget_queue_resize (GTK_WIDGET(aspect_frame));
}
static void
GtkAllocation *child_allocation)
{
GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (frame);
+ GtkAspectFramePrivate *priv = aspect_frame->priv;
GtkBin *bin = GTK_BIN (frame);
+ GtkWidget *child;
gdouble ratio;
- if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
+ child = gtk_bin_get_child (bin);
+ if (child && gtk_widget_get_visible (child))
{
GtkAllocation full_allocation;
- if (aspect_frame->obey_child)
+ if (priv->obey_child)
{
GtkRequisition child_requisition;
- gtk_widget_get_child_requisition (bin->child, &child_requisition);
+ gtk_widget_get_preferred_size (child, &child_requisition, NULL);
if (child_requisition.height != 0)
{
ratio = ((gdouble) child_requisition.width /
ratio = 1.0;
}
else
- ratio = aspect_frame->ratio;
+ ratio = priv->ratio;
- parent_class->compute_child_allocation (frame, &full_allocation);
+ GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, &full_allocation);
if (ratio * full_allocation.height > full_allocation.width)
{
child_allocation->height = full_allocation.height;
}
- child_allocation->x = full_allocation.x + aspect_frame->xalign * (full_allocation.width - child_allocation->width);
- child_allocation->y = full_allocation.y + aspect_frame->yalign * (full_allocation.height - child_allocation->height);
+ 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
- parent_class->compute_child_allocation (frame, child_allocation);
+ GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, child_allocation);
}
projects / ~andy / gtk / blobdiff