gtkaspectframe.c 10.8 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkAspectFrame: Ensure that the child window has a specified aspect ratio
 *    or, if obey_child, has the same aspect ratio as its requested size
 *
 *     Copyright Owen Taylor                          4/9/97
 *
 * This library is free software; you can redistribute it and/or
10
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
11 12 13 14 15 16
 * 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
17
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
18
 *
19
 * You should have received a copy of the GNU Lesser General Public
20 21 22
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
23
 */
24 25

/*
26
 * Modified by the GTK+ Team and others 1997-2001.  See the AUTHORS
27 28 29 30 31
 * 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/. 
 */

32
#include <config.h>
Elliot Lee's avatar
Elliot Lee committed
33
#include "gtkaspectframe.h"
34
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
35

36
enum {
37 38 39 40 41
  PROP_0,
  PROP_XALIGN,
  PROP_YALIGN,
  PROP_RATIO,
  PROP_OBEY_CHILD
42 43
};

44 45
static void gtk_aspect_frame_class_init               (GtkAspectFrameClass *klass);
static void gtk_aspect_frame_init                     (GtkAspectFrame      *aspect_frame);
46 47 48
static void gtk_aspect_frame_set_property (GObject         *object,
					   guint            prop_id,
					   const GValue    *value,
Tim Janik's avatar
Tim Janik committed
49
					   GParamSpec      *pspec);
50 51 52
static void gtk_aspect_frame_get_property (GObject         *object,
					   guint            prop_id,
					   GValue          *value,
Tim Janik's avatar
Tim Janik committed
53
					   GParamSpec      *pspec);
54 55
static void gtk_aspect_frame_compute_child_allocation (GtkFrame            *frame,
						       GtkAllocation       *child_allocation);
Elliot Lee's avatar
Elliot Lee committed
56 57 58 59

#define MAX_RATIO 10000.0
#define MIN_RATIO 0.0001

60 61
static GtkFrameClass *parent_class = NULL;

Manish Singh's avatar
Manish Singh committed
62
GType
63
gtk_aspect_frame_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
64
{
Manish Singh's avatar
Manish Singh committed
65
  static GType aspect_frame_type = 0;
66
  
Elliot Lee's avatar
Elliot Lee committed
67 68
  if (!aspect_frame_type)
    {
Manish Singh's avatar
Manish Singh committed
69
      static const GTypeInfo aspect_frame_info =
Elliot Lee's avatar
Elliot Lee committed
70 71
      {
	sizeof (GtkAspectFrameClass),
Manish Singh's avatar
Manish Singh committed
72 73 74 75 76 77 78 79
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_aspect_frame_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkAspectFrame),
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_aspect_frame_init,
Elliot Lee's avatar
Elliot Lee committed
80
      };
81
      
Manish Singh's avatar
Manish Singh committed
82 83 84
      aspect_frame_type =
	g_type_register_static (GTK_TYPE_FRAME, "GtkAspectFrame",
				&aspect_frame_info, 0);
Elliot Lee's avatar
Elliot Lee committed
85
    }
86
  
Elliot Lee's avatar
Elliot Lee committed
87 88 89 90 91 92
  return aspect_frame_type;
}

static void
gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
{
93
  GObjectClass *gobject_class;
94
  GtkFrameClass *frame_class;
95
  
Manish Singh's avatar
Manish Singh committed
96
  parent_class = g_type_class_peek_parent (class);
97

98 99
  gobject_class = (GObjectClass*) class;
  frame_class = (GtkFrameClass*) class;
100
  
101 102
  gobject_class->set_property = gtk_aspect_frame_set_property;
  gobject_class->get_property = gtk_aspect_frame_get_property;
Elliot Lee's avatar
Elliot Lee committed
103

104
  frame_class->compute_child_allocation = gtk_aspect_frame_compute_child_allocation;
105

106 107 108
  g_object_class_install_property (gobject_class,
                                   PROP_XALIGN,
                                   g_param_spec_float ("xalign",
109 110
                                                       P_("Horizontal Alignment"),
                                                       P_("X alignment of the child"),
111 112 113 114 115
                                                       0.0, 1.0, 0.5,
                                                       G_PARAM_READABLE | G_PARAM_WRITABLE ));
  g_object_class_install_property (gobject_class,
                                   PROP_YALIGN,
                                   g_param_spec_float ("yalign",
116 117
                                                       P_("Vertical Alignment"),
                                                       P_("Y alignment of the child"),
118 119 120 121 122
                                                       0.0, 1.0, 0.5,
                                                       G_PARAM_READABLE | G_PARAM_WRITABLE ));
  g_object_class_install_property (gobject_class,
                                   PROP_RATIO,
                                   g_param_spec_float ("ratio",
123 124
                                                       P_("Ratio"),
                                                       P_("Aspect ratio if obey_child is FALSE"),
125
                                                       MIN_RATIO, MAX_RATIO, 0.5,
126 127 128 129
                                                       G_PARAM_READABLE | G_PARAM_WRITABLE ));
  g_object_class_install_property (gobject_class,
                                   PROP_OBEY_CHILD,
                                   g_param_spec_boolean ("obey_child",
130 131
                                                         P_("Obey child"),
                                                         P_("Force aspect ratio to match that of the frame's child"),
132 133
                                                         TRUE,
                                                         G_PARAM_READABLE | G_PARAM_WRITABLE));
Elliot Lee's avatar
Elliot Lee committed
134 135 136 137 138 139 140 141
}

