gtkhidingbox.c 16.5 KB
Newer Older
1 2
/*
 * Copyright (C) 2015 Rafał Lużyński <digitalfreak@lingonborough.com>
3
 * Copyright (C) 2015 Red Hat
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * Licensed under the GNU General Public License Version 2
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 21 22
 *
 * Authors: Rafał Lużyński <digitalfreak@lingonborough.com>
 *          Carlos Soriano <csoriano@gnome.org>
23 24 25 26 27
 */

#include "config.h"

#include "gtkhidingboxprivate.h"
28
#include "gtkwidgetprivate.h"
29 30 31 32 33 34 35 36
#include "gtkintl.h"
#include "gtksizerequest.h"
#include "gtkbuildable.h"

struct _GtkHidingBoxPrivate
{
  GList *children;
  gint16 spacing;
37
  gint inverted :1;
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 64
};

static void
gtk_hiding_box_buildable_add_child (GtkBuildable *buildable,
                                    GtkBuilder   *builder,
                                    GObject      *child,
                                    const gchar  *type)
{
  if (!type)
    gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
  else
    GTK_BUILDER_WARN_INVALID_CHILD_TYPE (GTK_HIDING_BOX (buildable), type);
}

static void
gtk_hiding_box_buildable_init (GtkBuildableIface *iface)
{
  iface->add_child = gtk_hiding_box_buildable_add_child;
}

G_DEFINE_TYPE_WITH_CODE (GtkHidingBox, gtk_hiding_box, GTK_TYPE_CONTAINER,
                         G_ADD_PRIVATE (GtkHidingBox)
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE, gtk_hiding_box_buildable_init))

enum {
  PROP_0,
  PROP_SPACING,
65
  PROP_INVERTED,
66 67 68
  LAST_PROP
};

69 70
static GParamSpec *hiding_box_properties[LAST_PROP] = { NULL, };

71 72 73 74 75 76 77 78 79 80 81 82 83
static void
gtk_hiding_box_set_property (GObject      *object,
                             guint         prop_id,
                             const GValue *value,
                             GParamSpec   *pspec)
{
  GtkHidingBox *box = GTK_HIDING_BOX (object);

  switch (prop_id)
    {
    case PROP_SPACING:
      gtk_hiding_box_set_spacing (box, g_value_get_int (value));
      break;
84 85 86
    case PROP_INVERTED:
      gtk_hiding_box_set_inverted (box, g_value_get_boolean (value));
      break;
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_hiding_box_get_property (GObject    *object,
                             guint       prop_id,
                             GValue     *value,
                             GParamSpec *pspec)
{
  GtkHidingBox *box = GTK_HIDING_BOX (object);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);

  switch (prop_id)
    {
    case PROP_SPACING:
      g_value_set_int (value, priv->spacing);
      break;
107 108 109
    case PROP_INVERTED:
      g_value_set_boolean (value, priv->inverted);
      break;
110 111 112 113 114 115 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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_hiding_box_add (GtkContainer *container,
                    GtkWidget    *widget)
{
  GtkHidingBox *box = GTK_HIDING_BOX (container);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);

  priv->children = g_list_append (priv->children, widget);
  gtk_widget_set_parent (widget, GTK_WIDGET (box));
}

static void
gtk_hiding_box_remove (GtkContainer *container,
                       GtkWidget    *widget)
{
  GList *child;
  GtkHidingBox *box = GTK_HIDING_BOX (container);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);

  for (child = priv->children; child != NULL; child = child->next)
    {
      if (child->data == widget)
        {
          gboolean was_visible = gtk_widget_get_visible (widget) &&
                                 gtk_widget_get_child_visible (widget);

          gtk_widget_unparent (widget);
          priv->children = g_list_delete_link (priv->children, child);

          if (was_visible)
            gtk_widget_queue_resize (GTK_WIDGET (container));

          break;
        }
    }
}

static void
gtk_hiding_box_forall (GtkContainer *container,
                       gboolean      include_internals,
                       GtkCallback   callback,
                       gpointer      callback_data)
{
  GtkHidingBox *box = GTK_HIDING_BOX (container);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);
  GtkWidget *child;
  GList *children;

  children = priv->children;
  while (children)
    {
      child = children->data;
      children = children->next;
      (* callback) (child, callback_data);
    }
}

