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/. 
 */

27
#include <config.h>
Elliot Lee's avatar
Elliot Lee committed
28
#include "gtkbbox.h"
29
#include "gtkprivate.h"
Havoc Pennington's avatar
Havoc Pennington committed
30
#include "gtkintl.h"
31
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
32

33 34 35 36 37
enum {
  PROP_0,
  PROP_LAYOUT_STYLE,
  PROP_LAST
};
Elliot Lee's avatar
Elliot Lee committed
38

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
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
64

Havoc Pennington's avatar
Havoc Pennington committed
65 66
#define DEFAULT_CHILD_MIN_WIDTH 85
#define DEFAULT_CHILD_MIN_HEIGHT 27
67
#define DEFAULT_CHILD_IPAD_X 4
Havoc Pennington's avatar
Havoc Pennington committed
68
#define DEFAULT_CHILD_IPAD_Y 0
Elliot Lee's avatar
Elliot Lee committed
69

Manish Singh's avatar
Manish Singh committed
70
GType
71
gtk_button_box_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
72
{
Manish Singh's avatar
Manish Singh committed
73
  static GType button_box_type = 0;
Elliot Lee's avatar
Elliot Lee committed
74 75 76

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

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

  return button_box_type;
}

static void
gtk_button_box_class_init (GtkButtonBoxClass *class)
{
  GtkWidgetClass *widget_class;
103
  GObjectClass *gobject_class;
104
  GtkContainerClass *container_class;
Elliot Lee's avatar
Elliot Lee committed
105

106
  gobject_class = G_OBJECT_CLASS (class);
Elliot Lee's avatar
Elliot Lee committed
107
  widget_class = (GtkWidgetClass*) class;
108
  container_class = (GtkContainerClass*) class;
109

110 111
  gobject_class->set_property = gtk_button_box_set_property;
  gobject_class->get_property = gtk_button_box_get_property;
112 113 114

  container_class->set_child_property = gtk_button_box_set_child_property;
  container_class->get_child_property = gtk_button_box_get_child_property;
115
  
116 117 118
  /* FIXME we need to override the "spacing" property on GtkBox once
   * libgobject allows that.
   */
Havoc Pennington's avatar
Havoc Pennington committed
119
  gtk_widget_class_install_style_property (widget_class,
120
					   g_param_spec_int ("child-min-width",
121 122
							     P_("Minimum child width"),
							     P_("Minimum width of buttons inside the box"),
Havoc Pennington's avatar
Havoc Pennington committed
123 124 125
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_MIN_WIDTH,
126
							     GTK_PARAM_READABLE));
Havoc Pennington's avatar
Havoc Pennington committed
127 128

  gtk_widget_class_install_style_property (widget_class,
129
					   g_param_spec_int ("child-min-height",
130 131
							     P_("Minimum child height"),
							     P_("Minimum height of buttons inside the box"),
Havoc Pennington's avatar
Havoc Pennington committed
132 133 134
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_MIN_HEIGHT,
135
							     GTK_PARAM_READABLE));
Havoc Pennington's avatar
Havoc Pennington committed
136 137

  gtk_widget_class_install_style_property (widget_class,
138
					   g_param_spec_int ("child-internal-pad-x",
139 140
							     P_("Child internal width padding"),
							     P_("Amount to increase child's size on either side"),
Havoc Pennington's avatar
Havoc Pennington committed
141 142 143
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_IPAD_X,
144
							     GTK_PARAM_READABLE));
Havoc Pennington's avatar
Havoc Pennington committed
145 146

  gtk_widget_class_install_style_property (widget_class,
147
					   g_param_spec_int ("child-internal-pad-y",
148 149
							     P_("Child internal height padding"),
							     P_("Amount to increase child's size on the top and bottom"),
Havoc Pennington's avatar
Havoc Pennington committed
150 151 152
							     0,
							     G_MAXINT,
                                                             DEFAULT_CHILD_IPAD_Y,
153
							     GTK_PARAM_READABLE));
154 155
  g_object_class_install_property (gobject_class,
                                   PROP_LAYOUT_STYLE,
156
                                   g_param_spec_enum ("layout-style",
157 158
                                                      P_("Layout style"),
                                                      P_("How to layout the buttons in the box. Possible values are default, spread, edge, start and end"),
159 160
						      GTK_TYPE_BUTTON_BOX_STYLE,
						      GTK_BUTTONBOX_DEFAULT_STYLE,
161
                                                      GTK_PARAM_READWRITE));
162 163 164 165

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

static void
gtk_button_box_init (GtkButtonBox *button_box)
{
175
  GTK_BOX (button_box)->spacing = 0;
Elliot Lee's avatar
Elliot Lee committed
176 177 178 179
  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;
180
  button_box->layout_style = GTK_BUTTONBOX_DEFAULT_STYLE;
Elliot Lee's avatar
Elliot Lee committed
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 216 217
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;
    }
}

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 245 246
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
247 248 249
      g_value_set_boolean (value, 
			   gtk_button_box_get_child_secondary (GTK_BUTTON_BOX (container), 
							       child));
