gtkbbox.c 15 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* 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
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * 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
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * 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/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27
#include "gtkbbox.h"
Havoc Pennington's avatar
Havoc Pennington committed
28
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
29

30 31 32 33 34
enum {
  PROP_0,
  PROP_LAYOUT_STYLE,
  PROP_LAST
};
Elliot Lee's avatar
Elliot Lee committed
35

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
enum {
  CHILD_PROP_0,
  CHILD_PROP_SECONDARY
};

static void gtk_button_box_class_init         (GtkButtonBoxClass *klass);
static void gtk_button_box_init               (GtkButtonBox      *box);
static void gtk_button_box_set_property       (GObject           *object,
					       guint              prop_id,
					       const GValue      *value,
					       GParamSpec        *pspec);
static void gtk_button_box_get_property       (GObject           *object,
					       guint              prop_id,
					       GValue            *value,
					       GParamSpec        *pspec);
static void gtk_button_box_set_child_property (GtkContainer      *container,
					       GtkWidget         *child,
					       guint              property_id,
					       const GValue      *value,
					       GParamSpec        *pspec);
static void gtk_button_box_get_child_property (GtkContainer      *container,
					       GtkWidget         *child,
					       guint              property_id,
					       GValue            *value,
					       GParamSpec        *pspec);
Elliot Lee's avatar
Elliot Lee committed
61

Havoc Pennington's avatar
Havoc Pennington committed
62 63
#define DEFAULT_CHILD_MIN_WIDTH 85
#define DEFAULT_CHILD_MIN_HEIGHT 27
64
#define DEFAULT_CHILD_IPAD_X 4
Havoc Pennington's avatar
Havoc Pennington committed
65
#define DEFAULT_CHILD_IPAD_Y 0
Elliot Lee's avatar
Elliot Lee committed
66

Manish Singh's avatar
Manish Singh committed
67
GType
68
gtk_button_box_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
69
{
Manish Singh's avatar
Manish Singh committed
70
  static GType button_box_type = 0;
Elliot Lee's avatar
Elliot Lee committed
71 72 73

  if (!button_box_type)
    {
74
      static const GTypeInfo button_box_info =
Elliot Lee's avatar
Elliot Lee committed
75 76
      {
	sizeof (GtkButtonBoxClass),
Manish Singh's avatar
Manish Singh committed
77 78
	NULL,		/* base_init */
	NULL,		/* base_finalize */
79
	(GClassInitFunc) gtk_button_box_class_init,
Manish Singh's avatar
Manish Singh committed
80 81
	NULL,		/* class_finalize */
	NULL,		/* class_data */
82 83 84
	sizeof (GtkButtonBox),
	0,               /* n_preallocs */
	(GInstanceInitFunc) gtk_button_box_init,
Manish Singh's avatar
Manish Singh committed
85
	NULL,		/* value_table */
Elliot Lee's avatar
Elliot Lee committed
86 87
      };

Manish Singh's avatar
Manish Singh committed
88 89 90
      button_box_type =
	g_type_register_static (GTK_TYPE_BOX, "GtkButtonBox",
				&button_box_info, G_TYPE_FLAG_ABSTRACT);
Elliot Lee's avatar
Elliot Lee committed
91 92 93 94 95 96 97 98 99
    }

  return button_box_type;
}

static void
gtk_button_box_class_init (GtkButtonBoxClass *class)
{
  GtkWidgetClass *widget_class;
100
  GObjectClass *gobject_class;
101
  GtkContainerClass *container_class;
Elliot Lee's avatar
Elliot Lee committed
102

103
  gobject_class = G_OBJECT_CLASS (class);
Elliot Lee's avatar
Elliot Lee committed
104
  widget_class = (GtkWidgetClass*) class;
105
  container_class = (GtkContainerClass*) class;
106

107 108
  gobject_class->set_property = gtk_button_box_set_property;
  gobject_class->get_property = gtk_button_box_get_property;
109 110 111

  container_class->set_child_property = gtk_button_box_set_child_property;
  container_class->get_child_property = gtk_button_box_get_child_property;
112
  
113 114 115
  /* FIXME we need to override the "spacing" property on GtkBox once
   * libgobject allows that.
   */
Havoc Pennington's avatar
Havoc Pennington committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_min_width",
							     _("Minimum child width"),
							     _("Minimum width of buttons inside the box"),
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_MIN_WIDTH,
							     G_PARAM_READABLE));

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_min_height",
							     _("Minimum child height"),
							     _("Minimum height of buttons inside the box"),
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_MIN_HEIGHT,
							     G_PARAM_READABLE));

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_internal_pad_x",
							     _("Child internal width padding"),
							     _("Amount to increase child's size on either side"),
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_IPAD_X,
							     G_PARAM_READABLE));

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_internal_pad_y",
							     _("Child internal height padding"),
							     _("Amount to increase child's size on the top and bottom"),
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_IPAD_Y,
							     G_PARAM_READABLE));
