GI.Atk.Interfaces.Table

Table should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an Table are typically referred to as "cells". Those cells should implement the interface TableCell, but Atk doesn't require them to be direct children of the current Table. They can be grand-children, grand-grand-children etc. Table provides the API needed to get a individual cell based on the row and column numbers.

Children of Table are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient.

Since tables are often very complex, Table includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are AtkObjects which may implement other interfaces (Text, Image, etc.) as appropriate. Table summaries may themselves be (simplified) AtkTables, etc.

Note for implementors: in the past, Table required that all the cells should be direct children of Table, and provided some index based methods to request the cells. The practice showed that that forcing made Table implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated.

Exported types

newtype Table

Constructors

Table (ManagedPtr Table)

Instances

GObject Table

Methods

gobjectType :: Table -> IO GType

IsObject Table

IsTable Table

noTable :: Maybe Table

class GObject o => IsTable o

Instances

(GObject a, UnknownAncestorError Constraint Table a) => IsTable a

IsTable Table

IsTable NoOpObject

toTable :: (MonadIO m, IsTable o) => o -> m Table

Methods

addColumnSelection

tableAddColumnSelection

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> m Bool

Returns: a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface.

Adds the specified column to the selection.

addRowSelection

tableAddRowSelection

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> m Bool

Returns: a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface.

Adds the specified row to the selection.

getCaption

tableGetCaption

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableInterface

-> m (Maybe Object)

Returns: a AtkObject* representing the table caption, or Nothing if value does not implement this interface.

Gets the caption for the table.

getColumnAtIndex

tableGetColumnAtIndex

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableInterface

-> Int32

index_: a gint representing an index in table

-> m Int32

Returns: a gint representing the column at the specified index, or -1 if the table does not implement this method.

Deprecated: Since 2.12.

Gets a gint representing the column at the specified index_.

getColumnDescription

tableGetColumnDescription

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> m Text

Returns: a gchar* representing the column description, or Nothing if value does not implement this interface.

Gets the description text of the specified column in the table

getColumnExtentAt

tableGetColumnExtentAt

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Int32

column: a gint representing a column in table

-> m Int32

Returns: a gint representing the column extent at specified position, or 0 if value does not implement this interface.

Gets the number of columns occupied by the accessible object at the specified row and column in the table.

getColumnHeader

tableGetColumnHeader

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in the table

-> m (Maybe Object)

Returns: a AtkObject* representing the specified column header, or Nothing if value does not implement this interface.

Gets the column header of a specified column in an accessible table.

getIndexAt

tableGetIndexAt

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Int32

column: a gint representing a column in table

-> m Int32

Returns: a gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

Deprecated: Since 2.12. Use tableRefAt in order to get theaccessible that represents the cell at (row, column)

Gets a gint representing the index at the specified row and column.

getNColumns

tableGetNColumns

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> m Int32

Returns: a gint representing the number of columns, or 0 if value does not implement this interface.

Gets the number of columns in the table.

getNRows

tableGetNRows

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> m Int32

Returns: a gint representing the number of rows, or 0 if value does not implement this interface.

Gets the number of rows in the table.

getRowAtIndex

tableGetRowAtIndex

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableInterface

-> Int32

index_: a gint representing an index in table

-> m Int32

Returns: a gint representing the row at the specified index, or -1 if the table does not implement this method.

Deprecated: since 2.12.

Gets a gint representing the row at the specified index_.

getRowDescription

tableGetRowDescription

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> m (Maybe Text)

Returns: a gchar* representing the row description, or Nothing if value does not implement this interface.

Gets the description text of the specified row in the table

getRowExtentAt

tableGetRowExtentAt

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Int32

column: a gint representing a column in table

-> m Int32

Returns: a gint representing the row extent at specified position, or 0 if value does not implement this interface.

Gets the number of rows occupied by the accessible object at a specified row and column in the table.

getRowHeader

tableGetRowHeader

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in the table

-> m (Maybe Object)

Returns: a AtkObject* representing the specified row header, or Nothing if value does not implement this interface.

Gets the row header of a specified row in an accessible table.

getSelectedColumns

tableGetSelectedColumns

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

selected: a gint** that is to contain the selected columns numbers

-> m Int32

