gtkaspectframe.c 10.1 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 "gtkprivate.h"
35
#include "gtkintl.h"
36
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
37

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

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

Matthias Clasen's avatar
Matthias Clasen committed
60
G_DEFINE_TYPE (GtkAspectFrame, gtk_aspect_frame, GTK_TYPE_FRAME)
Elliot Lee's avatar
Elliot Lee committed
61 62 63 64

static void
gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
{
65
  GObjectClass *gobject_class;
66
  GtkFrameClass *frame_class;
67
  
68 69
  gobject_class = (GObjectClass*) class;
  frame_class = (GtkFrameClass*) class;
70
  
71 72
  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
73

74
  frame_class->compute_child_allocation = gtk_aspect_frame_compute_child_allocation;
75

76 77 78
  g_object_class_install_property (gobject_class,
                                   PROP_XALIGN,
                                   g_param_spec_float ("xalign",
79 80
                                                       P_("Horizontal Alignment"),
                                                       P_("X alignment of the child"),
81
                                                       0.0, 1.0, 0.5,
82
                                                       GTK_PARAM_READWRITE));
83 84 85
  g_object_class_install_property (gobject_class,
                                   PROP_YALIGN,
                                   g_param_spec_float ("yalign",
86 87
                                                       P_("Vertical Alignment"),
                                                       P_("Y alignment of the child"),
88
                                                       0.0, 1.0, 0.5,
89
                                                       GTK_PARAM_READWRITE));
90 91 92
  g_object_class_install_property (gobject_class,
                                   PROP_RATIO,
                                   g_param_spec_float ("ratio",
93 94
                                                       P_("Ratio"),
                                                       P_("Aspect ratio if obey_child is FALSE"),
95
                                                       MIN_RATIO, MAX_RATIO, 1.0,
96
                                                       GTK_PARAM_READWRITE));
97 98
  g_object_class_install_property (gobject_class,
                                   PROP_OBEY_CHILD,
99
                                   g_param_spec_boolean ("obey-child",
100 101
                                                         P_("Obey child"),
                                                         P_("Force aspect ratio to match that of the frame's child"),
102
                                                         TRUE,
103
                                                         GTK_PARAM_READWRITE));
Elliot Lee's avatar
Elliot Lee committed
104 105 106 107 108 109 110 111
}

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

Tim Janik's avatar
Tim Janik committed
115 116 117 118 119
static void
gtk_aspect_frame_set_property (GObject         *object,
			       guint            prop_id,
			       const GValue    *value,
			       GParamSpec      *pspec)
120 121 122
{
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
  
123
  switch (prop_id)
124
    {
125 126
      /* g_object_notify is handled by the _frame_set function */
    case PROP_XALIGN:
127
      gtk_aspect_frame_set (aspect_frame,
128
			    g_value_get_float (value),
129 130 131 132
			    aspect_frame->yalign,
			    aspect_frame->ratio,
			    aspect_frame->obey_child);
      break;
133
    case PROP_YALIGN:
134 135
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
136
			    g_value_get_float (value),
137 138 139
			    aspect_frame->ratio,
			    aspect_frame->obey_child);
      break;
140
    case PROP_RATIO:
141 142 143
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
			    aspect_frame->yalign,
144
			    g_value_get_float (value),
145 146
			    aspect_frame->obey_child);
      break;
147
    case PROP_OBEY_CHILD:
148 149 150 151
      gtk_aspect_frame_set (aspect_frame,
			    aspect_frame->xalign,
			    aspect_frame->yalign,
			    aspect_frame->ratio,
152 153 154 155
			    g_value_get_boolean (value));
      break;
    default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
156 157 158 159
      break;
    }
}

Tim Janik's avatar
Tim Janik committed
160 161 162 163 164
static void
gtk_aspect_frame_get_property (GObject         *object,
			       guint            prop_id,
			       GValue          *value,
			       GParamSpec      *pspec)
165 166 167
{
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (object);
  
168
  switch (prop_id)
169
    {
170 171
    case PROP_XALIGN:
      g_value_set_float (value, aspect_frame->xalign);
172
      break;
173 174
    case PROP_YALIGN:
      g_value_set_float (value, aspect_frame->yalign);
175
      break;
176 177
    case PROP_RATIO:
      g_value_set_float (value, aspect_frame->ratio);
178
      break;
179 180
    case PROP_OBEY_CHILD:
      g_value_set_boolean (value, aspect_frame->obey_child);
181 182
      break;
    default:
183
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
184 185 186 187
      break;
    }
}

Elliot Lee's avatar
Elliot Lee committed
188 189
GtkWidget*
gtk_aspect_frame_new (const gchar *label,
190 191 192 193
		      gfloat       xalign,
		      gfloat       yalign,
		      gfloat       ratio,
		      gboolean     obey_child)