152 153 154 155 156 157 158 159
  g_object_class_install_property (gobject_class,
                                   PROP_LAYOUT_STYLE,
                                   g_param_spec_enum ("layout_style",
                                                      _("Layout style"),
                                                      _("How to layout the buttons in the box. Possible values are default, spread, edge, start and end"),
						      GTK_TYPE_BUTTON_BOX_STYLE,
						      GTK_BUTTONBOX_DEFAULT_STYLE,
                                                      G_PARAM_READWRITE));
160 161 162 163 164

  gtk_container_class_install_child_property (container_class,
					      CHILD_PROP_SECONDARY,
					      g_param_spec_boolean ("secondary", 
								    _("Secondary"),
Soren Sandmann's avatar
Soren Sandmann committed
165
								    _("If TRUE, the child appears in a secondary group of children, suitable for, e.g., help buttons"),
166 167
								    FALSE,
								    G_PARAM_READWRITE));
Elliot Lee's avatar
Elliot Lee committed
168 169 170 171 172
}

static void
gtk_button_box_init (GtkButtonBox *button_box)
{
173
  GTK_BOX (button_box)->spacing = 0;
Elliot Lee's avatar
Elliot Lee committed
174 175 176 177
  button_box->child_min_width = GTK_BUTTONBOX_DEFAULT;
  button_box->child_min_height = GTK_BUTTONBOX_DEFAULT;
  button_box->child_ipad_x = GTK_BUTTONBOX_DEFAULT;
  button_box->child_ipad_y = GTK_BUTTONBOX_DEFAULT;
178
  button_box->layout_style = GTK_BUTTONBOX_DEFAULT_STYLE;
Elliot Lee's avatar
Elliot Lee committed
179 180
}

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
static void
gtk_button_box_set_property (GObject         *object,
			     guint            prop_id,
			     const GValue    *value,
			     GParamSpec      *pspec)
{
  switch (prop_id) 
    {
    case PROP_LAYOUT_STYLE:
      gtk_button_box_set_layout (GTK_BUTTON_BOX (object),
				 g_value_get_enum (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_button_box_get_property (GObject         *object,
			     guint            prop_id,
			     GValue          *value,
			     GParamSpec      *pspec)
{
  switch (prop_id)
    {
    case PROP_LAYOUT_STYLE:
      g_value_set_enum (value, GTK_BUTTON_BOX (object)->layout_style);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
static void
gtk_button_box_set_child_property (GtkContainer    *container,
				   GtkWidget       *child,
				   guint            property_id,
				   const GValue    *value,
				   GParamSpec      *pspec)
{
  switch (property_id)
    {
    case CHILD_PROP_SECONDARY:
      gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (container), child,
					  g_value_get_boolean (value));
      break;
    default:
      GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
      break;
    }
}

static void
gtk_button_box_get_child_property (GtkContainer *container,
				   GtkWidget    *child,
				   guint         property_id,
				   GValue       *value,
				   GParamSpec   *pspec)
{
  switch (property_id)
    {
    case CHILD_PROP_SECONDARY:
Matthias Clasen's avatar
Matthias Clasen committed
245 246 247
      g_value_set_boolean (value, 
			   gtk_button_box_get_child_secondary (GTK_BUTTON_BOX (container), 
							       child));
248 249 250 251 252 253
      break;
    default:
      GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
      break;
    }
}
254

Elliot Lee's avatar
Elliot Lee committed
255 256
/* set per widget values for spacing, child size and child internal padding */

257 258 259
void 
gtk_button_box_set_child_size (GtkButtonBox *widget, 
                               gint width, gint height)
Elliot Lee's avatar
Elliot Lee committed
260
{
261 262
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));

Elliot Lee's avatar
Elliot Lee committed
263 264 265 266
  widget->child_min_width = width;
  widget->child_min_height = height;
}

267 268 269
void 
gtk_button_box_set_child_ipadding (GtkButtonBox *widget,
                                   gint ipad_x, gint ipad_y)
Elliot Lee's avatar
Elliot Lee committed
270
{
271 272
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));

Elliot Lee's avatar
Elliot Lee committed
273 274 275 276
  widget->child_ipad_x = ipad_x;
  widget->child_ipad_y = ipad_y;
}

277 278 279
void
gtk_button_box_set_layout (GtkButtonBox      *widget, 
                           GtkButtonBoxStyle  layout_style)
Elliot Lee's avatar
Elliot Lee committed
280
{
281
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));
282 283 284
  g_return_if_fail (layout_style >= GTK_BUTTONBOX_DEFAULT_STYLE &&
		    layout_style <= GTK_BUTTONBOX_END);

