include/wx/gtk/private/gtk2-compat.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/private/compat.h
   3 // Purpose:     Compatibility code for older GTK+ versions
   4 // Author:      Vaclav Slavik
   5 // Created:     2011-03-25
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2011 Vaclav Slavik <vslavik@fastmail.fm>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_GTK_PRIVATE_COMPAT_H_
  12 #define _WX_GTK_PRIVATE_COMPAT_H_
  13
  14 // ----------------------------------------------------------------------------
  15 // Implementations of new accessors for older GTK+ versions
  16 // ----------------------------------------------------------------------------
  17
  18 // GTK+ deprecated direct access to struct members and some other stuff,
  19 // replacing them with simple accessor functions. These aren't available in
  20 // older versions, though, so we have to provide them for compatibility.
  21 //
  22 // Note: wx_ prefix is used to avoid symbol conflicts at runtime
  23 //
  24 // Note 2: We support building against newer GTK+ version and using an older
  25 //         one at runtime, so we must provide our implementations of these
  26 //         functions even if GTK_CHECK_VERSION would indicate the function is
  27 //         already available in GTK+.
  28
  29 #ifndef __WXGTK3__
  30
  31 // ----------------------------------------------------------------------------
  32 // the following were introduced in GTK+ 2.8
  33
  34 static inline GtkWidget* wx_gtk_scrolled_window_get_hscrollbar(GtkScrolledWindow* scrolled_window)
  35 {
  36     return scrolled_window->hscrollbar;
  37 }
  38 #define gtk_scrolled_window_get_hscrollbar wx_gtk_scrolled_window_get_hscrollbar
  39
  40 static inline GtkWidget* wx_gtk_scrolled_window_get_vscrollbar(GtkScrolledWindow* scrolled_window)
  41 {
  42     return scrolled_window->vscrollbar;
  43 }
  44 #define gtk_scrolled_window_get_vscrollbar wx_gtk_scrolled_window_get_vscrollbar
  45
  46 // ----------------------------------------------------------------------------
  47 // the following were introduced in GLib 2.10
  48
  49 static inline gpointer wx_g_object_ref_sink(gpointer object)
  50 {
  51     g_object_ref(object);
  52     gtk_object_sink(GTK_OBJECT(object));
  53     return object;
  54 }
  55 #define g_object_ref_sink wx_g_object_ref_sink
  56
  57 // ----------------------------------------------------------------------------
  58 // the following were introduced in GTK+ 2.12 and GtkAboutDialog itself is not
  59 // in 2.4 so skip this if we don't have it.
  60 #if GTK_CHECK_VERSION(2,6,0)
  61
  62 static inline void wx_gtk_about_dialog_set_program_name(GtkAboutDialog* about, const gchar* name)
  63 {
  64     gtk_about_dialog_set_name(about, name);
  65 }
  66 #define gtk_about_dialog_set_program_name wx_gtk_about_dialog_set_program_name
  67 #endif // 2.6.0
  68
  69 // ----------------------------------------------------------------------------
  70 // the following were introduced in GTK+ 2.14
  71
  72 static inline gdouble wx_gtk_adjustment_get_lower(GtkAdjustment* adjustment)
  73 {
  74     return adjustment->lower;
  75 }
  76 #define gtk_adjustment_get_lower wx_gtk_adjustment_get_lower
  77
  78 static inline gdouble wx_gtk_adjustment_get_page_increment(GtkAdjustment* adjustment)
  79 {
  80     return adjustment->page_increment;
  81 }
  82 #define gtk_adjustment_get_page_increment wx_gtk_adjustment_get_page_increment
  83
  84 static inline gdouble wx_gtk_adjustment_get_page_size(GtkAdjustment* adjustment)
  85 {
  86     return adjustment->page_size;
  87 }
  88 #define gtk_adjustment_get_page_size wx_gtk_adjustment_get_page_size
  89
  90 static inline gdouble wx_gtk_adjustment_get_step_increment(GtkAdjustment* adjustment)
  91 {
  92     return adjustment->step_increment;
  93 }
  94 #define gtk_adjustment_get_step_increment wx_gtk_adjustment_get_step_increment
  95
  96 static inline gdouble wx_gtk_adjustment_get_upper(GtkAdjustment* adjustment)
  97 {
  98     return adjustment->upper;
  99 }
 100 #define gtk_adjustment_get_upper wx_gtk_adjustment_get_upper
 101
 102 static inline void wx_gtk_adjustment_set_page_size(GtkAdjustment* adjustment, gdouble page_size)
 103 {
 104     adjustment->page_size = page_size;
 105 }
 106 #define gtk_adjustment_set_page_size wx_gtk_adjustment_set_page_size
 107
 108 static inline GtkWidget* wx_gtk_color_selection_dialog_get_color_selection(GtkColorSelectionDialog* csd)
 109 {
 110     return csd->colorsel;
 111 }
 112 #define gtk_color_selection_dialog_get_color_selection wx_gtk_color_selection_dialog_get_color_selection
 113
 114 static inline GtkWidget* wx_gtk_dialog_get_content_area(GtkDialog* dialog)
 115 {
 116     return dialog->vbox;
 117 }
 118 #define gtk_dialog_get_content_area wx_gtk_dialog_get_content_area
 119
 120 static inline GtkWidget* wx_gtk_dialog_get_action_area(GtkDialog* dialog)
 121 {
 122     return dialog->action_area;
 123 }
 124 #define gtk_dialog_get_action_area wx_gtk_dialog_get_action_area
 125
 126 static inline guint16 wx_gtk_entry_get_text_length(GtkEntry* entry)
 127 {
 128     return entry->text_length;
 129 }
 130 #define gtk_entry_get_text_length wx_gtk_entry_get_text_length
 131
 132 static inline const guchar* wx_gtk_selection_data_get_data(GtkSelectionData* selection_data)
 133 {
 134     return selection_data->data;
 135 }
 136 #define gtk_selection_data_get_data wx_gtk_selection_data_get_data
 137
 138 static inline GdkAtom wx_gtk_selection_data_get_data_type(GtkSelectionData* selection_data)
 139 {
 140     return selection_data->type;
 141 }
 142 #define gtk_selection_data_get_data_type wx_gtk_selection_data_get_data_type
 143
 144 static inline gint wx_gtk_selection_data_get_format(GtkSelectionData* selection_data)
 145 {
 146     return selection_data->format;
 147 }
 148 #define gtk_selection_data_get_format wx_gtk_selection_data_get_format
 149
 150 static inline gint wx_gtk_selection_data_get_length(GtkSelectionData* selection_data)
 151 {
 152     return selection_data->length;
 153 }
 154 #define gtk_selection_data_get_length wx_gtk_selection_data_get_length
 155
 156 static inline GdkAtom wx_gtk_selection_data_get_target(GtkSelectionData* selection_data)
 157 {
 158     return selection_data->target;
 159 }
 160 #define gtk_selection_data_get_target wx_gtk_selection_data_get_target
 161
 162 static inline GdkWindow* wx_gtk_widget_get_window(GtkWidget* widget)
 163 {
 164     return widget->window;
 165 }
 166 #define gtk_widget_get_window wx_gtk_widget_get_window
 167
 168 static inline GtkWidget* wx_gtk_window_get_default_widget(GtkWindow* window)
 169 {
 170     return window->default_widget;
 171 }
 172 #define gtk_window_get_default_widget wx_gtk_window_get_default_widget
 173
 174 // ----------------------------------------------------------------------------
 175 // the following were introduced in GTK+ 2.16
 176
 177 static inline GdkAtom wx_gtk_selection_data_get_selection(GtkSelectionData* selection_data)
 178 {
 179     return selection_data->selection;
 180 }
 181 #define gtk_selection_data_get_selection wx_gtk_selection_data_get_selection
 182
 183 // ----------------------------------------------------------------------------
 184 // the following were introduced in GTK+ 2.18
 185
 186 static inline void wx_gtk_cell_renderer_get_alignment(GtkCellRenderer* cell, gfloat* xalign, gfloat* yalign)
 187 {
 188     *xalign = cell->xalign;
 189     *yalign = cell->yalign;
 190 }
 191 #define gtk_cell_renderer_get_alignment wx_gtk_cell_renderer_get_alignment
 192
 193 static inline void wx_gtk_cell_renderer_get_padding(GtkCellRenderer* cell, gint* xpad, gint* ypad)
 194 {
 195     *xpad = cell->xpad;
 196     *ypad = cell->ypad;
 197 }
 198 #define gtk_cell_renderer_get_padding wx_gtk_cell_renderer_get_padding
 199
 200 static inline void wx_gtk_widget_get_allocation(GtkWidget* widget, GtkAllocation* allocation)
 201 {
 202     *allocation = widget->allocation;
 203 }
 204 #define gtk_widget_get_allocation wx_gtk_widget_get_allocation
 205
 206 inline gboolean wx_gtk_widget_get_has_window(GtkWidget *widget)
 207 {
 208     return !GTK_WIDGET_NO_WINDOW(widget);
 209 }
 210 #define gtk_widget_get_has_window wx_gtk_widget_get_has_window
 211
 212
 213 inline gboolean wx_gtk_widget_get_has_grab(GtkWidget *widget)
 214 {
 215     return GTK_WIDGET_HAS_GRAB(widget);
 216 }
 217 #define gtk_widget_get_has_grab wx_gtk_widget_get_has_grab
 218
 219
 220 inline gboolean wx_gtk_widget_get_visible(GtkWidget *widget)
 221 {
 222     return GTK_WIDGET_VISIBLE(widget);
 223 }
 224 #define gtk_widget_get_visible wx_gtk_widget_get_visible
 225
 226
 227 inline gboolean wx_gtk_widget_get_sensitive(GtkWidget *widget)
 228 {
 229     return GTK_WIDGET_SENSITIVE(widget);
 230 }
 231 #define gtk_widget_get_sensitive wx_gtk_widget_get_sensitive
 232
 233
 234 inline gboolean wx_gtk_widget_is_drawable(GtkWidget *widget)
 235 {
 236     return GTK_WIDGET_DRAWABLE(widget);
 237 }
 238 #define gtk_widget_is_drawable wx_gtk_widget_is_drawable
 239
 240
 241 inline gboolean wx_gtk_widget_get_can_focus(GtkWidget *widget)
 242 {
 243     return GTK_WIDGET_CAN_FOCUS(widget);
 244 }
 245 #define gtk_widget_get_can_focus wx_gtk_widget_get_can_focus
 246
 247 inline void wx_gtk_widget_set_can_focus(GtkWidget *widget, gboolean can)
 248 {
 249     if ( can )
 250         GTK_WIDGET_SET_FLAGS(widget, GTK_CAN_FOCUS);
 251     else
 252         GTK_WIDGET_UNSET_FLAGS(widget, GTK_CAN_FOCUS);
 253 }
 254 #define gtk_widget_set_can_focus wx_gtk_widget_set_can_focus
 255
 256
 257 inline gboolean wx_gtk_widget_get_can_default(GtkWidget *widget)
 258 {
 259     return GTK_WIDGET_CAN_DEFAULT(widget);
 260 }
 261 #define gtk_widget_get_can_default wx_gtk_widget_get_can_default
 262
 263 inline void wx_gtk_widget_set_can_default(GtkWidget *widget, gboolean can)
 264 {
 265     if ( can )
 266         GTK_WIDGET_SET_FLAGS(widget, GTK_CAN_DEFAULT);
 267     else
 268         GTK_WIDGET_UNSET_FLAGS(widget, GTK_CAN_DEFAULT);
 269 }
 270 #define gtk_widget_set_can_default wx_gtk_widget_set_can_default
 271
 272
 273 inline gboolean wx_gtk_widget_has_default(GtkWidget *widget)
 274 {
 275     return GTK_WIDGET_HAS_DEFAULT(widget);
 276 }
 277 #define gtk_widget_has_default wx_gtk_widget_has_default
 278
 279
 280 inline GtkStateType wx_gtk_widget_get_state(GtkWidget *widget)
 281 {
 282     return (GtkStateType)GTK_WIDGET_STATE(widget);
 283 }
 284 #define gtk_widget_get_state wx_gtk_widget_get_state
 285
 286
 287 inline gboolean wx_gtk_widget_get_double_buffered(GtkWidget *widget)
 288 {
 289     return GTK_WIDGET_DOUBLE_BUFFERED(widget);
 290 }
 291 #define gtk_widget_get_double_buffered wx_gtk_widget_get_double_buffered
 292
 293 static inline gboolean wx_gtk_widget_has_grab(GtkWidget* widget)
 294 {
 295     return GTK_WIDGET_HAS_GRAB(widget);
 296 }
 297 #define gtk_widget_has_grab wx_gtk_widget_has_grab
 298
 299 static inline void wx_gtk_widget_set_allocation(GtkWidget* widget, const GtkAllocation* allocation)
 300 {
 301     widget->allocation = *allocation;
 302 }
 303 #define gtk_widget_set_allocation wx_gtk_widget_set_allocation
 304
 305 // ----------------------------------------------------------------------------
 306 // the following were introduced in GTK+ 2.20
 307
 308 inline gboolean wx_gtk_widget_get_realized(GtkWidget *widget)
 309 {
 310     return GTK_WIDGET_REALIZED(widget);
 311 }
 312 #define gtk_widget_get_realized wx_gtk_widget_get_realized
 313
 314
 315 inline gboolean wx_gtk_widget_get_mapped(GtkWidget *widget)
 316 {
 317     return GTK_WIDGET_MAPPED(widget);
 318 }
 319 #define gtk_widget_get_mapped wx_gtk_widget_get_mapped
 320
 321 static inline void wx_gtk_widget_get_requisition(GtkWidget* widget, GtkRequisition* requisition)
 322 {
 323     *requisition = widget->requisition;
 324 }
 325 #define gtk_widget_get_requisition wx_gtk_widget_get_requisition
 326
 327 static inline GdkWindow* wx_gtk_entry_get_text_window(GtkEntry* entry)
 328 {
 329     return entry->text_area;
 330 }
 331 #define gtk_entry_get_text_window wx_gtk_entry_get_text_window
 332
 333 // ----------------------------------------------------------------------------
 334 // the following were introduced in GTK+ 2.22
 335
 336 static inline GdkWindow* wx_gtk_button_get_event_window(GtkButton* button)
 337 {
 338     return button->event_window;
 339 }
 340 #define gtk_button_get_event_window wx_gtk_button_get_event_window
 341
 342 static inline GdkDragAction wx_gdk_drag_context_get_actions(GdkDragContext* context)
 343 {
 344     return context->actions;
 345 }
 346 #define gdk_drag_context_get_actions wx_gdk_drag_context_get_actions
 347
 348 static inline GdkDragAction wx_gdk_drag_context_get_selected_action(GdkDragContext* context)
 349 {
 350     return context->action;
 351 }
 352 #define gdk_drag_context_get_selected_action wx_gdk_drag_context_get_selected_action
 353
 354 static inline GdkDragAction wx_gdk_drag_context_get_suggested_action(GdkDragContext* context)
 355 {
 356     return context->suggested_action;
 357 }
 358 #define gdk_drag_context_get_suggested_action wx_gdk_drag_context_get_suggested_action
 359
 360 static inline GList* wx_gdk_drag_context_list_targets(GdkDragContext* context)
 361 {
 362     return context->targets;
 363 }
 364 #define gdk_drag_context_list_targets wx_gdk_drag_context_list_targets
 365
 366 static inline gint wx_gdk_visual_get_depth(GdkVisual* visual)
 367 {
 368     return visual->depth;
 369 }
 370 #define gdk_visual_get_depth wx_gdk_visual_get_depth
 371
 372 static inline gboolean wx_gtk_window_has_group(GtkWindow* window)
 373 {
 374     return window->group != NULL;
 375 }
 376 #define gtk_window_has_group wx_gtk_window_has_group
 377
 378 // ----------------------------------------------------------------------------
 379 // the following were introduced in GTK+ 2.24
 380
 381 static inline GdkDisplay* wx_gdk_window_get_display(GdkWindow* window)
 382 {
 383     return gdk_drawable_get_display(window);
 384 }
 385 #define gdk_window_get_display wx_gdk_window_get_display
 386
 387 static inline GdkScreen* wx_gdk_window_get_screen(GdkWindow* window)
 388 {
 389     return gdk_drawable_get_screen(window);
 390 }
 391 #define gdk_window_get_screen wx_gdk_window_get_screen
 392
 393 static inline gint wx_gdk_window_get_height(GdkWindow* window)
 394 {
 395     int h;
 396     gdk_drawable_get_size(window, NULL, &h);
 397     return h;
 398 }
 399 #define gdk_window_get_height wx_gdk_window_get_height
 400
 401 static inline gint wx_gdk_window_get_width(GdkWindow* window)
 402 {
 403     int w;
 404     gdk_drawable_get_size(window, &w, NULL);
 405     return w;
 406 }
 407 #define gdk_window_get_width wx_gdk_window_get_width
 408
 409 #if GTK_CHECK_VERSION(2,10,0)
 410 static inline void wx_gdk_cairo_set_source_window(cairo_t* cr, GdkWindow* window, gdouble x, gdouble y)
 411 {
 412     gdk_cairo_set_source_pixmap(cr, window, x, y);
 413 }
 414 #define gdk_cairo_set_source_window wx_gdk_cairo_set_source_window
 415 #endif
 416
 417 // ----------------------------------------------------------------------------
 418 // the following were introduced in GTK+ 3.0
 419
 420 static inline void wx_gdk_window_get_geometry(GdkWindow* window, gint* x, gint* y, gint* width, gint* height)
 421 {
 422     gdk_window_get_geometry(window, x, y, width, height, NULL);
 423 }
 424 #define gdk_window_get_geometry wx_gdk_window_get_geometry
 425
 426 static inline GtkWidget* wx_gtk_tree_view_column_get_button(GtkTreeViewColumn* tree_column)
 427 {
 428     return tree_column->button;
 429 }
 430 #define gtk_tree_view_column_get_button wx_gtk_tree_view_column_get_button
 431
 432 static inline GtkWidget* wx_gtk_box_new(GtkOrientation orientation, gint spacing)
 433 {
 434     GtkWidget* widget;
 435     if (orientation == GTK_ORIENTATION_HORIZONTAL)
 436         widget = gtk_hbox_new(false, spacing);
 437     else
 438         widget = gtk_vbox_new(false, spacing);
 439     return widget;
 440 }
 441 #define gtk_box_new wx_gtk_box_new
 442
 443 static inline GtkWidget* wx_gtk_button_box_new(GtkOrientation orientation)
 444 {
 445     GtkWidget* widget;
 446     if (orientation == GTK_ORIENTATION_HORIZONTAL)
 447         widget = gtk_hbutton_box_new();
 448     else
 449         widget = gtk_vbutton_box_new();
 450     return widget;
 451 }
 452 #define gtk_button_box_new wx_gtk_button_box_new
 453
 454 static inline GtkWidget* wx_gtk_scale_new(GtkOrientation orientation, GtkAdjustment* adjustment)
 455 {
 456     GtkWidget* widget;
 457     if (orientation == GTK_ORIENTATION_HORIZONTAL)
 458         widget = gtk_hscale_new(adjustment);
 459     else
 460         widget = gtk_vscale_new(adjustment);
 461     return widget;
 462 }
 463 #define gtk_scale_new wx_gtk_scale_new
 464
 465 static inline GtkWidget* wx_gtk_scrollbar_new(GtkOrientation orientation, GtkAdjustment* adjustment)
 466 {
 467     GtkWidget* widget;
 468     if (orientation == GTK_ORIENTATION_HORIZONTAL)
 469         widget = gtk_hscrollbar_new(adjustment);
 470     else
 471         widget = gtk_vscrollbar_new(adjustment);
 472     return widget;
 473 }
 474 #define gtk_scrollbar_new wx_gtk_scrollbar_new
 475
 476 static inline GtkWidget* wx_gtk_separator_new(GtkOrientation orientation)
 477 {
 478     GtkWidget* widget;
 479     if (orientation == GTK_ORIENTATION_HORIZONTAL)
 480         widget = gtk_hseparator_new();
 481     else
 482         widget = gtk_vseparator_new();
 483     return widget;
 484 }
 485 #define gtk_separator_new wx_gtk_separator_new
 486
 487 static inline void wx_gtk_widget_get_preferred_height(GtkWidget* widget, gint* minimum, gint* natural)
 488 {
 489     GtkRequisition req;
 490     gtk_widget_size_request(widget, &req);
 491     if (minimum)
 492         *minimum = req.height;
 493     if (natural)
 494         *natural = req.height;
 495 }
 496 #define gtk_widget_get_preferred_height wx_gtk_widget_get_preferred_height
 497
 498 static inline void wx_gtk_widget_get_preferred_width(GtkWidget* widget, gint* minimum, gint* natural)
 499 {
 500     GtkRequisition req;
 501     gtk_widget_size_request(widget, &req);
 502     if (minimum)
 503         *minimum = req.width;
 504     if (natural)
 505         *natural = req.width;
 506 }
 507 #define gtk_widget_get_preferred_width wx_gtk_widget_get_preferred_width
 508
 509 static inline void wx_gtk_widget_get_preferred_size(GtkWidget* widget, GtkRequisition* minimum, GtkRequisition* natural)
 510 {
 511     GtkRequisition* req = minimum;
 512     if (req == NULL)
 513         req = natural;
 514     gtk_widget_size_request(widget, req);
 515 }
 516 #define gtk_widget_get_preferred_size wx_gtk_widget_get_preferred_size
 517
 518 #endif // !__WXGTK3__
 519 #endif // _WX_GTK_PRIVATE_COMPAT_H_