Returns: a gint representing the number of selected columns, or 0 if value does not implement this interface.

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

getSelectedRows

tableGetSelectedRows

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

selected: a gint** that is to contain the selected row numbers

-> m Int32

Returns: a gint representing the number of selected rows, or zero if value does not implement this interface.

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

getSummary

tableGetSummary

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> m Object

Returns: a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.

Gets the summary description of the table.

isColumnSelected

tableIsColumnSelected

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> m Bool

Returns: a gboolean representing if the column is selected, or 0 if value does not implement this interface.

Gets a boolean value indicating whether the specified column is selected

isRowSelected

tableIsRowSelected

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> m Bool

Returns: a gboolean representing if the row is selected, or 0 if value does not implement this interface.

Gets a boolean value indicating whether the specified row is selected

isSelected

tableIsSelected

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Int32

column: a gint representing a column in table

-> m Bool

Returns: a gboolean representing if the cell is selected, or 0 if value does not implement this interface.

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

refAt

tableRefAt

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Int32

column: a gint representing a column in table

-> m Object

Returns: an Object representing the referred to accessible

Get a reference to the table cell at row, column. This cell should implement the interface TableCell

removeColumnSelection

tableRemoveColumnSelection

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> m Bool

Returns: a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.

Adds the specified column to the selection.

removeRowSelection

tableRemoveRowSelection

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> m Bool

Returns: a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.

Removes the specified row from the selection.

setCaption

tableSetCaption

Arguments

:: (HasCallStack, MonadIO m, IsTable a, IsObject b)

=> a

table: a GObject instance that implements AtkTableIface

-> b

caption: a Object representing the caption to set for table

-> m ()

Sets the caption for the table.

setColumnDescription

tableSetColumnDescription

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> Text

description: a gchar representing the description text to set for the specified column of the table

-> m ()

Sets the description text for the specified column of the table.

setColumnHeader

tableSetColumnHeader

Arguments

:: (HasCallStack, MonadIO m, IsTable a, IsObject b)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

column: a gint representing a column in table

-> b

header: an Table

-> m ()

Sets the specified column header to header.

setRowDescription

tableSetRowDescription

Arguments

:: (HasCallStack, MonadIO m, IsTable a)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> Text

description: a gchar representing the description text to set for the specified row of table

-> m ()

Sets the description text for the specified row of table.

setRowHeader

tableSetRowHeader

Arguments

:: (HasCallStack, MonadIO m, IsTable a, IsObject b)

=> a

table: a GObject instance that implements AtkTableIface

-> Int32

row: a gint representing a row in table

-> b

header: an Table

-> m ()

Sets the specified row header to header.

setSummary

tableSetSummary

Arguments

:: (HasCallStack, MonadIO m, IsTable a, IsObject b)

=> a

table: a GObject instance that implements AtkTableIface

-> b

accessible: an Object representing the summary description to set for table

-> m ()

Sets the summary description of the table.

Signals

columnDeleted

type C_TableColumnDeletedCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type TableColumnDeletedCallback = Int32 -> Int32 -> IO ()

afterTableColumnDeleted :: (IsTable a, MonadIO m) => a -> TableColumnDeletedCallback -> m SignalHandlerId

genClosure_TableColumnDeleted :: TableColumnDeletedCallback -> IO Closure

mk_TableColumnDeletedCallback :: C_TableColumnDeletedCallback -> IO (FunPtr C_TableColumnDeletedCallback)

noTableColumnDeletedCallback :: Maybe TableColumnDeletedCallback

onTableColumnDeleted :: (IsTable a, MonadIO m) => a -> TableColumnDeletedCallback -> m SignalHandlerId

wrap_TableColumnDeletedCallback :: TableColumnDeletedCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

columnInserted

type C_TableColumnInsertedCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type TableColumnInsertedCallback = Int32 -> Int32 -> IO ()

afterTableColumnInserted :: (IsTable a, MonadIO m) => a -> TableColumnInsertedCallback -> m SignalHandlerId

genClosure_TableColumnInserted :: TableColumnInsertedCallback -> IO Closure

mk_TableColumnInsertedCallback :: C_TableColumnInsertedCallback -> IO (FunPtr C_TableColumnInsertedCallback)

