With CTK+ 2.x it was common to include just the header files for a few widgets that your application was using, which could lead to problems with missing definitions, etc. CTK+ 3 tightens the rules about which header files you are allowed to include directly. The allowed header files are are

(these relative paths are assuming that you are using the include paths that are specified in the ctk+-2.0.pc file, as returned by pkg-config --cflags ctk+-2.0.pc.)

To check that your application only includes the allowed headers, you can use defines to disable inclusion of individual headers, as follows:

    make CFLAGS+="-DCTK_DISABLE_SINGLE_INCLUDES"
    

Over the years, a number of functions, and in some cases, entire widgets have been deprecated. These deprecations are clearly spelled out in the API reference, with hints about the recommended replacements. The API reference for CTK+ 2 also includes an index of all deprecated symbols.

To verify that your program does not use any deprecated symbols, you can use defines to remove deprecated symbols from the header files, as follows:

    make CFLAGS+="-DCDK_DISABLE_DEPRECATED -DCTK_DISABLE_DEPRECATED"
   

Note that some parts of our API, such as enumeration values, are not well covered by the deprecation warnings. In most cases, using them will require you to also use deprecated functions, which will trigger warnings. But some things, like the CTK_DIALOG_NO_SEPARATOR flag that has disappeared in CTK+ 3, may not.

CTK+ 3 removes many implementation details and struct members from its public headers.

To ensure that your application does not have problems with this, you define the preprocessor symbol GSEAL_ENABLE while building your application against CTK+ 2.x. This will make the compiler catch all uses of direct access to struct fields so that you can go through them one by one and replace them with a call to an accessor function instead.

    make CFLAGS+="-DGSEAL_ENABLE"
    

While it may be painful to convert, this helps us keep API and ABI compatibility when we change internal interfaces. As a quick example, when adding GSEAL_ENABLE, if you see an error like:

    error: 'CtkToggleButton' has no member named 'active'
    

this means that you are accessing the public structure of CtkToggleButton directly, perhaps with some code like:

1
2
3
4
5
6
7
8

static void
on_toggled (CtkToggleButton *button)
{
  if (button->active)
    frob_active ();
  else
    frob_inactive ();
}

In most cases, this can easily be replaced with the correct accessor method. The main rule is that if you have code like the above which accesses the "active" field of a "CtkToggleButton", then the accessor method becomes "ctk_toggle_button_get_active":

1
2
3
4
5
6
7
8

static void
on_toggled (CtkToggleButton *button)
{
  if (ctk_toggle_button_get_active (button))
    frob_active ();
  else
    frob_inactive ();
}

In the case of setting field members directly, there's usually a corresponding setter method.

Key constants have gained a _KEY_ infix. For example, CDK_a is now CDK_KEY_a. In CTK+ 2, the old names continue to be available. In CTK+ 3 however, the old names will require an explicit include of the cdkkeysyms-compat.h header.

The cdk_spawn family of functions has been deprecated in CDK 2.24 and removed from CDK 3. Various replacements exist; the best replacement depends on the circumstances:

In CTK+ 3, the CDK drawing API (which closely mimics the X drawing API, which is itself modeled after PostScript) has been removed. All drawing in CTK+ 3 is done via cairo.

The CdkGC and CdkImage objects, as well as all the functions using them, are gone. This includes the cdk_draw family of functions like cdk_draw_rectangle() and cdk_draw_drawable(). As CdkGC is roughly equivalent to cairo_t and CdkImage was used for drawing images to CdkWindows, which cairo supports automatically, a transition is usually straightforward.

The following examples show a few common drawing idioms used by applications that have been ported to use cairo and how the code was replaced.

1
2
3
4
5
6
7
8
9

cdk_draw_pixbuf (window,
                 ctk_widget_get_style (widget)->black_gc,
                 pixbuf,
                 0, 0
                 x, y,
                 gdk_pixbuf_get_width (pixbuf),
                 gdk_pixbuf_get_height (pixbuf),
                 CDK_RGB_DITHER_NORMAL,
                 0, 0);

