gtkwidgetprivate.h 15.8 KB
Newer Older
Emmanuele Bassi's avatar
Emmanuele Bassi committed
1 2 3 4 5 6 7 8 9 10
/* 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Emmanuele Bassi's avatar
Emmanuele Bassi committed
12 13 14
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Emmanuele Bassi's avatar
Emmanuele Bassi committed
16 17 18 19 20 21 22 23 24 25 26 27
 */

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

28 29
#include "gtkcsstypesprivate.h"
#include "gtkwidget.h"
30
#include "gtkcontainer.h"
31
#include "gtkeventcontroller.h"
32
#include "gtkactionmuxer.h"
33
#include "gtksizerequestcacheprivate.h"
34

Emmanuele Bassi's avatar
Emmanuele Bassi committed
35 36
G_BEGIN_DECLS

37
#define GTK_STATE_FLAGS_BITS 13
38 39 40 41 42 43 44 45 46 47

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;

48 49 50 51
#ifdef G_ENABLE_DEBUG
  guint highlight_resize      : 1;
#endif

52 53 54 55 56 57 58 59 60 61 62
  guint in_destruction        : 1;
  guint toplevel              : 1;
  guint anchored              : 1;
  guint composite_child       : 1;
  guint no_window             : 1;
  guint realized              : 1;
  guint mapped                : 1;
  guint visible               : 1;
  guint sensitive             : 1;
  guint can_focus             : 1;
  guint has_focus             : 1;
63
  guint focus_on_click        : 1;
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
  guint can_default           : 1;
  guint has_default           : 1;
  guint receives_default      : 1;
  guint has_grab              : 1;
  guint shadowed              : 1;
  guint app_paintable         : 1;
  guint double_buffered       : 1;
  guint redraw_on_alloc       : 1;
  guint no_show_all           : 1;
  guint child_visible         : 1;
  guint multidevice           : 1;
  guint has_shape_mask        : 1;
  guint in_reparent           : 1;

  /* Queue-resize related flags */
79
  guint resize_needed         : 1; /* queue_resize() has been called but no get_preferred_size() yet */
80 81
  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 */
82 83 84 85 86 87 88 89 90

  /* 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 */
91
  guint has_tooltip           : 1;
92
  guint frameclock_connected  : 1;
93 94 95 96

  /* SizeGroup related flags */
  guint have_size_groups      : 1;

Matthias Clasen's avatar
Matthias Clasen committed
97 98 99 100
  /* Alignment */
  guint   halign              : 4;
  guint   valign              : 4;

101 102 103
  guint8 alpha;
  guint8 user_alpha;

Matthias Clasen's avatar
Matthias Clasen committed
104 105 106 107 108 109 110 111 112 113 114 115 116
#ifdef G_ENABLE_CONSISTENCY_CHECKS
  /* Number of gtk_widget_push_verify_invariants () */
  guint8 verifying_invariants_count;
#endif

  gint width;
  gint height;
  GtkBorder margin;

  /* Animations and other things to update on clock ticks */
  guint clock_tick_id;
  GList *tick_callbacks;

117 118 119 120 121 122 123 124 125 126
  /* 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 list of attached windows to this widget.
   * We keep a list in order to call reset_style to all of them,
127 128 129
   * recursively.
   */
  GList *attached_windows;
130 131 132 133 134 135 136 137 138 139 140

  /* 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.
   */
  GtkStyle *style;
  GtkCssNode *cssnode;
  GtkStyleContext *context;

  /* The widget's allocated size */
141 142
  GtkAllocation allocated_size;
  gint allocated_size_baseline;
143 144
  GtkAllocation allocation;
  GtkAllocation clip;
Matthias Clasen's avatar
Matthias Clasen committed
145
  gint allocated_baseline;
146

147 148 149 150 151 152 153 154 155 156 157 158 159 160
  /* The widget's requested sizes */
  SizeRequestCache requests;

  /* The widget's window or its parent window if it does
   * not have a window. (Which will be indicated by the
   * no_window field being set).
   */
  GdkWindow *window;
  GList *registered_windows;

  /* The widget's parent */
  GtkWidget *parent;

  GList *event_controllers;
161 162

  AtkObject *accessible;
163 164
};

165
GtkCssNode *  gtk_widget_get_css_node       (GtkWidget *widget);
Emmanuele Bassi's avatar
Emmanuele Bassi committed
166 167 168 169 170 171 172 173 174 175 176 177
void         _gtk_widget_set_visible_flag   (GtkWidget *widget,
                                             gboolean   visible);
