GtkCellArea

struct GtkCellAreaClass {
  void (* add) (
    GtkCellArea* area,
    GtkCellRenderer* renderer
  );
  void (* remove) (
    GtkCellArea* area,
    GtkCellRenderer* renderer
  );
  void (* foreach) (
    GtkCellArea* area,
    GtkCellCallback callback,
    gpointer callback_data
  );
  void (* foreach_alloc) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    const GdkRectangle* cell_area,
    const GdkRectangle* background_area,
    GtkCellAllocCallback callback,
    gpointer callback_data
  );
  int (* event) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    GdkEvent* event,
    const GdkRectangle* cell_area,
    GtkCellRendererState flags
  );
  void (* snapshot) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    GtkSnapshot* snapshot,
    const GdkRectangle* background_area,
    const GdkRectangle* cell_area,
    GtkCellRendererState flags,
    gboolean paint_focus
  );
  void (* apply_attributes) (
    GtkCellArea* area,
    GtkTreeModel* tree_model,
    GtkTreeIter* iter,
    gboolean is_expander,
    gboolean is_expanded
  );
  GtkCellAreaContext* (* create_context) (
    GtkCellArea* area
  );
  GtkCellAreaContext* (* copy_context) (
    GtkCellArea* area,
    GtkCellAreaContext* context
  );
  GtkSizeRequestMode (* get_request_mode) (
    GtkCellArea* area
  );
  void (* get_preferred_width) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    int* minimum_width,
    int* natural_width
  );
  void (* get_preferred_height_for_width) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    int width,
    int* minimum_height,
    int* natural_height
  );
  void (* get_preferred_height) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    int* minimum_height,
    int* natural_height
  );
  void (* get_preferred_width_for_height) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    int height,
    int* minimum_width,
    int* natural_width
  );
  void (* set_cell_property) (
    GtkCellArea* area,
    GtkCellRenderer* renderer,
    guint property_id,
    const GValue* value,
    GParamSpec* pspec
  );
  void (* get_cell_property) (
    GtkCellArea* area,
    GtkCellRenderer* renderer,
    guint property_id,
    GValue* value,
    GParamSpec* pspec
  );
  gboolean (* focus) (
    GtkCellArea* area,
    GtkDirectionType direction
  );
  gboolean (* is_activatable) (
    GtkCellArea* area
  );
  gboolean (* activate) (
    GtkCellArea* area,
    GtkCellAreaContext* context,
    GtkWidget* widget,
    const GdkRectangle* cell_area,
    GtkCellRendererState flags,
    gboolean edit_only
  );
  
}

No description available.

Class members

add: void (* add) ( GtkCellArea* area, GtkCellRenderer* renderer )

Adds a GtkCellRenderer to the area.

remove: void (* remove) ( GtkCellArea* area, GtkCellRenderer* renderer )

Removes a GtkCellRenderer from the area.

foreach: void (* foreach) ( GtkCellArea* area, GtkCellCallback callback, gpointer callback_data )

Calls the GtkCellCallback function on every GtkCellRenderer in the area with the provided user data until the callback returns TRUE.

foreach_alloc: void (* foreach_alloc) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, const GdkRectangle* cell_area, const GdkRectangle* background_area, GtkCellAllocCallback callback, gpointer callback_data )

Calls the GtkCellAllocCallback function on every GtkCellRenderer in the area with the allocated area for the cell and the provided user data until the callback returns TRUE.

event: int (* event) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, GdkEvent* event, const GdkRectangle* cell_area, GtkCellRendererState flags )

Handle an event in the area, this is generally used to activate a cell at the event location for button events but can also be used to generically pass events to GtkWidgets drawn onto the area.

snapshot: void (* snapshot) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, GtkSnapshot* snapshot, const GdkRectangle* background_area, const GdkRectangle* cell_area, GtkCellRendererState flags, gboolean paint_focus )

Actually snapshot the area’s cells to the specified rectangle, background_area should be correctly distributed to the cells corresponding background areas.

