TableCellProtocol

public protocol TableCellProtocol : ObjectProtocol

Being AtkTable a component which present elements ordered via rows and columns, an AtkTableCell is the interface which each of those elements, so “cells” should implement.

See also AtkTable.

The TableCellProtocol protocol exposes the methods and properties of an underlying AtkTableCell 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 TableCell. Alternatively, use TableCellRef 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 AtkTableCell instance.

    Declaration

    Swift

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

    Typed pointer to the underlying AtkTableCell instance.

    Default Implementation

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

    Declaration

    Swift

    var table_cell_ptr: UnsafeMutablePointer<AtkTableCell>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to TableCellProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

TableCell Interface

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: TableCellPropertyName, 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 TableCell property

    Declaration

    Swift

    @inlinable
func get(property: TableCellPropertyName) -> 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 TableCell property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

TableCell Interface: TableCellProtocol extension (methods and fields)

  • getColumnHeaderCells() Extension method

    Returns the column headers as an array of cell accessibles.

    Declaration

    Swift

    @inlinable
func getColumnHeaderCells() -> GLib.PtrArrayRef!
    Show on GitHub
  • getColumnSpan() Extension method

    Returns the number of columns occupied by this cell accessible.

    Declaration

    Swift

    @inlinable
func getColumnSpan() -> Int
    Show on GitHub
  • getPosition(row:column:) Extension method

    Retrieves the tabular position of this cell.

    Declaration

    Swift

    @inlinable
func getPosition(row: UnsafeMutablePointer<gint>!, column: UnsafeMutablePointer<gint>!) -> Bool
    Show on GitHub

  • Gets the row and column indexes and span of this cell accessible.

    Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.

    Declaration

    Swift

    @inlinable
func getRowColumnSpan(row: UnsafeMutablePointer<gint>!, column: UnsafeMutablePointer<gint>!, rowSpan: UnsafeMutablePointer<gint>!, columnSpan: UnsafeMutablePointer<gint>!) -> Bool
    Show on GitHub
  • getRowHeaderCells() Extension method

    Returns the row headers as an array of cell accessibles.

    Declaration

    Swift

    @inlinable
func getRowHeaderCells() -> GLib.PtrArrayRef!
    Show on GitHub
  • getRowSpan() Extension method

    Returns the number of rows occupied by this cell accessible.

    Declaration

    Swift

    @inlinable
func getRowSpan() -> Int
    Show on GitHub
  • getTable() Extension method

    Returns a reference to the accessible of the containing table.

    Declaration

    Swift

    @inlinable
func getTable() -> Atk.ObjectRef!
    Show on GitHub
  • columnHeaderCells Extension method

    Returns the column headers as an array of cell accessibles.

    Declaration

    Swift

    @inlinable
var columnHeaderCells: GLib.PtrArrayRef! { get }
    Show on GitHub
  • columnSpan Extension method

    Returns the number of columns occupied by this cell accessible.

    Declaration

    Swift

    @inlinable
var columnSpan: Int { get }
    Show on GitHub
  • rowHeaderCells Extension method

    Returns the row headers as an array of cell accessibles.

    Declaration

    Swift

    @inlinable
var rowHeaderCells: GLib.PtrArrayRef! { get }
    Show on GitHub
  • rowSpan Extension method

    Returns the number of rows occupied by this cell accessible.

    Declaration

    Swift

    @inlinable
var rowSpan: Int { get }
    Show on GitHub
  • table Extension method

    Returns a reference to the accessible of the containing table.

    Declaration

    Swift

    @inlinable
var table: Atk.ObjectRef! { get }
    Show on GitHub