GtkCellView: GTK+ 3 Reference Manual

## GtkCellView GtkCellView — A widget displaying a single row of a GtkTreeModel |

## Functions

GtkWidget * | gtk_cell_view_new ()
GtkWidget * | gtk_cell_view_new_with_context ()
GtkWidget * | gtk_cell_view_new_with_text ()
GtkWidget * | gtk_cell_view_new_with_markup ()
GtkWidget * | gtk_cell_view_new_with_pixbuf ()
void | gtk_cell_view_set_model ()
GtkTreeModel * | gtk_cell_view_get_model ()
void | gtk_cell_view_set_displayed_row ()
GtkTreePath * | gtk_cell_view_get_displayed_row ()
gboolean | gtk_cell_view_get_size_of_row ()
void | gtk_cell_view_set_background_color ()
void | gtk_cell_view_set_background_rgba ()
void | gtk_cell_view_set_draw_sensitive ()
gboolean | gtk_cell_view_get_draw_sensitive ()
void | gtk_cell_view_set_fit_model ()
gboolean | gtk_cell_view_get_fit_model ()

## Properties

gchar * | background | Write
GdkColor * | background-gdk | Read / Write
GdkRGBA * | background-rgba | Read / Write
gboolean | background-set | Read / Write
GtkCellArea * | cell-area | Read / Write / Construct Only
GtkCellAreaContext * | cell-area-context | Read / Write / Construct Only
gboolean | draw-sensitive | Read / Write
gboolean | fit-model | Read / Write
GtkTreeModel * | model | Read / Write

## Types and Values

struct | GtkCellView
struct | GtkCellViewClass

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkWidget
                ╰── GtkCellView

## Implemented Interfaces

GtkCellView implements AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkOrientable.

## Includes

    #include <gtk/gtk.h>

## Description

A GtkCellView displays a single row of a GtkTreeModel using a GtkCellArea and GtkCellAreaContext. A GtkCellAreaContext can be provided to the GtkCellView at construction time in order to keep the cellview in context of a group of cell views, this ensures that the renderers displayed will be properly aligned with eachother (like the aligned cells in the menus of GtkComboBox).

GtkCellView is GtkOrientable in order to decide in which orientation the underlying GtkCellAreaContext should be allocated. Taking the GtkComboBox menu as an example, cellviews should be oriented horizontally if the menus are listed top-to-bottom and thus all share the same width but may have separate individual heights (left-to-right menus should be allocated vertically since they all share the same height but may have variable widths).

## Functions

### gtk_cell_view_new ()

    GtkWidget *
    gtk_cell_view_new (void);

Creates a new GtkCellView widget.

#### Returns

A newly created GtkCellView widget.

Since: 2.6

### gtk_cell_view_new_with_context ()

    GtkWidget *
    gtk_cell_view_new_with_context (GtkCellArea *area,
                                    GtkCellAreaContext *context);

Creates a new GtkCellView widget with a specific GtkCellArea to layout cells and a specific GtkCellAreaContext.

Specifying the same context for a handfull of cells lets the underlying area synchronize the geometry for those cells, in this way alignments with cellviews for other rows are possible.

#### Parameters

area | the GtkCellArea to layout cells |
context | the GtkCellAreaContext in which to calculate cell geometry |

#### Returns

A newly created GtkCellView widget.

Since: 2.6

### gtk_cell_view_new_with_text ()

    GtkWidget *
    gtk_cell_view_new_with_text (const gchar *text);

Creates a new GtkCellView widget, adds a GtkCellRendererText to it, and makes it show `text` .

#### Parameters

text | the text to display in the cell view |

#### Returns

A newly created GtkCellView widget.

Since: 2.6

### gtk_cell_view_new_with_markup ()

    GtkWidget *
    gtk_cell_view_new_with_markup (const gchar *markup);

Creates a new GtkCellView widget, adds a GtkCellRendererText to it, and makes it show `markup` . The text can be marked up with the Pango text markup language.

#### Parameters

markup | the text to display in the cell view |

#### Returns

A newly created GtkCellView widget.

Since: 2.6

### gtk_cell_view_new_with_pixbuf ()

    GtkWidget *
    gtk_cell_view_new_with_pixbuf (GdkPixbuf *pixbuf);

Creates a new GtkCellView widget, adds a GtkCellRendererPixbuf to it, and makes it show `pixbuf` .

#### Parameters

pixbuf | the image to display in the cell view |

#### Returns

A newly created GtkCellView widget.

Since: 2.6

### gtk_cell_view_set_model ()

    void
    gtk_cell_view_set_model (GtkCellView *cell_view,
                             GtkTreeModel *model);

Sets the model for `cell_view` . If `cell_view` already has a model set, it will remove it before setting the new model. If `model` is `NULL`, then it will unset the old model.

#### Parameters

cell_view | a GtkCellView |
model | a GtkTreeModel. | [allow-none]

Since: 2.6

### gtk_cell_view_get_model ()

    GtkTreeModel *
    gtk_cell_view_get_model (GtkCellView *cell_view);

Returns the model for `cell_view` . If no model is used `NULL` is returned.

#### Parameters

cell_view | a GtkCellView |

#### Returns

a GtkTreeModel used or `NULL`.

[transfer none]

Since: 2.16

### gtk_cell_view_set_displayed_row ()

    void
    gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
                                     GtkTreePath *path);

Sets the row of the model that is currently displayed by the GtkCellView. If the path is unset, then the contents of the cellview “stick” at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the GtkCellView becomes temporarily empty.

#### Parameters

cell_view | a GtkCellView |
path | a GtkTreePath or `NULL` to unset. | [allow-none]

Since: 2.6

### gtk_cell_view_get_displayed_row ()

    GtkTreePath *
    gtk_cell_view_get_displayed_row (GtkCellView *cell_view);