noTableColumnInsertedCallback :: Maybe TableColumnInsertedCallback

onTableColumnInserted :: (IsTable a, MonadIO m) => a -> TableColumnInsertedCallback -> m SignalHandlerId

wrap_TableColumnInsertedCallback :: TableColumnInsertedCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

columnReordered

type C_TableColumnReorderedCallback = Ptr () -> Ptr () -> IO ()

type TableColumnReorderedCallback = IO ()

afterTableColumnReordered :: (IsTable a, MonadIO m) => a -> TableColumnReorderedCallback -> m SignalHandlerId

genClosure_TableColumnReordered :: TableColumnReorderedCallback -> IO Closure

mk_TableColumnReorderedCallback :: C_TableColumnReorderedCallback -> IO (FunPtr C_TableColumnReorderedCallback)

noTableColumnReorderedCallback :: Maybe TableColumnReorderedCallback

onTableColumnReordered :: (IsTable a, MonadIO m) => a -> TableColumnReorderedCallback -> m SignalHandlerId

wrap_TableColumnReorderedCallback :: TableColumnReorderedCallback -> Ptr () -> Ptr () -> IO ()

modelChanged

type C_TableModelChangedCallback = Ptr () -> Ptr () -> IO ()

type TableModelChangedCallback = IO ()

afterTableModelChanged :: (IsTable a, MonadIO m) => a -> TableModelChangedCallback -> m SignalHandlerId

genClosure_TableModelChanged :: TableModelChangedCallback -> IO Closure

mk_TableModelChangedCallback :: C_TableModelChangedCallback -> IO (FunPtr C_TableModelChangedCallback)

noTableModelChangedCallback :: Maybe TableModelChangedCallback

onTableModelChanged :: (IsTable a, MonadIO m) => a -> TableModelChangedCallback -> m SignalHandlerId

wrap_TableModelChangedCallback :: TableModelChangedCallback -> Ptr () -> Ptr () -> IO ()

rowDeleted

type C_TableRowDeletedCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type TableRowDeletedCallback = Int32 -> Int32 -> IO ()

afterTableRowDeleted :: (IsTable a, MonadIO m) => a -> TableRowDeletedCallback -> m SignalHandlerId

genClosure_TableRowDeleted :: TableRowDeletedCallback -> IO Closure

mk_TableRowDeletedCallback :: C_TableRowDeletedCallback -> IO (FunPtr C_TableRowDeletedCallback)

noTableRowDeletedCallback :: Maybe TableRowDeletedCallback

onTableRowDeleted :: (IsTable a, MonadIO m) => a -> TableRowDeletedCallback -> m SignalHandlerId

wrap_TableRowDeletedCallback :: TableRowDeletedCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

rowInserted

type C_TableRowInsertedCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type TableRowInsertedCallback = Int32 -> Int32 -> IO ()

afterTableRowInserted :: (IsTable a, MonadIO m) => a -> TableRowInsertedCallback -> m SignalHandlerId

genClosure_TableRowInserted :: TableRowInsertedCallback -> IO Closure

mk_TableRowInsertedCallback :: C_TableRowInsertedCallback -> IO (FunPtr C_TableRowInsertedCallback)

noTableRowInsertedCallback :: Maybe TableRowInsertedCallback

onTableRowInserted :: (IsTable a, MonadIO m) => a -> TableRowInsertedCallback -> m SignalHandlerId

wrap_TableRowInsertedCallback :: TableRowInsertedCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

rowReordered

type C_TableRowReorderedCallback = Ptr () -> Ptr () -> IO ()

type TableRowReorderedCallback = IO ()

afterTableRowReordered :: (IsTable a, MonadIO m) => a -> TableRowReorderedCallback -> m SignalHandlerId

genClosure_TableRowReordered :: TableRowReorderedCallback -> IO Closure

mk_TableRowReorderedCallback :: C_TableRowReorderedCallback -> IO (FunPtr C_TableRowReorderedCallback)

noTableRowReorderedCallback :: Maybe TableRowReorderedCallback

onTableRowReordered :: (IsTable a, MonadIO m) => a -> TableRowReorderedCallback -> m SignalHandlerId

wrap_TableRowReorderedCallback :: TableRowReorderedCallback -> Ptr () -> Ptr () -> IO ()