static void
gtk_aspect_frame_init (GtkAspectFrame *aspect_frame)
{
  aspect_frame->xalign = 0.5;
  aspect_frame->yalign = 0.5;
  aspect_frame->ratio = 1.0;
142
  aspect_frame->obey_child = TRUE;
Elliot Lee's avatar
Elliot Lee committed
143 144
}

Tim Janik's avatar
Tim Janik committed
145 146 147 148 149
static void
gtk_aspect_frame_set_property (GObject         *object,
			       guint            prop_id,
			       const GValue    *value,
			       GParamSpec      *pspec)
150 151 152
{
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
  
153
  switch (prop_id)
154
    {
155 156
      /* g_object_notify is handled by the _frame_set function */
    case PROP_XALIGN:
157
      gtk_aspect_frame_set (aspect_frame,
158
			    g_value_get_float (value),
159 160 161 162
			    aspect_frame->yalign,
			    aspect_frame->ratio,
			    aspect_frame->obey_child);
      break;
163
    case PROP_YALIGN:
164 165
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
166
			    g_value_get_float (value),
167 168 169
			    aspect_frame->ratio,
			    aspect_frame->obey_child);
      break;
170
    case PROP_RATIO:
171 172 173
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
			    aspect_frame->yalign,
174
			    g_value_get_float (value),
175 176
			    aspect_frame->obey_child);
      break;
177
    case PROP_OBEY_CHILD:
178 179 180 181
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
			    aspect_frame->yalign,
			    aspect_frame->ratio,
182 183 184 185
			    g_value_get_boolean (value));
      break;
    default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
186 187 188 189
      break;
    }
}

Tim Janik's avatar
Tim Janik committed
190 191 192 193 194
static void
gtk_aspect_frame_get_property (GObject         *object,
			       guint            prop_id,
			       GValue          *value,
			       GParamSpec      *pspec)
195 196 197
{
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
  
198
  switch (prop_id)
199
    {
200 201
    case PROP_XALIGN:
      g_value_set_float (value, aspect_frame->xalign);
202
      break;
203 204
    case PROP_YALIGN:
      g_value_set_float (value, aspect_frame->yalign);
205
      break;
206 207
    case PROP_RATIO:
      g_value_set_float (value, aspect_frame->ratio);
208
      break;
209 210
    case PROP_OBEY_CHILD:
      g_value_set_boolean (value, aspect_frame->obey_child);
211 212
      break;
    default:
213
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
214 215 216 217
      break;
    }
}

Elliot Lee's avatar
Elliot Lee committed
218 219
GtkWidget*
gtk_aspect_frame_new (const gchar *label,
220 221 222 223
		      gfloat       xalign,
		      gfloat       yalign,
		      gfloat       ratio,
		      gboolean     obey_child)
Elliot Lee's avatar
Elliot Lee committed
224 225 226
{
  GtkAspectFrame *aspect_frame;

Manish Singh's avatar
Manish Singh committed
227
  aspect_frame = g_object_new (GTK_TYPE_ASPECT_FRAME, NULL);
Elliot Lee's avatar
Elliot Lee committed
228 229 230 231

  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);
232
  aspect_frame->obey_child = obey_child != FALSE;
Elliot Lee's avatar
Elliot Lee committed
233 234 235 236 237 238 239 240

  gtk_frame_set_label (GTK_FRAME(aspect_frame), label);

  return GTK_WIDGET (aspect_frame);
}