gboolean     _gtk_widget_get_in_reparent    (GtkWidget *widget);
void         _gtk_widget_set_in_reparent    (GtkWidget *widget,
                                             gboolean   in_reparent);
gboolean     _gtk_widget_get_anchored       (GtkWidget *widget);
void         _gtk_widget_set_anchored       (GtkWidget *widget,
                                             gboolean   anchored);
gboolean     _gtk_widget_get_shadowed       (GtkWidget *widget);
void         _gtk_widget_set_shadowed       (GtkWidget *widget,
                                             gboolean   shadowed);
gboolean     _gtk_widget_get_alloc_needed   (GtkWidget *widget);
178
gboolean     gtk_widget_needs_allocate      (GtkWidget *widget);
179
void         gtk_widget_queue_resize_on_widget (GtkWidget *widget);
180
void         gtk_widget_ensure_resize       (GtkWidget *widget);
181
void         gtk_widget_ensure_allocate     (GtkWidget *widget);
182 183 184
void         gtk_widget_draw_internal       (GtkWidget *widget,
					     cairo_t   *cr,
                                             gboolean   do_clip);
185 186
void          _gtk_widget_scale_changed     (GtkWidget *widget);

Emmanuele Bassi's avatar
Emmanuele Bassi committed
187

188 189 190 191 192 193
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);

194 195 196 197 198
void         _gtk_widget_add_attached_window    (GtkWidget    *widget,
                                                 GtkWindow    *window);
void         _gtk_widget_remove_attached_window (GtkWidget    *widget,
                                                 GtkWindow    *window);

199 200 201 202
void _gtk_widget_get_preferred_size_for_size   (GtkWidget         *widget,
                                                GtkOrientation     orientation,
                                                gint               size,
                                                gint              *minimum,
203 204 205
                                                gint              *natural,
                                                gint              *minimum_baseline,
                                                gint              *natural_baseline);
206 207 208 209 210
void _gtk_widget_get_preferred_size_and_baseline(GtkWidget        *widget,
                                                GtkRequisition    *minimum_size,
                                                GtkRequisition    *natural_size,
                                                gint              *minimum_baseline,
                                                gint              *natural_baseline);
211
gboolean _gtk_widget_has_baseline_support (GtkWidget *widget);
Emmanuele Bassi's avatar
Emmanuele Bassi committed
212

213 214 215
const gchar*      _gtk_widget_get_accel_path               (GtkWidget *widget,
                                                            gboolean  *locked);

216 217
AtkObject *       _gtk_widget_peek_accessible              (GtkWidget *widget);

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
void              _gtk_widget_set_has_default              (GtkWidget *widget,
                                                            gboolean   has_default);
void              _gtk_widget_set_has_grab                 (GtkWidget *widget,
                                                            gboolean   has_grab);
void              _gtk_widget_set_is_toplevel              (GtkWidget *widget,
                                                            gboolean   is_toplevel);

void              _gtk_widget_grab_notify                  (GtkWidget *widget,
                                                            gboolean   was_grabbed);

void              _gtk_widget_propagate_hierarchy_changed  (GtkWidget *widget,
                                                            GtkWidget *previous_toplevel);
void              _gtk_widget_propagate_screen_changed     (GtkWidget *widget,
                                                            GdkScreen *previous_screen);
void              _gtk_widget_propagate_composited_changed (GtkWidget *widget);

void              _gtk_widget_set_device_window            (GtkWidget *widget,
                                                            GdkDevice *device,
                                                            GdkWindow *pointer_window);
GdkWindow *       _gtk_widget_get_device_window            (GtkWidget *widget,
                                                            GdkDevice *device);
GList *           _gtk_widget_list_devices                 (GtkWidget *widget);

void              _gtk_widget_synthesize_crossing          (GtkWidget       *from,
                                                            GtkWidget       *to,
                                                            GdkDevice       *device,
                                                            GdkCrossingMode  mode);

246
static inline gpointer _gtk_widget_peek_request_cache           (GtkWidget *widget);
247 248 249 250

void              _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
                                                            GtkWidget *toplevel,
                                                            gpointer   user_data);
251
GtkStyleContext * _gtk_widget_peek_style_context           (GtkWidget *widget);
252 253 254
GtkStyle *        _gtk_widget_get_style                    (GtkWidget *widget);
void              _gtk_widget_set_style                    (GtkWidget *widget,
                                                            GtkStyle  *style);
