jean
/
Learning_GTK4_tree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Learning_GTK4_tree/gtk/deprecated/gtkcellareacontext.c

641 lines
22 KiB
C
Raw Normal View History

initial
2023-12-12 11:36:42 +01:00
/* gtkcellareacontext.c
*
* Copyright (C) 2010 Openismus GmbH
*
* Authors:
* Tristan Van Berkom <tristanvb@openismus.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* GtkCellAreaContext:
*
* Stores geometrical information for a series of rows in a GtkCellArea
*
* The `GtkCellAreaContext` object is created by a given `GtkCellArea`
* implementation via its `GtkCellAreaClass.create_context()` virtual
* method and is used to store cell sizes and alignments for a series of
* `GtkTreeModel` rows that are requested and rendered in the same context.
*
* `GtkCellLayout` widgets can create any number of contexts in which to
* request and render groups of data rows. However, it’s important that the
* same context which was used to request sizes for a given `GtkTreeModel`
* row also be used for the same row when calling other `GtkCellArea` APIs
* such as gtk_cell_area_render() and gtk_cell_area_event().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
#include "config.h"
#include "gtkmarshalers.h"
#include "gtkcellareacontext.h"
#include "gtkprivate.h"
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
/* GObjectClass */
static void gtk_cell_area_context_dispose (GObject *object);
static void gtk_cell_area_context_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gtk_cell_area_context_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
/* GtkCellAreaContextClass */
static void gtk_cell_area_context_real_reset (GtkCellAreaContext *context);
static void gtk_cell_area_context_real_allocate (GtkCellAreaContext *context,
int width,
int height);
typedef struct _GtkCellAreaContextPrivate GtkCellAreaContextPrivate;
struct _GtkCellAreaContextPrivate
{
GtkCellArea *cell_area;
int min_width;
int nat_width;
int min_height;
int nat_height;
int alloc_width;
int alloc_height;
};
enum {
PROP_0,
PROP_CELL_AREA,
PROP_MIN_WIDTH,
PROP_NAT_WIDTH,
PROP_MIN_HEIGHT,
PROP_NAT_HEIGHT
};
G_DEFINE_TYPE_WITH_PRIVATE (GtkCellAreaContext, gtk_cell_area_context, G_TYPE_OBJECT)
static void
gtk_cell_area_context_init (GtkCellAreaContext *context)
{
}
static void
gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
{
GObjectClass *object_class = G_OBJECT_CLASS (class);
/* GObjectClass */
object_class->dispose = gtk_cell_area_context_dispose;
object_class->get_property = gtk_cell_area_context_get_property;
object_class->set_property = gtk_cell_area_context_set_property;
/* GtkCellAreaContextClass */
class->reset = gtk_cell_area_context_real_reset;
class->allocate = gtk_cell_area_context_real_allocate;
/**
* GtkCellAreaContext:area:
*
* The `GtkCellArea` this context was created by
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
PROP_CELL_AREA,
g_param_spec_object ("area", NULL, NULL,
GTK_TYPE_CELL_AREA,
GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* GtkCellAreaContext:minimum-width:
*
* The minimum width for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_width().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
PROP_MIN_WIDTH,
g_param_spec_int ("minimum-width", NULL, NULL,
-1, G_MAXINT, -1,
GTK_PARAM_READABLE));
/**
* GtkCellAreaContext:natural-width:
*
* The natural width for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_width().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
PROP_NAT_WIDTH,
g_param_spec_int ("natural-width", NULL, NULL,
-1, G_MAXINT, -1,
GTK_PARAM_READABLE));
/**
* GtkCellAreaContext:minimum-height:
*
* The minimum height for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_height().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
PROP_MIN_HEIGHT,
g_param_spec_int ("minimum-height", NULL, NULL,
-1, G_MAXINT, -1,
GTK_PARAM_READABLE));
/**
* GtkCellAreaContext:natural-height:
*
* The natural height for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_height().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
PROP_NAT_HEIGHT,
g_param_spec_int ("natural-height", NULL, NULL,
-1, G_MAXINT, -1,
GTK_PARAM_READABLE));
}
/*************************************************************
* GObjectClass *
*************************************************************/
static void
gtk_cell_area_context_dispose (GObject *object)
{
GtkCellAreaContext *context = GTK_CELL_AREA_CONTEXT (object);
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
if (priv->cell_area)
{
g_object_unref (priv->cell_area);
priv->cell_area = NULL;
}
G_OBJECT_CLASS (gtk_cell_area_context_parent_class)->dispose (object);
}
static void
gtk_cell_area_context_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkCellAreaContext *context = GTK_CELL_AREA_CONTEXT (object);
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
switch (prop_id)
{
case PROP_CELL_AREA:
priv->cell_area = g_value_dup_object (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_cell_area_context_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkCellAreaContext *context = GTK_CELL_AREA_CONTEXT (object);
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
switch (prop_id)
{
case PROP_CELL_AREA:
g_value_set_object (value, priv->cell_area);
break;
case PROP_MIN_WIDTH:
g_value_set_int (value, priv->min_width);
break;
case PROP_NAT_WIDTH:
g_value_set_int (value, priv->nat_width);
break;
case PROP_MIN_HEIGHT:
g_value_set_int (value, priv->min_height);
break;
case PROP_NAT_HEIGHT:
g_value_set_int (value, priv->nat_height);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/*************************************************************
* GtkCellAreaContextClass *
*************************************************************/
static void
gtk_cell_area_context_real_reset (GtkCellAreaContext *context)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_object_freeze_notify (G_OBJECT (context));
if (priv->min_width != 0)
{
priv->min_width = 0;
g_object_notify (G_OBJECT (context), "minimum-width");
}
if (priv->nat_width != 0)
{
priv->nat_width = 0;
g_object_notify (G_OBJECT (context), "natural-width");
}
if (priv->min_height != 0)
{
priv->min_height = 0;
g_object_notify (G_OBJECT (context), "minimum-height");
}
if (priv->nat_height != 0)
{
priv->nat_height = 0;
g_object_notify (G_OBJECT (context), "natural-height");
}
priv->alloc_width = 0;
priv->alloc_height = 0;
g_object_thaw_notify (G_OBJECT (context));
}
static void
gtk_cell_area_context_real_allocate (GtkCellAreaContext *context,
int width,
int height)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
priv->alloc_width = width;
priv->alloc_height = height;
}
/*************************************************************
* API *
*************************************************************/
/**
* gtk_cell_area_context_get_area:
* @context: a `GtkCellAreaContext`
*
* Fetches the `GtkCellArea` this @context was created by.
*
* This is generally unneeded by layouting widgets; however,
* it is important for the context implementation itself to
* fetch information about the area it is being used for.
*
* For instance at `GtkCellAreaContextClass.allocate()` time
* it’s important to know details about any cell spacing
* that the `GtkCellArea` is configured with in order to
* compute a proper allocation.
*
* Returns: (transfer none): the `GtkCellArea` this context was created by.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
GtkCellArea *
gtk_cell_area_context_get_area (GtkCellAreaContext *context)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), NULL);
return priv->cell_area;
}
/**
* gtk_cell_area_context_reset:
* @context: a `GtkCellAreaContext`
*
* Resets any previously cached request and allocation
* data.
*
* When underlying `GtkTreeModel` data changes its
* important to reset the context if the content
* size is allowed to shrink. If the content size
* is only allowed to grow (this is usually an option
* for views rendering large data stores as a measure
* of optimization), then only the row that changed
* or was inserted needs to be (re)requested with
* gtk_cell_area_get_preferred_width().
*
* When the new overall size of the context requires
* that the allocated size changes (or whenever this
* allocation changes at all), the variable row
* sizes need to be re-requested for every row.
*
* For instance, if the rows are displayed all with
* the same width from top to bottom then a change
* in the allocated width necessitates a recalculation
* of all the displayed row heights using
* gtk_cell_area_get_preferred_height_for_width().
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_reset (GtkCellAreaContext *context)
{
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->reset (context);
}
/**
* gtk_cell_area_context_allocate:
* @context: a `GtkCellAreaContext`
* @width: the allocated width for all `GtkTreeModel` rows rendered
* with @context, or -1
* @height: the allocated height for all `GtkTreeModel` rows rendered
* with @context, or -1
*
* Allocates a width and/or a height for all rows which are to be
* rendered with @context.
*
* Usually allocation is performed only horizontally or sometimes
* vertically since a group of rows are usually rendered side by
* side vertically or horizontally and share either the same width
* or the same height. Sometimes they are allocated in both horizontal
* and vertical orientations producing a homogeneous effect of the
* rows. This is generally the case for `GtkTreeView` when
* `GtkTreeView:fixed-height-mode` is enabled.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_allocate (GtkCellAreaContext *context,
int width,
int height)
{
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->allocate (context, width, height);
}
/**
* gtk_cell_area_context_get_preferred_width:
* @context: a `GtkCellAreaContext`
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
* Gets the accumulative preferred width for all rows which have been
* requested with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a `GtkCellArea`, the returned values are 0.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context,
int *minimum_width,
int *natural_width)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
if (minimum_width)
*minimum_width = priv->min_width;
if (natural_width)
*natural_width = priv->nat_width;
}
/**
* gtk_cell_area_context_get_preferred_height:
* @context: a `GtkCellAreaContext`
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
* Gets the accumulative preferred height for all rows which have been
* requested with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a `GtkCellArea`, the returned values are 0.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context,
int *minimum_height,
int *natural_height)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
if (minimum_height)
*minimum_height = priv->min_height;
if (natural_height)
*natural_height = priv->nat_height;
}
/**
* gtk_cell_area_context_get_preferred_height_for_width:
* @context: a `GtkCellAreaContext`
* @width: a proposed width for allocation
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
* Gets the accumulative preferred height for @width for all rows
* which have been requested for the same said @width with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a `GtkCellArea`, the returned values are -1.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *context,
int width,
int *minimum_height,
int *natural_height)
{
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
if (GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->get_preferred_height_for_width)
GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->get_preferred_height_for_width (context,
width,
minimum_height,
natural_height);
}
/**
* gtk_cell_area_context_get_preferred_width_for_height:
* @context: a `GtkCellAreaContext`
* @height: a proposed height for allocation
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
* Gets the accumulative preferred width for @height for all rows which
* have been requested for the same said @height with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a `GtkCellArea`, the returned values are -1.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *context,
int height,
int *minimum_width,
int *natural_width)
{
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
if (GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->get_preferred_width_for_height)
GTK_CELL_AREA_CONTEXT_GET_CLASS (context)->get_preferred_width_for_height (context,
height,
minimum_width,
natural_width);
}
/**
* gtk_cell_area_context_get_allocation:
* @context: a `GtkCellAreaContext`
* @width: (out) (optional): location to store the allocated width
* @height: (out) (optional): location to store the allocated height
*
* Fetches the current allocation size for @context.
*
* If the context was not allocated in width or height, or if the
* context was recently reset with gtk_cell_area_context_reset(),
* the returned value will be -1.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_get_allocation (GtkCellAreaContext *context,
int *width,
int *height)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
if (width)
*width = priv->alloc_width;
if (height)
*height = priv->alloc_height;
}
/**
* gtk_cell_area_context_push_preferred_width:
* @context: a `GtkCellAreaContext`
* @minimum_width: the proposed new minimum width for @context
* @natural_width: the proposed new natural width for @context
*
* Causes the minimum and/or natural width to grow if the new
* proposed sizes exceed the current minimum and natural width.
*
* This is used by `GtkCellAreaContext` implementations during
* the request process over a series of `GtkTreeModel` rows to
* progressively push the requested width over a series of
* gtk_cell_area_get_preferred_width() requests.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_push_preferred_width (GtkCellAreaContext *context,
int minimum_width,
int natural_width)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
g_object_freeze_notify (G_OBJECT (context));
if (minimum_width > priv->min_width)
{
priv->min_width = minimum_width;
g_object_notify (G_OBJECT (context), "minimum-width");
}
if (natural_width > priv->nat_width)
{
priv->nat_width = natural_width;
g_object_notify (G_OBJECT (context), "natural-width");
}
g_object_thaw_notify (G_OBJECT (context));
}
/**
* gtk_cell_area_context_push_preferred_height:
* @context: a `GtkCellAreaContext`
* @minimum_height: the proposed new minimum height for @context
* @natural_height: the proposed new natural height for @context
*
* Causes the minimum and/or natural height to grow if the new
* proposed sizes exceed the current minimum and natural height.
*
* This is used by `GtkCellAreaContext` implementations during
* the request process over a series of `GtkTreeModel` rows to
* progressively push the requested height over a series of
* gtk_cell_area_get_preferred_height() requests.
*
* Deprecated: 4.10: This object will be removed in GTK 5
*/
void
gtk_cell_area_context_push_preferred_height (GtkCellAreaContext *context,
int minimum_height,
int natural_height)
{
GtkCellAreaContextPrivate *priv = gtk_cell_area_context_get_instance_private (context);
g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
g_object_freeze_notify (G_OBJECT (context));
if (minimum_height > priv->min_height)
{
priv->min_height = minimum_height;
g_object_notify (G_OBJECT (context), "minimum-height");
}
if (natural_height > priv->nat_height)
{
priv->nat_height = natural_height;
g_object_notify (G_OBJECT (context), "natural-height");
}
g_object_thaw_notify (G_OBJECT (context));
}