285 286 287 288 289 290
  if (widget->layout_style != layout_style)
    {
      widget->layout_style = layout_style;
      g_object_notify (G_OBJECT (widget), "layout_style");
      gtk_widget_queue_resize (GTK_WIDGET (widget));
    }
Elliot Lee's avatar
Elliot Lee committed
291 292 293 294 295
}


/* get per widget values for spacing, child size and child internal padding */

296 297 298
void 
gtk_button_box_get_child_size (GtkButtonBox *widget,
                               gint *width, gint *height)
Elliot Lee's avatar
Elliot Lee committed
299
{
300 301 302 303
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));
  g_return_if_fail (width != NULL);
  g_return_if_fail (height != NULL);

Elliot Lee's avatar
Elliot Lee committed
304 305 306 307
  *width  = widget->child_min_width;
  *height = widget->child_min_height;
}

308 309 310
void
gtk_button_box_get_child_ipadding (GtkButtonBox *widget,
                                   gint* ipad_x, gint *ipad_y)
Elliot Lee's avatar
Elliot Lee committed
311
{
312 313 314 315
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));
  g_return_if_fail (ipad_x != NULL);
  g_return_if_fail (ipad_y != NULL);

Elliot Lee's avatar
Elliot Lee committed
316 317 318 319
  *ipad_x = widget->child_ipad_x;
  *ipad_y = widget->child_ipad_y;
}

320 321
GtkButtonBoxStyle 
gtk_button_box_get_layout (GtkButtonBox *widget)
Elliot Lee's avatar
Elliot Lee committed
322
{
323 324
  g_return_val_if_fail (GTK_IS_BUTTON_BOX (widget), GTK_BUTTONBOX_SPREAD);
  
Elliot Lee's avatar
Elliot Lee committed
325 326 327
  return widget->layout_style;
}

Matthias Clasen's avatar
Matthias Clasen committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
/**
 * gtk_button_box_get_child_secondary:
 * @widget: a #GtkButtonBox
 * @child: a child of @widget 
 * 
 * Returns whether @child should appear in a secondary group of children.
 *
 * Return value: whether @child should appear in a secondary group of children.
 *
 * Since: 2.4
 **/
gboolean 
gtk_button_box_get_child_secondary (GtkButtonBox *widget,
				    GtkWidget    *child)
{
  GList *list;
  GtkBoxChild *child_info;

346 347
  g_return_val_if_fail (GTK_IS_BUTTON_BOX (widget), FALSE);
  g_return_val_if_fail (GTK_IS_WIDGET (child), FALSE);
Matthias Clasen's avatar
Matthias Clasen committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

  child_info = NULL;
  list = GTK_BOX (widget)->children;
  while (list)
    {
      child_info = list->data;
      if (child_info->widget == child)
	break;

      list = list->next;
    }

  g_return_val_if_fail (list != NULL, FALSE);

  return child_info->is_secondary;
}

365 366 367 368 369 370 371 372 373 374 375 376 377 378
/**
 * gtk_button_box_set_child_secondary
 * @widget: a #GtkButtonBox
 * @child: a child of @widget
 * @is_secondary: if %TRUE, the @child appears in a secondary group of the
 *                button box.
 *
 * Sets whether @child should appear in a secondary group of children.
 * A typical use of a secondary child is the help button in a dialog.
 *
 * This group appears after the other children if the style
 * is %GTK_BUTTONBOX_START, %GTK_BUTTONBOX_SPREAD or
 * %GTK_BUTTONBOX_EDGE, and before the the other children if the style
 * is %GTK_BUTTONBOX_END. For horizontal button boxes, the definition
Matthias Clasen's avatar
Matthias Clasen committed
379 380 381
 * of before/after depends on direction of the widget (see
 * gtk_widget_set_direction()). If the style is %GTK_BUTTONBOX_START
 * or %GTK_BUTTONBOX_END, then the secondary children are aligned at
382 383 384 385 386 387 388 389 390 391 392 393 394
 * the other end of the button box from the main children. For the
 * other styles, they appear immediately next to the main children.
 **/