Returns a GtkTreePath referring to the currently displayed row. If no row is currently displayed, `NULL` is returned.

#### Parameters

cell_view | a GtkCellView |

#### Returns

the currently displayed row or `NULL`

Since: 2.6

### gtk_cell_view_get_size_of_row ()

    gboolean
    gtk_cell_view_get_size_of_row (GtkCellView *cell_view,
                                   GtkTreePath *path,
                                   GtkRequisition *requisition);

`gtk_cell_view_get_size_of_row` has been deprecated since version 3.0 and should not be used in newly-written code.

Combo box formerly used this to calculate the sizes for cellviews, now you can achieve this by either using the “fit-model” property or by setting the currently displayed row of the GtkCellView and using `gtk_widget_get_preferred_size()`.

Sets `requisition` to the size needed by `cell_view` to display the model row pointed to by `path` .

#### Parameters

cell_view | a GtkCellView |
path | a GtkTreePath |
requisition | return location for the size. | [out]

#### Returns

`TRUE`

Since: 2.6

### gtk_cell_view_set_background_color ()

    void
    gtk_cell_view_set_background_color (GtkCellView *cell_view,
                                        const GdkColor *color);

`gtk_cell_view_set_background_color` has been deprecated since version 3.4 and should not be used in newly-written code.

Use `gtk_cell_view_set_background_rgba()` instead.

Sets the background color of `view` .

#### Parameters

cell_view | a GtkCellView |
color | the new background color |

Since: 2.6

### gtk_cell_view_set_background_rgba ()

    void
    gtk_cell_view_set_background_rgba (GtkCellView *cell_view,
                                       const GdkRGBA *rgba);

Sets the background color of `cell_view` .

#### Parameters

cell_view | a GtkCellView |
rgba | the new background color |

Since: 3.0

### gtk_cell_view_set_draw_sensitive ()

    void
    gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view,
                                      gboolean draw_sensitive);

Sets whether `cell_view` should draw all of its cells in a sensitive state, this is used by GtkComboBox menus to ensure that rows with insensitive cells that contain children appear sensitive in the parent menu item.

#### Parameters

cell_view | a GtkCellView |
draw_sensitive | whether to draw all cells in a sensitive state. |

Since: 3.0

### gtk_cell_view_get_draw_sensitive ()

    gboolean
    gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view);

Gets whether `cell_view` is configured to draw all of its cells in a sensitive state.

#### Parameters

cell_view | a GtkCellView |

#### Returns

whether `cell_view` draws all of its cells in a sensitive state

Since: 3.0

### gtk_cell_view_set_fit_model ()

    void
    gtk_cell_view_set_fit_model (GtkCellView *cell_view,
                                 gboolean fit_model);

Sets whether `cell_view` should request space to fit the entire GtkTreeModel.

This is used by GtkComboBox to ensure that the cell view displayed on the combo box’s button always gets enough space and does not resize when selection changes.

#### Parameters

cell_view | a GtkCellView |
fit_model | whether `cell_view` should request space for the whole model. |

Since: 3.0

### gtk_cell_view_get_fit_model ()

    gboolean
    gtk_cell_view_get_fit_model (GtkCellView *cell_view);

Gets whether `cell_view` is configured to request space to fit the entire GtkTreeModel.

#### Parameters

cell_view | a GtkCellView |

#### Returns

whether `cell_view` requests space to fit the entire GtkTreeModel.

Since: 3.0

## Types and Values

### struct GtkCellView

    struct GtkCellView;

### struct GtkCellViewClass

    struct GtkCellViewClass {
      GtkWidgetClass parent_class;
    };

#### Members

GtkWidgetClass `parent_class`; | The parent class. |

## Property Details

### The `“background”` property

      “background”               gchar *

Background color as a string.

Flags: Write

Default value: NULL

### The `“background-gdk”` property

      “background-gdk”           GdkColor *

The background color as a GdkColor

`GtkCellView:background-gdk` has been deprecated since version 3.4 and should not be used in newly-written code.

Use “background-rgba” instead.

Flags: Read / Write

### The `“background-rgba”` property

      “background-rgba”          GdkRGBA *

The background color as a GdkRGBA

Flags: Read / Write

Since: 3.0

### The `“background-set”` property

      “background-set”           gboolean

Whether this tag affects the background color.

Flags: Read / Write

Default value: FALSE

### The `“cell-area”` property

      “cell-area”                GtkCellArea *

The GtkCellArea rendering cells

If no area is specified when creating the cell view with `gtk_cell_view_new_with_context()` a horizontally oriented GtkCellAreaBox will be used.

since 3.0

Flags: Read / Write / Construct Only

### The `“cell-area-context”` property

      “cell-area-context”        GtkCellAreaContext *

The GtkCellAreaContext used to compute the geometry of the cell view.

A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with the same context.

GtkComboBox menus uses this to assign the same context to all cell views in the menu items for a single menu (each submenu creates its own context since the size of each submenu does not depend on parent or sibling menus).

since 3.0

Flags: Read / Write / Construct Only

### The `“draw-sensitive”` property

      “draw-sensitive”           gboolean

Whether all cells should be draw as sensitive for this view regardless of the actual cell properties (used to make menus with submenus appear sensitive when the items in submenus might be insensitive).

since 3.0

Flags: Read / Write

Default value: FALSE

### The `“fit-model”` property

      “fit-model”                gboolean

Whether the view should request enough space to always fit the size of every row in the model (used by the combo box to ensure the combo box size doesnt change when different items are selected).

since 3.0

Flags: Read / Write

Default value: FALSE

### The `“model”` property

      “model”                    GtkTreeModel *

The model for cell view

since 2.10

Flags: Read / Write