static void
174 175 176
update_children_visibility (GtkHidingBox     *box,
                            GtkAllocation    *allocation,
                            GtkRequestedSize *sizes,
177
                            gint             *children_size,
178 179
                            gint             *n_visible_children,
                            gint             *n_visible_children_expanding)
180 181 182
{
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);
  GtkWidget *child_widget;
183
  GList *child;
184
  GtkRequestedSize *sizes_temp;
185
  gint i;
186
  GList *children;
187
  gboolean allocate_more_children = TRUE;
188

189 190
  *n_visible_children = 0;
  *n_visible_children_expanding = 0;
191
  *children_size = -priv->spacing;
192 193 194 195
  children = g_list_copy (priv->children);
  sizes_temp = g_newa (GtkRequestedSize, g_list_length (priv->children));
  if (priv->inverted)
    children = g_list_reverse (children);
196 197

  /* Retrieve desired size for visible children. */
198
  for (i = 0, child = children; child != NULL; i++, child = child->next)
199 200
    {
      child_widget = GTK_WIDGET (child->data);
201 202 203
      if (!gtk_widget_get_visible (child_widget) || !allocate_more_children)
        {
          gtk_widget_set_child_visible (child_widget, FALSE);
204
          continue;
205
        }
206 207 208

      gtk_widget_get_preferred_width_for_height (child_widget,
                                                 allocation->height,
209 210
                                                 &sizes_temp[i].minimum_size,
                                                 &sizes_temp[i].natural_size);
211
      /* Assert the api is working properly */
212
      if (sizes_temp[i].minimum_size < 0)
213 214
        g_error ("GtkHidingBox child %s minimum width: %d < 0 for height %d",
                 gtk_widget_get_name (child_widget),
215
                 sizes_temp[i].minimum_size, allocation->height);
216

217
      if (sizes_temp[i].natural_size < sizes_temp[i].minimum_size)
218 219
        g_error ("GtkHidingBox child %s natural width: %d < minimum %d for height %d",
                 gtk_widget_get_name (child_widget),
220
                 sizes_temp[i].natural_size, sizes_temp[i].minimum_size,
221
                 allocation->height);
222

223
      *children_size += sizes_temp[i].minimum_size + priv->spacing;
224
      sizes_temp[i].data = child_widget;
225

226
      if (*children_size > allocation->width)
227 228 229 230 231 232
        {
          gtk_widget_set_child_visible (child_widget, FALSE);
          allocate_more_children = FALSE;
          continue;
        }

233
      if (gtk_widget_get_hexpand (child_widget))
234 235 236
        (*n_visible_children_expanding)++;
      (*n_visible_children)++;
      gtk_widget_set_child_visible (child_widget, TRUE);
237
    }
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

  for (i = 0; i < *n_visible_children; i++)
    {
      if (priv->inverted)
        {
          sizes[*n_visible_children - i - 1].minimum_size = sizes_temp[i].minimum_size;
          sizes[*n_visible_children - i - 1].natural_size = sizes_temp[i].natural_size;
        }
      else
        {
          sizes[i].minimum_size = sizes_temp[i].minimum_size;
          sizes[i].natural_size = sizes_temp[i].natural_size;
        }
    }

  g_list_free (children);
254
}
255

256 257 258 259 260 261 262 263 264
static void
gtk_hiding_box_size_allocate (GtkWidget     *widget,
                              GtkAllocation *allocation)
{
  GtkHidingBox *box = GTK_HIDING_BOX (widget);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);
  GtkTextDirection direction;
  GtkAllocation child_allocation;
  GtkRequestedSize *sizes;
265
  gint extra_space = 0;
266 267 268 269 270 271 272
  gint x = 0;
  gint i;
  GList *child;
  GtkWidget *child_widget;
  gint spacing = priv->spacing;
  gint n_visible_children = 0;
  gint n_visible_children_expanding = 0;
273
  gint children_size = 0;
274 275 276 277

  gtk_widget_set_allocation (widget, allocation);

  sizes = g_newa (GtkRequestedSize, g_list_length (priv->children));
278 279
  update_children_visibility (box, allocation, sizes, &children_size,
                              &n_visible_children, &n_visible_children_expanding);
280 281 282 283 284 285 286 287

  /* If there is no visible child, simply return. */
  if (n_visible_children == 0)
    return;

  direction = gtk_widget_get_direction (widget);

  /* Bring children up to allocation width first */
