CellViewProtocol

public protocol CellViewProtocol : CellLayoutProtocol, OrientableProtocol, WidgetProtocol

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).

CSS nodes

GtkCellView has a single CSS node with name cellview.

The CellViewProtocol protocol exposes the methods and properties of an underlying GtkCellView instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see CellView. Alternatively, use CellViewRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkCellView instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • cell_view_ptr Default implementation

    Typed pointer to the underlying GtkCellView instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkCellView instance.

    Declaration

    Swift

    var cell_view_ptr: UnsafeMutablePointer<GtkCellView>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to CellViewProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

CellView Class

  • Bind a CellViewPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: CellViewPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a CellView property

    Declaration

    Swift

    @inlinable
func get(property: CellViewPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a CellView property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: CellViewPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

CellView Class: CellViewProtocol extension (methods and fields)

  • getDisplayedRow() Extension method

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

    Declaration

    Swift

    @inlinable
func getDisplayedRow() -> TreePathRef!
    Show on GitHub
  • getDrawSensitive() Extension method

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

    Declaration

    Swift

    @inlinable
func getDrawSensitive() -> Bool
    Show on GitHub
  • getFitModel() Extension method

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

    Declaration

    Swift

    @inlinable
func getFitModel() -> Bool
    Show on GitHub
  • getModel() Extension method

    Returns the model for cell_view. If no model is used nil is returned.

    Declaration

    Swift

    @inlinable
func getModel() -> TreeModelRef!
    Show on GitHub

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

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

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getSizeOfRow<RequisitionT, TreePathT>(path: TreePathT, requisition: RequisitionT) -> Bool where RequisitionT : RequisitionProtocol, TreePathT : TreePathProtocol
    Show on GitHub
  • setBackground(color:) Extension method

    Sets the background color of view.

    set_background_color is deprecated: Use gtk_cell_view_set_background_rgba() instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setBackground<ColorT>(color: ColorT) where ColorT : ColorProtocol
    Show on GitHub
  • setBackground(rgba:) Extension method

    Sets the background color of cell_view.

    Declaration

    Swift

    @inlinable
func setBackground<RGBAT>(rgba: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • setDisplayedRow(path:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func setDisplayedRow(path: TreePathRef? = nil)
    Show on GitHub
  • setDisplayedRow(path:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func setDisplayedRow<TreePathT>(path: TreePathT?) where TreePathT : TreePathProtocol
    Show on GitHub
  • set(drawSensitive:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func set(drawSensitive: Bool)
    Show on GitHub
  • set(fitModel:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func set(fitModel: Bool)
    Show on GitHub
  • set(model:) Extension method

    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 nil, then it will unset the old model.

    Declaration

    Swift

    @inlinable
func set(model: TreeModelRef? = nil)
    Show on GitHub
  • set(model:) Extension method

    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 nil, then it will unset the old model.

    Declaration

    Swift

    @inlinable
func set<TreeModelT>(model: TreeModelT?) where TreeModelT : TreeModelProtocol
    Show on GitHub
  • displayedRow Extension method

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

    Declaration

    Swift

    @inlinable
var displayedRow: TreePathRef! { get nonmutating set }
    Show on GitHub
  • drawSensitive Extension method

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

    Declaration

    Swift

    @inlinable
var drawSensitive: Bool { get nonmutating set }
    Show on GitHub
  • fitModel Extension method

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

    Declaration

    Swift

    @inlinable
var fitModel: Bool { get nonmutating set }
    Show on GitHub
  • model Extension method

    The model for cell view

    since 2.10

    Declaration

    Swift

    @inlinable
var model: TreeModelRef! { get nonmutating set }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkWidget { get }
    Show on GitHub