* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
/**
* SECTION:gtkbox
- * @Short_description: Base class for box containers
+ * @Short_description: A container box
* @Title: GtkBox
- * @See_also: #GtkHBox, #GtkVBox, #GtkFrame, #GtkTable, #GtkLayout
+ * @See_also: #GtkFrame, #GtkGrid, #GtkLayout
*
- * GtkBox is an widget which encapsulates functionality for a
- * particular kind of container, one that organizes a variable number of
- * widgets into a rectangular area. GtkBox has a number of derived
- * classes, e.g. #GtkHBox and #GtkVBox.
+ * The GtkBox widget organizes child widgets into a rectangular area.
*
* The rectangular area of a GtkBox is organized into either a single row
- * or a single column of child widgets depending upon whether the box is
- * of type #GtkHBox or #GtkVBox, respectively. Thus, all children of a
- * GtkBox are allocated one dimension in common, which is the height of a
- * row, or the width of a column.
+ * or a single column of child widgets depending upon the orientation.
+ * Thus, all children of a GtkBox are allocated one dimension in common,
+ * which is the height of a row, or the width of a column.
*
- * GtkBox uses a notion of <emphasis>packing</emphasis>. Packing
- * refers to adding widgets with reference to a particular position in a
- * #GtkContainer. For a GtkBox, there are two reference positions: the
+ * GtkBox uses a notion of <emphasis>packing</emphasis>. Packing refers
+ * to adding widgets with reference to a particular position in a
+ * #GtkContainer. For a GtkBox, there are two reference positions: the
* <emphasis>start</emphasis> and the <emphasis>end</emphasis> of the box.
- * For a #GtkVBox, the start is defined as the top of the box and the end is
- * defined as the bottom. For a #GtkHBox the start is defined as the
- * left side and the end is defined as the right side.
+ * For a vertical #GtkBox, the start is defined as the top of the box and
+ * the end is defined as the bottom. For a horizontal #GtkBox the start
+ * is defined as the left side and the end is defined as the right side.
*
* Use repeated calls to gtk_box_pack_start() to pack widgets into a
- * GtkBox from start to end. Use gtk_box_pack_end() to add widgets from
- * end to start. You may intersperse these calls and add widgets from
+ * GtkBox from start to end. Use gtk_box_pack_end() to add widgets from
+ * end to start. You may intersperse these calls and add widgets from
* both ends of the same GtkBox.
*
- * Because GtkBox is a #GtkContainer, you may also use
- * gtk_container_add() to insert widgets into the box, and they will be
- * packed with the default values for #GtkBox:expand and #GtkBox:fill.
- * Use gtk_container_remove() to remove widgets from the GtkBox.
+ * Because GtkBox is a #GtkContainer, you may also use gtk_container_add()
+ * to insert widgets into the box, and they will be packed with the default
+ * values for #GtkBox:expand and #GtkBox:fill. Use gtk_container_remove()
+ * to remove widgets from the GtkBox.
*
* Use gtk_box_set_homogeneous() to specify whether or not all children
* of the GtkBox are forced to get the same amount of space.
* #GtkBox:fill and #GtkBox:padding child properties.
* Use gtk_box_query_child_packing() to query these fields.
*
- * <note>
- * <para>
- * Note that a single-row or single-column #GtkGrid provides exactly the
- * same functionality as #GtkBox.
- * </para>
- * </note>
+ * <note><para>
+ * Note that a single-row or single-column #GtkGrid provides exactly
+ * the same functionality as #GtkBox.
+ * </para></note>
*/
#include "config.h"
#include "gtkbox.h"
+#include "gtkboxprivate.h"
+#include "gtkintl.h"
#include "gtkorientable.h"
-#include "gtksizerequest.h"
-#include "gtktypebuiltins.h"
+#include "gtkorientableprivate.h"
#include "gtkprivate.h"
-#include "gtkintl.h"
+#include "gtktypebuiltins.h"
+#include "gtksizerequest.h"
+#include "gtkwidgetpath.h"
+#include "gtkwidgetprivate.h"
+#include "a11y/gtkcontaineraccessible.h"
enum {
struct _GtkBoxPrivate
{
- GtkOrientation orientation;
-
GList *children;
+ GtkOrientation orientation;
gint16 spacing;
guint default_expand : 1;
static void gtk_box_compute_expand (GtkWidget *widget,
gboolean *hexpand,
gboolean *vexpand);
+static void gtk_box_direction_changed (GtkWidget *widget,
+ GtkTextDirection previous_direction);
static void gtk_box_set_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static GType gtk_box_child_type (GtkContainer *container);
+static GtkWidgetPath * gtk_box_get_path_for_child
+ (GtkContainer *container,
+ GtkWidget *child);
-static GtkSizeRequestMode gtk_box_get_request_mode (GtkWidget *widget);
static void gtk_box_get_preferred_width (GtkWidget *widget,
gint *minimum_size,
gint *natural_size);
gint *minimum_height,
gint *natural_height);
+
G_DEFINE_TYPE_WITH_CODE (GtkBox, gtk_box, GTK_TYPE_CONTAINER,
G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE,
NULL))
object_class->get_property = gtk_box_get_property;
widget_class->size_allocate = gtk_box_size_allocate;
- widget_class->get_request_mode = gtk_box_get_request_mode;
widget_class->get_preferred_width = gtk_box_get_preferred_width;
widget_class->get_preferred_height = gtk_box_get_preferred_height;
widget_class->get_preferred_height_for_width = gtk_box_get_preferred_height_for_width;
widget_class->get_preferred_width_for_height = gtk_box_get_preferred_width_for_height;
widget_class->compute_expand = gtk_box_compute_expand;
+ widget_class->direction_changed = gtk_box_direction_changed;
container_class->add = gtk_box_add;
container_class->remove = gtk_box_remove;
container_class->child_type = gtk_box_child_type;
container_class->set_child_property = gtk_box_set_child_property;
container_class->get_child_property = gtk_box_get_child_property;
+ container_class->get_path_for_child = gtk_box_get_path_for_child;
gtk_container_class_handle_border_width (container_class);
g_object_class_override_property (object_class,
* Note that the default value for this property is %FALSE for GtkBox,
* but #GtkHBox, #GtkVBox and other subclasses use the old default
* of %TRUE.
+ *
+ * Note that the #GtkWidget:halign, #GtkWidget:valign, #GtkWidget:hexpand
+ * and #GtkWidget:vexpand properties are the preferred way to influence
+ * child size allocation in containers.
*/
gtk_container_class_install_child_property (container_class,
CHILD_PROP_EXPAND,
* GtkBox:fill:
*
* Whether the child should receive extra space when the parent grows.
+ *
+ * Note that the #GtkWidget:halign, #GtkWidget:valign, #GtkWidget:hexpand
+ * and #GtkWidget:vexpand properties are the preferred way to influence
+ * child size allocation in containers.
*/
gtk_container_class_install_child_property (container_class,
CHILD_PROP_FILL,
GTK_PARAM_READWRITE));
g_type_class_add_private (object_class, sizeof (GtkBoxPrivate));
+
+ gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_FILLER);
}
static void
{
case PROP_ORIENTATION:
private->orientation = g_value_get_enum (value);
+ _gtk_orientable_set_style_classes (GTK_ORIENTABLE (box));
gtk_widget_queue_resize (GTK_WIDGET (box));
break;
case PROP_SPACING:
}
}
+typedef struct _CountingData CountingData;
+struct _CountingData {
+ GtkWidget *widget;
+ gboolean found;
+ guint before;
+ guint after;
+};
+
+static void
+count_widget_position (GtkWidget *widget,
+ gpointer data)
+{
+ CountingData *count = data;
+
+ if (!gtk_widget_get_visible (widget))
+ return;
+
+ if (count->widget == widget)
+ count->found = TRUE;
+ else if (count->found)
+ count->after++;
+ else
+ count->before++;
+}
+
+static gint
+gtk_box_get_visible_position (GtkBox *box,
+ GtkWidget *child)
+{
+ CountingData count = { child, FALSE, 0, 0 };
+
+ /* foreach iterates in visible order */
+ gtk_container_foreach (GTK_CONTAINER (box),
+ count_widget_position,
+ &count);
+
+ /* the child wasn't found, it's likely an internal child of some
+ * subclass, return -1 to indicate that there is no sibling relation
+ * to the regular box children
+ */
+ if (!count.found)
+ return -1;
+
+ if (box->priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
+ gtk_widget_get_direction (GTK_WIDGET (box)) == GTK_TEXT_DIR_RTL)
+ return count.after;
+ else
+ return count.before;
+}
+
+static GtkWidgetPath *
+gtk_box_get_path_for_child (GtkContainer *container,
+ GtkWidget *child)
+{
+ GtkWidgetPath *path, *sibling_path;
+ GtkBox *box;
+ GtkBoxPrivate *private;
+ GList *list, *children;
+
+ box = GTK_BOX (container);
+ private = box->priv;
+
+ path = _gtk_widget_create_path (GTK_WIDGET (container));
+
+ if (gtk_widget_get_visible (child))
+ {
+ gint position;
+
+ sibling_path = gtk_widget_path_new ();
+
+ /* get_children works in visible order */
+ children = gtk_container_get_children (container);
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL &&
+ gtk_widget_get_direction (GTK_WIDGET (box)) == GTK_TEXT_DIR_RTL)
+ children = g_list_reverse (children);
+
+ for (list = children; list; list = list->next)
+ {
+ if (!gtk_widget_get_visible (list->data))
+ continue;
+
+ gtk_widget_path_append_for_widget (sibling_path, list->data);
+ }
+
+ g_list_free (children);
+
+ position = gtk_box_get_visible_position (box, child);
+
+ if (position >= 0)
+ gtk_widget_path_append_with_siblings (path, sibling_path, position);
+ else
+ gtk_widget_path_append_for_widget (path, child);
+
+ gtk_widget_path_unref (sibling_path);
+ }
+ else
+ gtk_widget_path_append_for_widget (path, child);
+
+ return path;
+}
+
+static void
+gtk_box_invalidate_order_foreach (GtkWidget *widget)
+{
+ _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_POSITION | GTK_CSS_CHANGE_SIBLING_POSITION);
+}
+
+static void
+gtk_box_invalidate_order (GtkBox *box)
+{
+ gtk_container_foreach (GTK_CONTAINER (box),
+ (GtkCallback) gtk_box_invalidate_order_foreach,
+ NULL);
+}
+
+static void
+gtk_box_direction_changed (GtkWidget *widget,
+ GtkTextDirection previous_direction)
+{
+ gtk_box_invalidate_order (GTK_BOX (widget));
+}
+
+static void
+box_child_visibility_notify_cb (GObject *obj,
+ GParamSpec *pspec,
+ gpointer user_data)
+{
+ GtkBox *box = user_data;
+
+ gtk_box_invalidate_order (box);
+}
+
static void
gtk_box_pack (GtkBox *box,
GtkWidget *child,
gtk_widget_freeze_child_notify (child);
+ gtk_box_invalidate_order (box);
gtk_widget_set_parent (child, GTK_WIDGET (box));
+ g_signal_connect (child, "notify::visible",
+ G_CALLBACK (box_child_visibility_notify_cb), box);
+
gtk_widget_child_notify (child, "expand");
gtk_widget_child_notify (child, "fill");
gtk_widget_child_notify (child, "padding");
gtk_widget_thaw_child_notify (child);
}
-
-static GtkSizeRequestMode
-gtk_box_get_request_mode (GtkWidget *widget)
-{
- GtkBoxPrivate *private = GTK_BOX (widget)->priv;
-
- return (private->orientation == GTK_ORIENTATION_VERTICAL) ?
- GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH : GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT;
-}
-
static void
gtk_box_get_size (GtkWidget *widget,
GtkOrientation orientation,
gint largest_child = 0, largest_natural = 0;
for (children = private->children; children != NULL;
- children = children->next, nvis_children++)
+ children = children->next)
{
GtkBoxChild *child = children->data;
required_size += child_size;
required_natural += child_natural;
+
+ nvis_children += 1;
}
}
* @fill: %TRUE if space given to @child by the @expand option is
* actually allocated to @child, rather than just padding it. This
* parameter has no effect if @expand is set to %FALSE. A child is
- * always allocated the full height of a #GtkHBox and the full width
- * of a #GtkVBox. This option affects the other dimension
+ * always allocated the full height of a horizontal #GtkBox and the full width
+ * of a vertical #GtkBox. This option affects the other dimension
* @padding: extra space in pixels to put between this child and its
* neighbors, over and above the global amount specified by
* #GtkBox:spacing property. If @child is a widget at one of the
* @fill: %TRUE if space given to @child by the @expand option is
* actually allocated to @child, rather than just padding it. This
* parameter has no effect if @expand is set to %FALSE. A child is
- * always allocated the full height of a #GtkHBox and the full width
- * of a #GtkVBox. This option affects the other dimension
+ * always allocated the full height of a horizontal #GtkBox and the full width
+ * of a vertical #GtkBox. This option affects the other dimension
* @padding: extra space in pixels to put between this child and its
* neighbors, over and above the global amount specified by
* #GtkBox:spacing property. If @child is a widget at one of the
gtk_widget_child_notify (child, "position");
if (gtk_widget_get_visible (child)
&& gtk_widget_get_visible (GTK_WIDGET (box)))
- gtk_widget_queue_resize (child);
+ {
+ gtk_box_invalidate_order (box);
+ gtk_widget_queue_resize (child);
+ }
}
/**
* gtk_box_query_child_packing:
* @box: a #GtkBox
* @child: the #GtkWidget of the child to query
- * @expand: pointer to return location for #GtkBox:expand child property
- * @fill: pointer to return location for #GtkBox:fill child property
- * @padding: pointer to return location for #GtkBox:padding child property
- * @pack_type: pointer to return location for #GtkBox:pack-type child property
+ * @expand: (out): pointer to return location for #GtkBox:expand child
+ * property
+ * @fill: (out): pointer to return location for #GtkBox:fill child
+ * property
+ * @padding: (out): pointer to return location for #GtkBox:padding
+ * child property
+ * @pack_type: (out): pointer to return location for #GtkBox:pack-type
+ * child property
*
* Obtains information about how @child is packed into @box.
*/
gtk_widget_child_notify (child, "fill");
child_info->padding = padding;
gtk_widget_child_notify (child, "padding");
- if (pack_type == GTK_PACK_END)
- child_info->pack = GTK_PACK_END;
- else
- child_info->pack = GTK_PACK_START;
- gtk_widget_child_notify (child, "pack-type");
+ if (pack_type != GTK_PACK_END)
+ pack_type = GTK_PACK_START;
+ if (child_info->pack != pack_type)
+ {
+ child_info->pack = pack_type;
+ gtk_widget_child_notify (child, "pack-type");
+ gtk_box_invalidate_order (box);
+ }
if (gtk_widget_get_visible (child)
&& gtk_widget_get_visible (GTK_WIDGET (box)))
{
gboolean was_visible;
+ g_signal_handlers_disconnect_by_func (widget,
+ box_child_visibility_notify_cb,
+ box);
+
was_visible = gtk_widget_get_visible (widget);
gtk_widget_unparent (widget);
* since that's what is needed by toplevels.
*/
if (was_visible)
- gtk_widget_queue_resize (GTK_WIDGET (container));
+ {
+ gtk_box_invalidate_order (box);
+ gtk_widget_queue_resize (GTK_WIDGET (container));
+ }
break;
}
projects / ~andy / gtk / blobdiff