void 
gtk_button_box_set_child_secondary (GtkButtonBox *widget, 
				    GtkWidget    *child,
				    gboolean      is_secondary)
{
  GList *list;
  
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));
  g_return_if_fail (GTK_IS_WIDGET (child));
  g_return_if_fail (child->parent == GTK_WIDGET (widget));
Elliot Lee's avatar
Elliot Lee committed
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
  list = GTK_BOX (widget)->children;
  while (list)
    {
      GtkBoxChild *child_info = list->data;
      if (child_info->widget == child)
	{
	  child_info->is_secondary = is_secondary;
	  break;
	}

      list = list->next;
    }

  gtk_widget_child_notify (child, "secondary");

  if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (child))
    gtk_widget_queue_resize (child);
}
Elliot Lee's avatar
Elliot Lee committed
414 415 416 417 418

/* Ask children how much space they require and round up 
   to match minimum size and internal padding.
   Returns the size each single child should have. */
void
419
_gtk_button_box_child_requisition (GtkWidget *widget,
420 421 422 423
                                   int       *nvis_children,
				   int       *nvis_secondaries,
                                   int       *width,
                                   int       *height)
Elliot Lee's avatar
Elliot Lee committed
424 425 426 427 428
{
  GtkButtonBox *bbox;
  GtkBoxChild *child;
  GList *children;
  gint nchildren;
429
  gint nsecondaries;
Elliot Lee's avatar
Elliot Lee committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
  gint needed_width;
  gint needed_height;
  GtkRequisition child_requisition;
  gint ipad_w;
  gint ipad_h;
  gint width_default;
  gint height_default;
  gint ipad_x_default;
  gint ipad_y_default;
  
  gint child_min_width;
  gint child_min_height;
  gint ipad_x;
  gint ipad_y;
  
  g_return_if_fail (GTK_IS_BUTTON_BOX (widget));

  bbox = GTK_BUTTON_BOX (widget);

Havoc Pennington's avatar
Havoc Pennington committed
449 450 451 452 453 454 455 456 457
  gtk_widget_style_get (widget,
                        "child_min_width",
                        &width_default,
                        "child_min_height",
                        &height_default,
                        "child_internal_pad_x",
                        &ipad_x_default,
                        "child_internal_pad_y",
                        &ipad_y_default, NULL);
Elliot Lee's avatar
Elliot Lee committed
458 459 460 461 462 463 464 465 466 467 468
  
  child_min_width = bbox->child_min_width   != GTK_BUTTONBOX_DEFAULT
	  ? bbox->child_min_width : width_default;
  child_min_height = bbox->child_min_height !=GTK_BUTTONBOX_DEFAULT
	  ? bbox->child_min_height : height_default;
  ipad_x = bbox->child_ipad_x != GTK_BUTTONBOX_DEFAULT
	  ? bbox->child_ipad_x : ipad_x_default;
  ipad_y = bbox->child_ipad_y != GTK_BUTTONBOX_DEFAULT
	  ? bbox->child_ipad_y : ipad_y_default;

  nchildren = 0;
469
  nsecondaries = 0;
Elliot Lee's avatar
Elliot Lee committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  children = GTK_BOX(bbox)->children;
  needed_width = child_min_width;
  needed_height = child_min_height;  
  ipad_w = ipad_x * 2;
  ipad_h = ipad_y * 2;
  
  while (children)
    {
      child = children->data;
      children = children->next;

      if (GTK_WIDGET_VISIBLE (child->widget))
	{
	  nchildren += 1;
	  gtk_widget_size_request (child->widget, &child_requisition);
485
	  
Elliot Lee's avatar
Elliot Lee committed
486
	  if (child_requisition.width + ipad_w > needed_width)
487
	    needed_width = child_requisition.width + ipad_w;
Elliot Lee's avatar
Elliot Lee committed
488
	  if (child_requisition.height + ipad_h > needed_height)
489 490 491
	    needed_height = child_requisition.height + ipad_h;
	  if (child->is_secondary)
	    nsecondaries++;
Elliot Lee's avatar
Elliot Lee committed
492 493
	}
    }
494 495 496 497 498 499 500 501 502

  if (nvis_children)
    *nvis_children = nchildren;
  if (nvis_secondaries)
    *nvis_secondaries = nsecondaries;
  if (width)
    *width = needed_width;
  if (height)
    *height = needed_height;
Elliot Lee's avatar
Elliot Lee committed
503
}