gtk2/gtk/gtkwidgetprivate.h
Benjamin Otte 34c6ef5332 widget: Add a hook for resizes
It's private, no APIs, we don't talk about it. But we will start using
it very soon, so we can do size request caching in columns and avoid
sizegroups...
2020-05-30 19:26:46 -04:00

489 lines
18 KiB
C

/* 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
* modify it under the terms of the GNU Lesser 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
* 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, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* 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/.
*/
#ifndef __GTK_WIDGET_PRIVATE_H__
#define __GTK_WIDGET_PRIVATE_H__
#include "gtkwidget.h"
#include "gtkactionmuxerprivate.h"
#include "gtkcsstypesprivate.h"
#include "gtkeventcontrollerprivate.h"
#include "gtklistlistmodelprivate.h"
#include "gtkrootprivate.h"
#include "gtksizerequestcacheprivate.h"
#include "gtkwindowprivate.h"
#include "gtkgesture.h"
#include "gsk/gskrendernodeprivate.h"
G_BEGIN_DECLS
typedef gboolean (*GtkSurfaceTransformChangedCallback) (GtkWidget *widget,
const graphene_matrix_t *surface_transform,
gpointer user_data);
#define GTK_STATE_FLAGS_BITS 15
typedef struct _GtkWidgetSurfaceTransformData
{
GtkWidget *tracked_parent;
guint parent_surface_transform_changed_id;
GList *callbacks;
gboolean cached_surface_transform_valid;
graphene_matrix_t cached_surface_transform;
} GtkWidgetSurfaceTransformData;
struct _GtkWidgetPrivate
{
/* The state of the widget. Needs to be able to hold all GtkStateFlags bits
* (defined in "gtkenums.h").
*/
guint state_flags : GTK_STATE_FLAGS_BITS;
guint direction : 2;
#ifdef G_ENABLE_DEBUG
guint highlight_resize : 1;
#endif
guint in_destruction : 1;
guint realized : 1;
guint mapped : 1;
guint visible : 1;
guint sensitive : 1;
guint can_focus : 1;
guint focusable : 1;
guint has_focus : 1;
guint focus_on_click : 1;
guint has_default : 1;
guint receives_default : 1;
guint has_grab : 1;
guint shadowed : 1;
guint child_visible : 1;
guint multidevice : 1;
guint can_target : 1;
/* Queue-resize related flags */
guint resize_needed : 1; /* queue_resize() has been called but no get_preferred_size() yet */
guint alloc_needed : 1; /* this widget needs a size_allocate() call */
guint alloc_needed_on_child : 1; /* 0 or more children - or this widget - need a size_allocate() call */
/* Queue-draw related flags */
guint draw_needed : 1;
/* Expand-related flags */
guint need_compute_expand : 1; /* Need to recompute computed_[hv]_expand */
guint computed_hexpand : 1; /* computed results (composite of child flags) */
guint computed_vexpand : 1;
guint hexpand : 1; /* application-forced expand */
guint vexpand : 1;
guint hexpand_set : 1; /* whether to use application-forced */
guint vexpand_set : 1; /* instead of computing from children */
guint has_tooltip : 1;
/* SizeGroup related flags */
guint have_size_groups : 1;
/* Alignment */
guint halign : 4;
guint valign : 4;
GtkOverflow overflow;
guint8 alpha;
guint8 user_alpha;
#ifdef G_ENABLE_CONSISTENCY_CHECKS
/* Number of gtk_widget_push_verify_invariants () */
guint8 verifying_invariants_count;
#endif
int width_request;
int height_request;
void (* resize_func) (GtkWidget *);
GtkBorder margin;
/* Animations and other things to update on clock ticks */
guint clock_tick_id;
GList *tick_callbacks;
/* Surface relative transform updates callbacks */
GtkWidgetSurfaceTransformData *surface_transform_data;
/* The widget's name. If the widget does not have a name
* (the name is NULL), then its name (as returned by
* "gtk_widget_get_name") is its class's name.
* Among other things, the widget name is used to determine
* the style to use for a widget.
*/
gchar *name;
/* The root this widget belongs to or %NULL if widget is not
* rooted or is a #GtkRoot itself.
*/
GtkRoot *root;
/* The style for the widget. The style contains the
* colors the widget should be drawn in for each state
* along with graphics contexts used to draw with and
* the font to use for text.
*/
GtkCssNode *cssnode;
GtkStyleContext *context;
/* The widget's allocated size */
GskTransform *allocated_transform;
int allocated_width;
int allocated_height;
gint allocated_size_baseline;
GskTransform *transform;
int width;
int height;
int baseline;
/* The widget's requested sizes */
SizeRequestCache requests;
/* The render node we draw or %NULL if not yet created.*/
GskRenderNode *render_node;
/* The layout manager, or %NULL */
GtkLayoutManager *layout_manager;
GSList *paintables;
GPtrArray *controllers;
AtkObject *accessible;
/* Widget tree */
GtkWidget *parent;
GtkWidget *prev_sibling;
GtkWidget *next_sibling;
GtkWidget *first_child;
GtkWidget *last_child;
/* only created on-demand */
GtkListListModel *children_observer;
GtkListListModel *controller_observer;
GtkWidget *focus_child;
/* Pointer cursor */
GdkCursor *cursor;
};
typedef struct
{
GBytes *data;
GSList *children;
GtkBuilderScope *scope;
} GtkWidgetTemplate;
struct _GtkWidgetClassPrivate
{
GtkWidgetTemplate *template;
GListStore *shortcuts;
GType accessible_type;
AtkRole accessible_role;
GQuark css_name;
GType layout_manager_type;
GtkWidgetAction *actions;
};
void gtk_widget_root (GtkWidget *widget);
void gtk_widget_unroot (GtkWidget *widget);
GtkCssNode * gtk_widget_get_css_node (GtkWidget *widget);
void _gtk_widget_set_visible_flag (GtkWidget *widget,
gboolean visible);
gboolean _gtk_widget_get_shadowed (GtkWidget *widget);
void _gtk_widget_set_shadowed (GtkWidget *widget,
gboolean shadowed);
gboolean _gtk_widget_get_alloc_needed (GtkWidget *widget);
gboolean gtk_widget_needs_allocate (GtkWidget *widget);
void gtk_widget_ensure_resize (GtkWidget *widget);
void gtk_widget_ensure_allocate (GtkWidget *widget);
void _gtk_widget_scale_changed (GtkWidget *widget);
void gtk_widget_render (GtkWidget *widget,
GdkSurface *surface,
const cairo_region_t *region);
void _gtk_widget_add_sizegroup (GtkWidget *widget,
gpointer group);
void _gtk_widget_remove_sizegroup (GtkWidget *widget,
gpointer group);
GSList *_gtk_widget_get_sizegroups (GtkWidget *widget);
AtkObject * _gtk_widget_peek_accessible (GtkWidget *widget);
void _gtk_widget_set_has_default (GtkWidget *widget,
gboolean has_default);
void _gtk_widget_set_has_grab (GtkWidget *widget,
gboolean has_grab);
gboolean gtk_widget_has_grab (GtkWidget *widget);
void _gtk_widget_grab_notify (GtkWidget *widget,
gboolean was_grabbed);
void _gtk_widget_propagate_display_changed (GtkWidget *widget,
GdkDisplay *previous_display);
void _gtk_widget_set_device_surface (GtkWidget *widget,
GdkDevice *device,
GdkSurface *pointer_window);
GdkSurface * _gtk_widget_get_device_surface (GtkWidget *widget,
GdkDevice *device);
GdkDevice ** _gtk_widget_list_devices (GtkWidget *widget,
guint *out_n_devices);
void _gtk_widget_synthesize_crossing (GtkWidget *from,
GtkWidget *to,
GdkDevice *device,
GdkCrossingMode mode);
GtkStyleContext * _gtk_widget_peek_style_context (GtkWidget *widget);
gboolean _gtk_widget_captured_event (GtkWidget *widget,
GdkEvent *event,
GtkWidget *target);
void gtk_widget_css_changed (GtkWidget *widget,
GtkCssStyleChange *change);
void gtk_widget_system_setting_changed (GtkWidget *widget,
GtkSystemSetting setting);
void gtk_system_setting_changed (GdkDisplay *display,
GtkSystemSetting setting);
void _gtk_widget_update_parent_muxer (GtkWidget *widget);
GtkActionMuxer * _gtk_widget_get_action_muxer (GtkWidget *widget,
gboolean create);
gboolean gtk_widget_consumes_motion (GtkWidget *widget,
GtkWidget *parent,
GdkEventSequence *sequence);
gboolean gtk_widget_has_tick_callback (GtkWidget *widget);
gboolean gtk_widget_has_size_request (GtkWidget *widget);
void gtk_widget_reset_controllers (GtkWidget *widget);
GtkEventController **gtk_widget_list_controllers (GtkWidget *widget,
GtkPropagationPhase phase,
guint *out_n_controllers);
gboolean gtk_widget_query_tooltip (GtkWidget *widget,
gint x,
gint y,
gboolean keyboard_mode,
GtkTooltip *tooltip);
void gtk_widget_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot);
void gtk_widget_adjust_size_request (GtkWidget *widget,
GtkOrientation orientation,
gint *minimum_size,
gint *natural_size);
void gtk_widget_adjust_baseline_request (GtkWidget *widget,
gint *minimum_baseline,
gint *natural_baseline);
void gtk_widget_forall (GtkWidget *widget,
GtkCallback callback,
gpointer user_data);
void gtk_widget_focus_sort (GtkWidget *widget,
GtkDirectionType direction,
GPtrArray *focus_order);
gboolean gtk_widget_focus_move (GtkWidget *widget,
GtkDirectionType direction);
void gtk_widget_set_has_focus (GtkWidget *widget,
gboolean has_focus);
void gtk_widget_get_surface_allocation (GtkWidget *widget,
GtkAllocation *allocation);
GtkWidget * gtk_widget_common_ancestor (GtkWidget *widget_a,
GtkWidget *widget_b);
void gtk_widget_cancel_event_sequence (GtkWidget *widget,
GtkGesture *gesture,
GdkEventSequence *sequence,
GtkEventSequenceState state);
gboolean gtk_widget_event (GtkWidget *widget,
GdkEvent *event,
GtkWidget *target);
gboolean gtk_widget_run_controllers (GtkWidget *widget,
GdkEvent *event,
GtkWidget *target,
double x,
double y,
GtkPropagationPhase phase);
void gtk_widget_handle_crossing (GtkWidget *widget,
const GtkCrossingData *crossing,
double x,
double y);
guint gtk_widget_add_surface_transform_changed_callback (GtkWidget *widget,
GtkSurfaceTransformChangedCallback callback,
gpointer user_data,
GDestroyNotify notify);
void gtk_widget_remove_surface_transform_changed_callback (GtkWidget *widget,
guint id);
/* focus vfuncs for non-focusable containers with focusable children */
gboolean gtk_widget_grab_focus_child (GtkWidget *widget);
gboolean gtk_widget_focus_child (GtkWidget *widget,
GtkDirectionType direction);
/* focus vfuncs for focusable widgets with children that don't receive focus */
gboolean gtk_widget_grab_focus_self (GtkWidget *widget);
gboolean gtk_widget_focus_self (GtkWidget *widget,
GtkDirectionType direction);
/* inline getters */
static inline GtkWidget *
_gtk_widget_get_parent (GtkWidget *widget)
{
return widget->priv->parent;
}
static inline gboolean
_gtk_widget_get_visible (GtkWidget *widget)
{
return widget->priv->visible;
}
static inline gboolean
_gtk_widget_get_child_visible (GtkWidget *widget)
{
return widget->priv->child_visible;
}
static inline gboolean
_gtk_widget_get_mapped (GtkWidget *widget)
{
return widget->priv->mapped;
}
static inline gboolean
_gtk_widget_get_realized (GtkWidget *widget)
{
return widget->priv->realized;
}
static inline GtkStateFlags
_gtk_widget_get_state_flags (GtkWidget *widget)
{
return widget->priv->state_flags;
}
extern GtkTextDirection gtk_default_direction;
static inline GtkTextDirection
_gtk_widget_get_direction (GtkWidget *widget)
{
if (widget->priv->direction == GTK_TEXT_DIR_NONE)
return gtk_default_direction;
else
return widget->priv->direction;
}
static inline GtkRoot *
_gtk_widget_get_root (GtkWidget *widget)
{
return widget->priv->root;
}
static inline GdkDisplay *
_gtk_widget_get_display (GtkWidget *widget)
{
GtkRoot *root = _gtk_widget_get_root (widget);
if (root == NULL)
return gdk_display_get_default ();
return gtk_root_get_display (root);
}
static inline GtkStyleContext *
_gtk_widget_get_style_context (GtkWidget *widget)
{
if (G_LIKELY (widget->priv->context))
return widget->priv->context;
return gtk_widget_get_style_context (widget);
}
static inline gpointer
_gtk_widget_peek_request_cache (GtkWidget *widget)
{
return &widget->priv->requests;
}
static inline GtkWidget *
_gtk_widget_get_prev_sibling (GtkWidget *widget)
{
return widget->priv->prev_sibling;
}
static inline GtkWidget *
_gtk_widget_get_next_sibling (GtkWidget *widget)
{
return widget->priv->next_sibling;
}
static inline GtkWidget *
_gtk_widget_get_first_child (GtkWidget *widget)
{
return widget->priv->first_child;
}
static inline GtkWidget *
_gtk_widget_get_last_child (GtkWidget *widget)
{
return widget->priv->last_child;
}
static inline gboolean
_gtk_widget_is_sensitive (GtkWidget *widget)
{
return !(widget->priv->state_flags & GTK_STATE_FLAG_INSENSITIVE);
}
static inline GskTransform *
gtk_widget_get_transform (GtkWidget *widget)
{
return widget->priv->transform;
}
G_END_DECLS
#endif /* __GTK_WIDGET_PRIVATE_H__ */