apply_attributes: void (* apply_attributes) ( GtkCellArea* area, GtkTreeModel* tree_model, GtkTreeIter* iter, gboolean is_expander, gboolean is_expanded )

Apply the cell attributes to the cells. This is implemented as a signal and generally GtkCellArea subclasses don’t need to implement it since it is handled by the base class.

create_context: GtkCellAreaContext* (* create_context) ( GtkCellArea* area )

Creates and returns a class specific GtkCellAreaContext to store cell alignment and allocation details for a said GtkCellArea class.

copy_context: GtkCellAreaContext* (* copy_context) ( GtkCellArea* area, GtkCellAreaContext* context )

Creates a new GtkCellAreaContext in the same state as the passed context with any cell alignment data and allocations intact.

get_request_mode: GtkSizeRequestMode (* get_request_mode) ( GtkCellArea* area )

This allows an area to tell its layouting widget whether it prefers to be allocated in GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.

get_preferred_width: void (* get_preferred_width) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, int* minimum_width, int* natural_width )

Calculates the minimum and natural width of the areas cells with the current attributes applied while considering the particular layouting details of the said GtkCellArea. While requests are performed over a series of rows, alignments and overall minimum and natural sizes should be stored in the corresponding GtkCellAreaContext.

get_preferred_height_for_width: void (* get_preferred_height_for_width) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, int width, int* minimum_height, int* natural_height )

Calculates the minimum and natural height for the area if the passed context would be allocated the given width. When implementing this virtual method it is safe to assume that context has already stored the aligned cell widths for every GtkTreeModel row that context will be allocated for since this information was stored at GtkCellAreaClass.get_preferred_width() time. This virtual method should also store any necessary alignments of cell heights for the case that the context is allocated a height.

get_preferred_height: void (* get_preferred_height) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, int* minimum_height, int* natural_height )

Calculates the minimum and natural height of the areas cells with the current attributes applied. Essentially this is the same as GtkCellAreaClass.get_preferred_width() only for areas that are being requested as GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT.

get_preferred_width_for_height: void (* get_preferred_width_for_height) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, int height, int* minimum_width, int* natural_width )

Calculates the minimum and natural width for the area if the passed context would be allocated the given height. The same as GtkCellAreaClass.get_preferred_height_for_width() only for handling requests in the GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.

set_cell_property: void (* set_cell_property) ( GtkCellArea* area, GtkCellRenderer* renderer, guint property_id, const GValue* value, GParamSpec* pspec )

This should be implemented to handle changes in child cell properties for a given GtkCellRenderer that were previously installed on the GtkCellAreaClass with gtk_cell_area_class_install_cell_property().

get_cell_property: void (* get_cell_property) ( GtkCellArea* area, GtkCellRenderer* renderer, guint property_id, GValue* value, GParamSpec* pspec )

This should be implemented to report the values of child cell properties for a given child GtkCellRenderer.

focus: gboolean (* focus) ( GtkCellArea* area, GtkDirectionType direction )

This virtual method should be implemented to navigate focus from cell to cell inside the GtkCellArea. The GtkCellArea should move focus from cell to cell inside the area and return FALSE if focus logically leaves the area with the following exceptions: When the area contains no activatable cells, the entire area receives focus. Focus should not be given to cells that are actually “focus siblings” of other sibling cells (see gtk_cell_area_get_focus_from_sibling()). Focus is set by calling gtk_cell_area_set_focus_cell().

is_activatable: gboolean (* is_activatable) ( GtkCellArea* area )

Returns whether the GtkCellArea can respond to GtkCellAreaClass.activate(), usually this does not need to be implemented since the base class takes care of this however it can be enhanced if the GtkCellArea subclass can handle activation in other ways than activating its GtkCellRenderers.

activate: gboolean (* activate) ( GtkCellArea* area, GtkCellAreaContext* context, GtkWidget* widget, const GdkRectangle* cell_area, GtkCellRendererState flags, gboolean edit_only )

This is called when the layouting widget rendering the GtkCellArea activates the focus cell (see gtk_cell_area_get_focus_cell()).