void
gtk_aspect_frame_set (GtkAspectFrame *aspect_frame,
241 242 243 244
		      gfloat          xalign,
		      gfloat          yalign,
		      gfloat          ratio,
		      gboolean        obey_child)
Elliot Lee's avatar
Elliot Lee committed
245 246
{
  g_return_if_fail (GTK_IS_ASPECT_FRAME (aspect_frame));
247
  
Elliot Lee's avatar
Elliot Lee committed
248 249 250
  xalign = CLAMP (xalign, 0.0, 1.0);
  yalign = CLAMP (yalign, 0.0, 1.0);
  ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
251 252
  obey_child = obey_child != FALSE;
  
Hans Breuer's avatar
Hans Breuer committed
253 254 255 256
  if (   (aspect_frame->xalign != xalign)
      || (aspect_frame->yalign != yalign)
      || (aspect_frame->ratio != ratio)
      || (aspect_frame->obey_child != obey_child))
Elliot Lee's avatar
Elliot Lee committed
257
    {
Hans Breuer's avatar
Hans Breuer committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
      g_object_freeze_notify (G_OBJECT (aspect_frame));

      if (aspect_frame->xalign != xalign)
        {
          aspect_frame->xalign = xalign;
          g_object_notify (G_OBJECT (aspect_frame), "xalign");
        }
      if (aspect_frame->yalign != yalign)
        {
          aspect_frame->yalign = yalign;
          g_object_notify (G_OBJECT (aspect_frame), "yalign");
        }
      if (aspect_frame->ratio != ratio)
        {
          aspect_frame->ratio = ratio;
          g_object_notify (G_OBJECT (aspect_frame), "ratio");
        }
      if (aspect_frame->obey_child != obey_child)
        {
          aspect_frame->obey_child = obey_child;
          g_object_notify (G_OBJECT (aspect_frame), "obey_child");
        }
      g_object_thaw_notify (G_OBJECT (aspect_frame));

282
      gtk_widget_queue_resize (GTK_WIDGET (aspect_frame));
Hans Breuer's avatar
Hans Breuer committed
283
    }
Elliot Lee's avatar
Elliot Lee committed
284 285 286
}

static void
287 288
gtk_aspect_frame_compute_child_allocation (GtkFrame      *frame,
					   GtkAllocation *child_allocation)
Elliot Lee's avatar
Elliot Lee committed
289
{
290 291
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (frame);
  GtkBin *bin = GTK_BIN (frame);
Elliot Lee's avatar
Elliot Lee committed
292 293 294 295
  gdouble ratio;

  if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
    {
296 297
      GtkAllocation full_allocation;
      
Elliot Lee's avatar
Elliot Lee committed
298 299
      if (aspect_frame->obey_child)
	{
300 301 302 303
	  GtkRequisition child_requisition;

	  gtk_widget_get_child_requisition (bin->child, &child_requisition);
	  if (child_requisition.height != 0)
Elliot Lee's avatar
Elliot Lee committed
304
	    {
305 306 307 308
	      ratio = ((gdouble) child_requisition.width /
		       child_requisition.height);
	      if (ratio < MIN_RATIO)
		ratio = MIN_RATIO;
Elliot Lee's avatar
Elliot Lee committed
309
	    }
310
	  else if (child_requisition.width != 0)
311
	    ratio = MAX_RATIO;
Elliot Lee's avatar
Elliot Lee committed
312 313 314 315 316
	  else
	    ratio = 1.0;
	}
      else
	ratio = aspect_frame->ratio;
317 318

      parent_class->compute_child_allocation (frame, &full_allocation);
319
      
320
      if (ratio * full_allocation.height > full_allocation.width)
Elliot Lee's avatar
Elliot Lee committed
321
	{
322 323
	  child_allocation->width = full_allocation.width;
	  child_allocation->height = full_allocation.width / ratio + 0.5;
Elliot Lee's avatar
Elliot Lee committed
324
	}
Gnome CVS User's avatar
Gnome CVS User committed
325
      else
Elliot Lee's avatar
Elliot Lee committed
326
	{
327 328
	  child_allocation->width = ratio * full_allocation.height + 0.5;
	  child_allocation->height = full_allocation.height;
Elliot Lee's avatar
Elliot Lee committed
329
	}
330
      
331 332
      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);
Elliot Lee's avatar
Elliot Lee committed
333
    }
334 335
  else
    parent_class->compute_child_allocation (frame, child_allocation);
Elliot Lee's avatar
Elliot Lee committed
336
}