288 289
  extra_space = allocation->width - (n_visible_children - 1) * spacing - children_size;
  extra_space = gtk_distribute_natural_allocation (MAX (0, extra_space), n_visible_children, sizes);
290

291
  /* Distribute extra space on the expanding children */
292
  if (n_visible_children > 1)
293
    extra_space = extra_space / MAX (1, n_visible_children_expanding);
294 295 296 297 298 299

  x = allocation->x;
  for (i = 0, child = priv->children; child != NULL; child = child->next)
    {

      child_widget = GTK_WIDGET (child->data);
300
      if (!gtk_widget_get_child_visible (child_widget))
301 302 303 304
        continue;

      child_allocation.x = x;
      child_allocation.y = allocation->y;
305
      if (gtk_widget_get_hexpand (child_widget))
306
        child_allocation.width = sizes[i].minimum_size + extra_space;
307 308 309
      else
        child_allocation.width = sizes[i].minimum_size;

310 311 312 313 314 315 316 317 318 319
      child_allocation.height = allocation->height;
      if (direction == GTK_TEXT_DIR_RTL)
        child_allocation.x = allocation->x + allocation->width - (child_allocation.x - allocation->x) - child_allocation.width;

      /* Let this child be visible */
      gtk_widget_size_allocate (child_widget, &child_allocation);
      x += child_allocation.width + spacing;
      ++i;
    }

320
  _gtk_widget_set_simple_clip (widget, NULL);
321 322 323 324
}

static void
gtk_hiding_box_get_preferred_width (GtkWidget *widget,
325 326
                                    gint      *minimum_width,
                                    gint      *natural_width)
327 328 329
{
  GtkHidingBox *box = GTK_HIDING_BOX (widget);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);
330 331
  gint child_minimum_width;
  gint child_natural_width;
332
  GList *child;
333
  gint n_visible_children;
334
  gboolean have_min = FALSE;
335
  GList *children;
336

337 338
  *minimum_width = 0;
  *natural_width = 0;
339

340 341 342 343
  children = g_list_copy (priv->children);
  if (priv->inverted)
    children = g_list_reverse (children);

344
  n_visible_children = 0;
345
  for (child = children; child != NULL; child = child->next)
346 347 348 349
    {
      if (!gtk_widget_is_visible (child->data))
        continue;

350
      ++n_visible_children;
351
      gtk_widget_get_preferred_width (child->data, &child_minimum_width, &child_natural_width);
352 353 354
      /* Minimum is a minimum of the first visible child */
      if (!have_min)
        {
355
          *minimum_width = child_minimum_width;
356 357 358
          have_min = TRUE;
        }
      /* Natural is a sum of all visible children */
359
      *natural_width += child_natural_width;
360 361 362
    }

  /* Natural must also include the spacing */
363
  if (priv->spacing && n_visible_children > 1)
364
    *natural_width += priv->spacing * (n_visible_children - 1);
365 366

  g_list_free (children);
367 368 369 370
}

static void
gtk_hiding_box_get_preferred_height (GtkWidget *widget,
371 372
                                     gint      *minimum_height,
                                     gint      *natural_height)
373 374 375
{
  GtkHidingBox *box = GTK_HIDING_BOX (widget);
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);
376 377
  gint child_minimum_height;
  gint child_natural_height;
378 379
  GList *child;

380 381
  *minimum_height = 0;
  *natural_height = 0;
382 383 384 385 386
  for (child = priv->children; child != NULL; child = child->next)
    {
      if (!gtk_widget_is_visible (child->data))
        continue;

387 388 389
      gtk_widget_get_preferred_height (child->data, &child_minimum_height, &child_natural_height);
      *minimum_height = MAX (*minimum_height, child_minimum_height);
      *natural_height = MAX (*natural_height, child_natural_height);
390 391 392
    }
}

393 394 395 396 397 398
static GtkSizeRequestMode
gtk_hiding_box_get_request_mode (GtkWidget *self)
{
  return GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT;
}

399 400 401 402 403 404 405
static void
gtk_hiding_box_init (GtkHidingBox *box)
{
  GtkHidingBoxPrivate *priv = gtk_hiding_box_get_instance_private (box);

  gtk_widget_set_has_window (GTK_WIDGET (box), FALSE);
  priv->spacing = 0;
406
  priv->inverted = FALSE;
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
}