1
2
3
4

cairo_t *cr = cdk_cairo_create (window);
cdk_cairo_set_source_pixbuf (cr, pixbuf, x, y);
cairo_paint (cr);
cairo_destroy (cr);

1
2
3
4
5
6
7
8
9
10
11
12
13
14

CdkGCValues gc_values;
CdkGC *gc;

/* setup */
gc = ctk_widget_get_style (widget)->black_gc;
cdk_gc_set_tile (gc, pixmap);
cdk_gc_set_fill (gc, CDK_TILED);
cdk_gc_set_ts_origin (gc, x_origin, y_origin);
/* use */
cdk_draw_rectangle (window, gc, TRUE, 0, 0, width, height);
/* restore */
cdk_gc_set_tile (gc, NULL);
cdk_gc_set_fill (gc, CDK_SOLID);
cdk_gc_set_ts_origin (gc, 0, 0);

1
2
3
4
5
6
7
8
9
10

cairo_t *cr;
cairo_surface_t *surface;

surface = ...
cr = cdk_cairo_create (window);
cairo_set_source_surface (cr, surface, x_origin, y_origin);
cairo_pattern_set_extend (cairo_get_source (cr), CAIRO_EXTEND_REPEAT);
cairo_rectangle (cr, 0, 0, width, height);
cairo_fill (cr);
cairo_destroy (cr);

1
2
3
4
5
6
7
8
9

CdkGC *gc;

/* setup */
gc = ctk_widget_get_style (widget)->text_gc[state];
cdk_gc_set_clip_rectangle (gc, &area);
/* use */
cdk_draw_layout (drawable, gc, x, y, layout);
/* restore */
cdk_gc_set_clip_rectangle (gc, NULL);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

CtkStyleContext *context;
CtkStateFlags flags;
CdkRGBA rgba;
cairo_t *cr;

cr = cdk_cairo_create (drawable);
/* clip */
cdk_cairo_rectangle (cr, &area);
cairo_clip (cr);
/* set the correct source color */
context = ctk_widget_get_style_context (widget));
state = ctk_widget_get_state_flags (widget);
ctk_style_context_get_color (context, state, &rgba);
cdk_cairo_set_source_rgba (cr, &rgba);
/* draw the text */
cairo_move_to (cr, x, y);
pango_cairo_show_layout (cr, layout);
cairo_destroy (cr);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

static cairo_pattern_t *
ctk_color_button_get_checkered (void)
{
    /* need to respect pixman's stride being a multiple of 4 */
    static unsigned char data[8] = { 0xFF, 0x00, 0x00, 0x00,
                                     0x00, 0xFF, 0x00, 0x00 };
    cairo_surface_t *surface;
    cairo_pattern_t *pattern;

    surface = cairo_image_surface_create_for_data (data,
                                                   CAIRO_FORMAT_A8,
                                                   2, 2,
                                                   4);
    pattern = cairo_pattern_create_for_surface (surface);
    cairo_surface_destroy (surface);
    cairo_pattern_set_extend (pattern, CAIRO_EXTEND_REPEAT);
    cairo_pattern_set_filter (pattern, CAIRO_FILTER_NEAREST);

    return pattern;
}

1
2
3
4
5
6

cdk_draw_drawable (pixmap,
                   gc,
                   pixmap,
                   area.x + dx, area.y + dy,
                   area.x, area.y,
                   area.width, area.height);

1
2
3
4
5
6
7
8
9
10
11
12
13

cairo_t *cr = cairo_create (surface);
/* clipping restricts the intermediate surface's size, so it's a good idea
 * to use it. */
cdk_cairo_rectangle (cr, &area);
cairo_clip (cr);
/* Now push a group to change the target */
cairo_push_group (cr);
cairo_set_source_surface (cr, surface, dx, dy);
cairo_paint (cr);
/* Now copy the intermediate target back */
cairo_pop_group_to_source (cr);
cairo_paint (cr);
cairo_destroy (cr);