Module `Wrappers.Cell_renderer`

type t = [ `cell_renderer | `initially_unowned | `object_ ] Gobject.obj

val stop_editing : t -> bool -> unit

Informs the cell renderer that the editing is stopped. If @canceled is %TRUE, the cell renderer will emit the `GtkCellRenderer`::editing-canceled signal.

This function should be called by cell renderer implementations in response to the `GtkCellEditable::editing-done` signal of `GtkCellEditable`.

val start_editing : 
  t ->
  Ocgtk_gdk.Gdk.Wrappers.Event.t option ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  string ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Gtk_enums.cellrendererstate ->
  [ `cell_editable ] Gobject.obj option

Starts editing the contents of this @cell, through a new `GtkCellEditable` widget created by the `GtkCellRenderer`Class.start_editing virtual function.

val snapshot : 
  t ->
  [ `snapshot | `object_ ] Gobject.obj ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Gtk_enums.cellrendererstate ->
  unit

Invokes the virtual render function of the `GtkCellRenderer`. The three passed-in rectangles are areas in @cr. Most renderers will draw within @cell_area; the xalign, yalign, xpad, and ypad fields of the `GtkCellRenderer` should be honored with respect to @cell_area. @background_area includes the blank space around the cell, and also the area containing the tree expander; so the @background_area rectangles for all cells tile to cover the entire @window.

val set_visible : t -> bool -> unit

Sets the cell renderer’s visibility.

val set_sensitive : t -> bool -> unit

Sets the cell renderer’s sensitivity.

val set_padding : t -> int -> int -> unit

Sets the renderer’s padding.

val set_is_expander : t -> bool -> unit

Sets whether the given `GtkCellRenderer` is an expander.

val set_is_expanded : t -> bool -> unit

Sets whether the given `GtkCellRenderer` is expanded.

val set_fixed_size : t -> int -> int -> unit

Sets the renderer size to be explicit, independent of the properties set.

val set_alignment : t -> float -> float -> unit

Sets the renderer’s alignment within its available space.

val is_activatable : t -> bool

Checks whether the cell renderer can do something when activated.

val get_visible : t -> bool

Returns the cell renderer’s visibility.

val get_state : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj option ->
  Gtk_enums.cellrendererstate ->
  Gtk_enums.stateflags

Translates the cell renderer state to `GtkStateFlags`, based on the cell renderer and widget sensitivity, and the given `GtkCellRenderer`State.

val get_sensitive : t -> bool

Returns the cell renderer’s sensitivity.

val get_request_mode : t -> Gtk_enums.sizerequestmode

Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.

val get_preferred_width_for_height : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  int ->
  int * int

Retrieves a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height.

val get_preferred_width : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  int * int

Retrieves a renderer’s natural size when rendered to @widget.

val get_preferred_size : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  [ `requisition ] Gobject.obj * [ `requisition ] Gobject.obj

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

val get_preferred_height_for_width : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  int ->
  int * int

Retrieves a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width.

val get_preferred_height : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  int * int

Retrieves a renderer’s natural size when rendered to @widget.

val get_padding : t -> int * int

Fills in @xpad and @ypad with the appropriate values of @cell.

val get_is_expander : t -> bool

Checks whether the given `GtkCellRenderer` is an expander.

val get_is_expanded : t -> bool

Checks whether the given `GtkCellRenderer` is expanded.

val get_fixed_size : t -> int * int

Fills in @width and @height with the appropriate size of @cell.

val get_alignment : t -> float * float

Fills in @xalign and @yalign with the appropriate values of @cell.

val get_aligned_area : 
  t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  Gtk_enums.cellrendererstate ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t

Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle.

val activate : 
  t ->
  Ocgtk_gdk.Gdk.Wrappers.Event.t ->
  [ `widget | `initially_unowned | `object_ ] Gobject.obj ->
  string ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Ocgtk_gdk.Gdk.Wrappers.Rectangle.t ->
  Gtk_enums.cellrendererstate ->
  bool

Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, `GtkCellRendererToggle` toggles when it gets a mouse click.

val set_cell_background : t -> string -> unit

Set property: cell-background

val get_cell_background_rgba : t -> Ocgtk_gdk.Gdk.Wrappers.Rgb_a.t

Get property: cell-background-rgba

val set_cell_background_rgba : t -> Ocgtk_gdk.Gdk.Wrappers.Rgb_a.t -> unit

Set property: cell-background-rgba

val get_cell_background_set : t -> bool

Get property: cell-background-set

val set_cell_background_set : t -> bool -> unit

Set property: cell-background-set

val get_editing : t -> bool

Get property: editing

val get_height : t -> int

Get property: height

val set_height : t -> int -> unit

Set property: height

val get_mode : t -> Gtk_enums.cellrenderermode

Get property: mode

val set_mode : t -> Gtk_enums.cellrenderermode -> unit

Set property: mode

val get_width : t -> int

Get property: width

val set_width : t -> int -> unit

Set property: width

val get_xalign : t -> float

Get property: xalign

val set_xalign : t -> float -> unit

Set property: xalign

val get_xpad : t -> int

Get property: xpad

val set_xpad : t -> int -> unit

Set property: xpad

val get_yalign : t -> float

Get property: yalign

val set_yalign : t -> float -> unit

Set property: yalign

val get_ypad : t -> int

Get property: ypad

val set_ypad : t -> int -> unit

Set property: ypad

val on_editing_canceled : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_editing_started : 
  ?after:bool ->
  t ->
  callback:(editable:[ `cell_editable ] Gobject.obj -> path:string -> unit) ->
  Gobject.Signal.handler_id

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Cell_renderer/index.html

Module `Wrappers.Cell_renderer`

package ocgtk

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Cell_renderer/index.html

Module Wrappers.Cell_renderer

dune-project
Dependency

Module `Wrappers.Cell_renderer`