250 251 252 253 254 255
      break;
    default:
      GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
      break;
    }
}
256

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

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

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

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

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

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

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


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

298 299 300
void 
gtk_button_box_get_child_size (GtkButtonBox *widget,
                               gint *width, gint *height)
Elliot Lee's avatar
Elliot Lee committed
301
{
302 303 304 305
  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
306 307 308 309
  *width  = widget->child_min_width;
  *height = widget->child_min_height;
}

310 311 312
void
gtk_button_box_get_child_ipadding (GtkButtonBox *widget,
                                   gint* ipad_x, gint *ipad_y)
Elliot Lee's avatar
Elliot Lee committed
313
{
314 315 316 317
  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
318 319 320 321
  *ipad_x = widget->child_ipad_x;
  *ipad_y = widget->child_ipad_y;
}

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

Matthias Clasen's avatar
Matthias Clasen committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
/**
 * 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;

348 349
  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
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366

  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;
}

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
379
 * %GTK_BUTTONBOX_EDGE, and before the other children if the style
380
 * is %GTK_BUTTONBOX_END. For horizontal button boxes, the definition
Matthias Clasen's avatar
Matthias Clasen committed
381 382 383
 * 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
384 385 386 387 388 389 390 391 392 393 394 395 396
 * 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
397

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  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
416 417 418 419 420

/* 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
421
_gtk_button_box_child_requisition (GtkWidget *widget,
422 423 424 425
                                   int       *nvis_children,
				   int       *nvis_secondaries,
                                   int       *width,
                                   int       *height)
Elliot Lee's avatar
Elliot Lee committed
426 427 428 429 430
{
  GtkButtonBox *bbox;
  GtkBoxChild *child;
  GList *children;
  gint nchildren;
431
  gint nsecondaries;
Elliot Lee's avatar
Elliot Lee committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
  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
451
  gtk_widget_style_get (widget,
452 453 454 455 456
                        "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
457 458 459 460 461 462 463 464 465 466 467
  
  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;
468
  nsecondaries = 0;
Elliot Lee's avatar
Elliot Lee committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
  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);
484
	  
Elliot Lee's avatar
Elliot Lee committed
485
	  if (child_requisition.width + ipad_w > needed_width)
486
	    needed_width = child_requisition.width + ipad_w;
Elliot Lee's avatar
Elliot Lee committed
487
	  if (child_requisition.height + ipad_h > needed_height)
488 489 490
	    needed_height = child_requisition.height + ipad_h;
	  if (child->is_secondary)
	    nsecondaries++;
Elliot Lee's avatar
Elliot Lee committed
491 492
	}
    }
493 494 495 496 497 498 499 500 501

  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
502
}
503 504 505

#define __GTK_BUTTON_BOX_C__
#include "gtkaliasdef.c"