static void
gtk_hiding_box_class_init (GtkHidingBoxClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
  GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);

  object_class->set_property = gtk_hiding_box_set_property;
  object_class->get_property = gtk_hiding_box_get_property;

  widget_class->size_allocate = gtk_hiding_box_size_allocate;
  widget_class->get_preferred_width = gtk_hiding_box_get_preferred_width;
  widget_class->get_preferred_height = gtk_hiding_box_get_preferred_height;
422
  widget_class->get_request_mode = gtk_hiding_box_get_request_mode;
423 424 425 426 427

  container_class->add = gtk_hiding_box_add;
  container_class->remove = gtk_hiding_box_remove;
  container_class->forall = gtk_hiding_box_forall;

428 429 430 431 432 433 434
  hiding_box_properties[PROP_SPACING] =
           g_param_spec_int ("spacing",
                             _("Spacing"),
                             _("The amount of space between children"),
                             0, G_MAXINT, 0,
                             G_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);

435 436 437 438 439 440 441
  hiding_box_properties[PROP_INVERTED] =
           g_param_spec_int ("inverted",
                             _("Direction of hiding children inverted"),
                             P_("If false the container will start hiding widgets from the end when there is not enough space, and the oposite in case inverted is true."),
                             0, G_MAXINT, 0,
                             G_PARAM_READWRITE);

442
  g_object_class_install_properties (object_class, LAST_PROP, hiding_box_properties);
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
}

/**
 * gtk_hiding_box_new:
 *
 * Creates a new #GtkHidingBox.
 *
 * Returns: a new #GtkHidingBox.
 **/
GtkWidget *
gtk_hiding_box_new (void)
{
  return g_object_new (GTK_TYPE_HIDING_BOX, NULL);
}

/**
 * gtk_hiding_box_set_spacing:
 * @box: a #GtkHidingBox
 * @spacing: the number of pixels to put between children
 *
 * Sets the #GtkHidingBox:spacing property of @box, which is the
 * number of pixels to place between children of @box.
 */
void
gtk_hiding_box_set_spacing (GtkHidingBox *box,
                            gint          spacing)
{
  GtkHidingBoxPrivate *priv ;

  g_return_if_fail (GTK_IS_HIDING_BOX (box));

  priv = gtk_hiding_box_get_instance_private (box);

  if (priv->spacing != spacing)
    {
      priv->spacing = spacing;

      g_object_notify (G_OBJECT (box), "spacing");

      gtk_widget_queue_resize (GTK_WIDGET (box));
    }
}

/**
 * gtk_hiding_box_get_spacing:
 * @box: a #GtkHidingBox
 *
 * Gets the value set by gtk_hiding_box_set_spacing().
 *
 * Returns: spacing between children
 **/
gint
gtk_hiding_box_get_spacing (GtkHidingBox *box)
{
  GtkHidingBoxPrivate *priv ;

  g_return_val_if_fail (GTK_IS_HIDING_BOX (box), 0);

  priv = gtk_hiding_box_get_instance_private (box);

  return priv->spacing;
}

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

void
gtk_hiding_box_set_inverted (GtkHidingBox *box,
                             gboolean      inverted)
{
  GtkHidingBoxPrivate *priv ;

  g_return_if_fail (GTK_IS_HIDING_BOX (box));

  priv = gtk_hiding_box_get_instance_private (box);

  if (priv->inverted != inverted)
    {
      priv->inverted = inverted != FALSE;

      g_object_notify (G_OBJECT (box), "inverted");

      gtk_widget_queue_resize (GTK_WIDGET (box));
    }
}

gboolean
gtk_hiding_box_get_inverted (GtkHidingBox *box)
{
  GtkHidingBoxPrivate *priv ;

  g_return_val_if_fail (GTK_IS_HIDING_BOX (box), 0);

  priv = gtk_hiding_box_get_instance_private (box);

  return priv->inverted;
}
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

GList *
gtk_hiding_box_get_overflow_children (GtkHidingBox *box)
{
  GtkHidingBoxPrivate *priv ;
  GList *result = NULL;
  GList *l;

  g_return_val_if_fail (GTK_IS_HIDING_BOX (box), 0);

  priv = gtk_hiding_box_get_instance_private (box);

  for (l = priv->children; l != NULL; l = l->next)
    if (gtk_widget_is_visible (l->data) && !gtk_widget_get_child_visible (l->data))
      result = g_list_append (result, l->data);

  return result;
}