Elliot Lee's avatar
Elliot Lee committed
194 195 196
{
  GtkAspectFrame *aspect_frame;

Manish Singh's avatar
Manish Singh committed
197
  aspect_frame = g_object_new (GTK_TYPE_ASPECT_FRAME, NULL);
Elliot Lee's avatar
Elliot Lee committed
198 199 200 201

  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);
202
  aspect_frame->obey_child = obey_child != FALSE;
Elliot Lee's avatar
Elliot Lee committed
203 204 205 206 207 208 209 210

  gtk_frame_set_label (GTK_FRAME(aspect_frame), label);

  return GTK_WIDGET (aspect_frame);
}

void
gtk_aspect_frame_set (GtkAspectFrame *aspect_frame,
211 212 213 214
		      gfloat          xalign,
		      gfloat          yalign,
		      gfloat          ratio,
		      gboolean        obey_child)
Elliot Lee's avatar
Elliot Lee committed
215 216
{
  g_return_if_fail (GTK_IS_ASPECT_FRAME (aspect_frame));
217
  
Elliot Lee's avatar
Elliot Lee committed
218 219 220
  xalign = CLAMP (xalign, 0.0, 1.0);
  yalign = CLAMP (yalign, 0.0, 1.0);
  ratio = CLAMP (ratio, MIN_RATIO, MAX_RATIO);
221 222
  obey_child = obey_child != FALSE;
  
Hans Breuer's avatar
Hans Breuer committed
223 224 225 226
  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
227
    {
Hans Breuer's avatar
Hans Breuer committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
      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;
248
          g_object_notify (G_OBJECT (aspect_frame), "obey-child");
Hans Breuer's avatar
Hans Breuer committed
249 250 251
        }
      g_object_thaw_notify (G_OBJECT (aspect_frame));

252
      gtk_widget_queue_resize (GTK_WIDGET (aspect_frame));
Hans Breuer's avatar
Hans Breuer committed
253
    }
Elliot Lee's avatar
Elliot Lee committed
254 255 256
}

static void
257 258
gtk_aspect_frame_compute_child_allocation (GtkFrame      *frame,
					   GtkAllocation *child_allocation)
Elliot Lee's avatar
Elliot Lee committed
259
{
260 261
  GtkAspectFrame *aspect_frame = GTK_ASPECT_FRAME (frame);
  GtkBin *bin = GTK_BIN (frame);
Elliot Lee's avatar
Elliot Lee committed
262 263 264 265
  gdouble ratio;

  if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
    {
266 267
      GtkAllocation full_allocation;
      
Elliot Lee's avatar
Elliot Lee committed
268 269
      if (aspect_frame->obey_child)
	{
270 271 272 273
	  GtkRequisition child_requisition;

	  gtk_widget_get_child_requisition (bin->child, &child_requisition);
	  if (child_requisition.height != 0)
Elliot Lee's avatar
Elliot Lee committed
274
	    {
275 276 277 278
	      ratio = ((gdouble) child_requisition.width /
		       child_requisition.height);
	      if (ratio < MIN_RATIO)
		ratio = MIN_RATIO;
Elliot Lee's avatar
Elliot Lee committed
279
	    }
280
	  else if (child_requisition.width != 0)
281
	    ratio = MAX_RATIO;
Elliot Lee's avatar
Elliot Lee committed
282 283 284 285 286
	  else
	    ratio = 1.0;
	}
      else
	ratio = aspect_frame->ratio;
287

Matthias Clasen's avatar
Matthias Clasen committed
288
      GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, &full_allocation);
289
      
290
      if (ratio * full_allocation.height > full_allocation.width)
Elliot Lee's avatar
Elliot Lee committed
291
	{
292 293
	  child_allocation->width = full_allocation.width;
	  child_allocation->height = full_allocation.width / ratio + 0.5;
Elliot Lee's avatar
Elliot Lee committed
294
	}
Gnome CVS User's avatar
Gnome CVS User committed
295
      else
Elliot Lee's avatar
Elliot Lee committed
296
	{
297 298
	  child_allocation->width = ratio * full_allocation.height + 0.5;
	  child_allocation->height = full_allocation.height;
Elliot Lee's avatar
Elliot Lee committed
299
	}
300
      
301 302
      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
303
    }
304
  else
Matthias Clasen's avatar
Matthias Clasen committed
305
    GTK_FRAME_CLASS (gtk_aspect_frame_parent_class)->compute_child_allocation (frame, child_allocation);
Elliot Lee's avatar
Elliot Lee committed
306
}
307 308 309

#define __GTK_ASPECT_FRAME_C__
#include "gtkaliasdef.c"