255
gboolean          _gtk_widget_supports_clip                (GtkWidget *widget);
256 257
void              _gtk_widget_set_simple_clip              (GtkWidget *widget,
                                                            GtkAllocation *content_clip);
258

259 260 261 262 263 264 265
typedef gboolean (*GtkCapturedEventHandler) (GtkWidget *widget, GdkEvent *event);

void              _gtk_widget_set_captured_event_handler (GtkWidget               *widget,
                                                          GtkCapturedEventHandler  handler);

gboolean          _gtk_widget_captured_event               (GtkWidget *widget,
                                                            GdkEvent  *event);
266

267
GtkWidgetPath *   _gtk_widget_create_path                  (GtkWidget    *widget);
268
void              gtk_widget_clear_path                    (GtkWidget    *widget);
269 270 271
void              _gtk_widget_invalidate_style_context     (GtkWidget    *widget,
                                                            GtkCssChange  change);
void              _gtk_widget_style_context_invalidated    (GtkWidget    *widget);
272

273
void              _gtk_widget_update_parent_muxer          (GtkWidget    *widget);
274 275
GtkActionMuxer *  _gtk_widget_get_action_muxer             (GtkWidget    *widget,
                                                            gboolean      create);
276

277
void              _gtk_widget_add_controller               (GtkWidget           *widget,
278
                                                            GtkEventController  *controller);
279 280
void              _gtk_widget_remove_controller            (GtkWidget           *widget,
                                                            GtkEventController  *controller);
281 282
GList *           _gtk_widget_list_controllers             (GtkWidget           *widget,
                                                            GtkPropagationPhase  phase);
283 284
gboolean          _gtk_widget_consumes_motion              (GtkWidget           *widget,
                                                            GdkEventSequence    *sequence);
285

286
gboolean          gtk_widget_has_tick_callback             (GtkWidget *widget);
287

288 289 290
void              gtk_widget_set_csd_input_shape           (GtkWidget            *widget,
                                                            const cairo_region_t *region);

291 292
gboolean          gtk_widget_has_size_request              (GtkWidget *widget);

293 294
void              gtk_widget_reset_controllers             (GtkWidget *widget);

295 296 297 298 299 300
gboolean          gtk_widget_query_tooltip                 (GtkWidget  *widget,
                                                            gint        x,
                                                            gint        y,
                                                            gboolean    keyboard_mode,
                                                            GtkTooltip *tooltip);

301 302 303 304 305
void              gtk_widget_render                        (GtkWidget            *widget,
                                                            GdkWindow            *window,
                                                            const cairo_region_t *region);


306 307
/* inline getters */

308 309 310 311 312 313
static inline gboolean
gtk_widget_get_resize_needed (GtkWidget *widget)
{
  return widget->priv->resize_needed;
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
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;
}

338 339 340 341 342 343 344 345 346 347 348 349
static inline gboolean
_gtk_widget_is_drawable (GtkWidget *widget)
{
  return widget->priv->visible && widget->priv->mapped;
}

static inline gboolean
_gtk_widget_get_has_window (GtkWidget *widget)
{
  return !widget->priv->no_window;
}

350 351 352 353 354 355 356 357 358 359 360 361
static inline gboolean
_gtk_widget_get_realized (GtkWidget *widget)
{
  return widget->priv->realized;
}

static inline gboolean
_gtk_widget_is_toplevel (GtkWidget *widget)
{
  return widget->priv->toplevel;
}

362 363 364 365 366 367
static inline GtkStateFlags
_gtk_widget_get_state_flags (GtkWidget *widget)
{
  return widget->priv->state_flags;
}

368 369 370 371 372 373 374 375 376 377 378
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;
}

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
static inline GtkWidget *
_gtk_widget_get_toplevel (GtkWidget *widget)
{
  while (widget->priv->parent)
    widget = widget->priv->parent;

  return widget;
}

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

397 398 399 400 401 402
static inline gpointer
_gtk_widget_peek_request_cache (GtkWidget *widget)
{
  return &widget->priv->requests;
}

403 404 405 406 407 408 409 410 411 412 413 414 415
static inline GdkWindow *
_gtk_widget_get_window (GtkWidget *widget)
{
  return widget->priv->window;
}

static inline void
_gtk_widget_get_allocation (GtkWidget     *widget,
                            GtkAllocation *allocation)
{
  *allocation = widget->priv->allocation;
}

Emmanuele Bassi's avatar
Emmanuele Bassi committed
416 417 418
G_END_DECLS

#endif /* __GTK_WIDGET_PRIVATE_H__ */