gtk-0.12.2: Binding to the Gtk+ graphical user interface library.

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Graphics.UI.Gtk.ModelView.TreeViewColumn

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Attributes
- Signals

Description

A visible column in a `TreeView` widget

Synopsis

- data TreeViewColumn
- class ObjectClass o => TreeViewColumnClass o
- castToTreeViewColumn :: GObjectClass obj => obj -> TreeViewColumn
- gTypeTreeViewColumn :: GType
- toTreeViewColumn :: TreeViewColumnClass o => o -> TreeViewColumn
- treeViewColumnNew :: IO TreeViewColumn
- treeViewColumnPackStart :: CellRendererClass cell => TreeViewColumn -> cell -> Bool -> IO ()
- treeViewColumnPackEnd :: CellRendererClass cell => TreeViewColumn -> cell -> Bool -> IO ()
- treeViewColumnClear :: TreeViewColumn -> IO ()
- treeViewColumnGetCellRenderers :: TreeViewColumn -> IO [CellRenderer]
- treeViewColumnSetSpacing :: TreeViewColumn -> Int -> IO ()
- treeViewColumnGetSpacing :: TreeViewColumn -> IO Int
- treeViewColumnSetVisible :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetVisible :: TreeViewColumn -> IO Bool
- treeViewColumnSetResizable :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetResizable :: TreeViewColumn -> IO Bool
- data TreeViewColumnSizing
  - = TreeViewColumnGrowOnly
  - | TreeViewColumnAutosize
  - | TreeViewColumnFixed
- treeViewColumnSetSizing :: TreeViewColumn -> TreeViewColumnSizing -> IO ()
- treeViewColumnGetSizing :: TreeViewColumn -> IO TreeViewColumnSizing
- treeViewColumnGetWidth :: TreeViewColumn -> IO Int
- treeViewColumnSetFixedWidth :: TreeViewColumn -> Int -> IO ()
- treeViewColumnGetFixedWidth :: TreeViewColumn -> IO Int
- treeViewColumnSetMinWidth :: TreeViewColumn -> Int -> IO ()
- treeViewColumnGetMinWidth :: TreeViewColumn -> IO Int
- treeViewColumnSetMaxWidth :: TreeViewColumn -> Int -> IO ()
- treeViewColumnGetMaxWidth :: TreeViewColumn -> IO Int
- treeViewColumnClicked :: TreeViewColumn -> IO ()
- treeViewColumnSetTitle :: TreeViewColumn -> String -> IO ()
- treeViewColumnGetTitle :: TreeViewColumn -> IO (Maybe String)
- treeViewColumnSetClickable :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetClickable :: TreeViewColumn -> IO Bool
- treeViewColumnSetWidget :: WidgetClass widget => TreeViewColumn -> Maybe widget -> IO ()
- treeViewColumnGetWidget :: TreeViewColumn -> IO (Maybe Widget)
- treeViewColumnSetAlignment :: TreeViewColumn -> Float -> IO ()
- treeViewColumnGetAlignment :: TreeViewColumn -> IO Float
- treeViewColumnSetReorderable :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetReorderable :: TreeViewColumn -> IO Bool
- treeViewColumnSetSortColumnId :: TreeViewColumn -> SortColumnId -> IO ()
- treeViewColumnGetSortColumnId :: TreeViewColumn -> IO SortColumnId
- treeViewColumnSetSortIndicator :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetSortIndicator :: TreeViewColumn -> IO Bool
- treeViewColumnSetSortOrder :: TreeViewColumn -> SortType -> IO ()
- treeViewColumnGetSortOrder :: TreeViewColumn -> IO SortType
- data SortType
  - = SortAscending
  - | SortDescending
- treeViewColumnSetExpand :: TreeViewColumn -> Bool -> IO ()
- treeViewColumnGetExpand :: TreeViewColumn -> IO Bool
- treeViewColumnCellIsVisible :: TreeViewColumn -> IO Bool
- treeViewColumnFocusCell :: CellRendererClass cell => TreeViewColumn -> cell -> IO ()
- treeViewColumnQueueResize :: TreeViewColumn -> IO ()
- treeViewColumnVisible :: Attr TreeViewColumn Bool
- treeViewColumnResizable :: Attr TreeViewColumn Bool
- treeViewColumnWidth :: ReadAttr TreeViewColumn Int
- treeViewColumnSpacing :: Attr TreeViewColumn Int
- treeViewColumnSizing :: Attr TreeViewColumn TreeViewColumnSizing
- treeViewColumnFixedWidth :: Attr TreeViewColumn Int
- treeViewColumnMinWidth :: Attr TreeViewColumn Int
- treeViewColumnMaxWidth :: Attr TreeViewColumn Int
- treeViewColumnTitle :: ReadWriteAttr TreeViewColumn (Maybe String) String
- treeViewColumnExpand :: Attr TreeViewColumn Bool
- treeViewColumnClickable :: Attr TreeViewColumn Bool
- treeViewColumnWidget :: WidgetClass widget => ReadWriteAttr TreeViewColumn (Maybe Widget) (Maybe widget)
- treeViewColumnAlignment :: Attr TreeViewColumn Float
- treeViewColumnReorderable :: Attr TreeViewColumn Bool
- treeViewColumnSortIndicator :: Attr TreeViewColumn Bool
- treeViewColumnSortOrder :: Attr TreeViewColumn SortType
- treeViewColumnSortColumnId :: Attr TreeViewColumn SortColumnId
- onColClicked :: TreeViewColumnClass self => self -> IO () -> IO (ConnectId self)
- afterColClicked :: TreeViewColumnClass self => self -> IO () -> IO (ConnectId self)

# Detail

The `TreeViewColumn` object represents a visible column in a `TreeView` widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.

# Class Hierarchy

     | GObject
     | +----Object
     | +----TreeViewColumn

# Types

data TreeViewColumn

Instances

Eq TreeViewColumn |
Ord TreeViewColumn |
GObjectClass TreeViewColumn |
CellLayoutClass TreeViewColumn |
TreeViewColumnClass TreeViewColumn |
ObjectClass TreeViewColumn |

class ObjectClass o => TreeViewColumnClass o

Instances

TreeViewColumnClass TreeViewColumn |

castToTreeViewColumn :: GObjectClass obj => obj -> TreeViewColumn

gTypeTreeViewColumn :: GType

toTreeViewColumn :: TreeViewColumnClass o => o -> TreeViewColumn

# Constructors

treeViewColumnNew :: IO TreeViewColumn

Generate a new TreeViewColumn widget.

# Methods

treeViewColumnPackStart :: CellRendererClass cell => TreeViewColumn -> cell -> Bool -> IO ()

Add a cell renderer at the beginning of a column.

- Excess space is divided equally among all renderers which have `expand` set to True.

treeViewColumnPackEnd :: CellRendererClass cell => TreeViewColumn -> cell -> Bool -> IO ()

Add a cell renderer at the end of a column.

- Excess space is divided equally among all renderers which have `expand` set to True.

treeViewColumnClear :: TreeViewColumn -> IO ()

Remove the associations of attributes to a store for all `CellRenderer`s.

treeViewColumnGetCellRenderers :: TreeViewColumn -> IO [CellRenderer]

Retrieve all `CellRenderer`s that are contained in this column.

treeViewColumnSetSpacing :: TreeViewColumn -> Int -> IO ()

Set the number of pixels between two cell renderers.

treeViewColumnGetSpacing :: TreeViewColumn -> IO Int

Get the number of pixels between two cell renderers.

treeViewColumnSetVisible :: TreeViewColumn -> Bool -> IO ()

Set the visibility of a given column.

treeViewColumnGetVisible :: TreeViewColumn -> IO Bool

Get the visibility of a given column.

treeViewColumnSetResizable :: TreeViewColumn -> Bool -> IO ()

Set if a given column is resizable by the user.

treeViewColumnGetResizable :: TreeViewColumn -> IO Bool

Get if a given column is resizable by the user.

data TreeViewColumnSizing

Wether columns of a tree or list widget can be resized.

Constructors

TreeViewColumnGrowOnly |
TreeViewColumnAutosize |
TreeViewColumnFixed |

Instances

Enum TreeViewColumnSizing |
Eq TreeViewColumnSizing |
Show TreeViewColumnSizing |

treeViewColumnSetSizing :: TreeViewColumn -> TreeViewColumnSizing -> IO ()

Set wether the column can be resized.

treeViewColumnGetSizing :: TreeViewColumn -> IO TreeViewColumnSizing

Return the resizing type of the column.

treeViewColumnGetWidth :: TreeViewColumn -> IO Int

Query the current width of the column.

treeViewColumnSetFixedWidth :: TreeViewColumn -> Int -> IO ()

Set the width of the column.

- This is meaningful only if the sizing type is `TreeViewColumnFixed`.

treeViewColumnGetFixedWidth :: TreeViewColumn -> IO Int

Gets the fixed width of the column.

- This is meaningful only if the sizing type is `TreeViewColumnFixed`.
- This value is only meaning may not be the actual width of the column on the screen, just what is requested.

treeViewColumnSetMinWidth :: TreeViewColumn -> Int -> IO ()

Set minimum width of the column.

treeViewColumnGetMinWidth :: TreeViewColumn -> IO Int

Get the minimum width of a column. Returns -1 if this width was not set.

treeViewColumnSetMaxWidth :: TreeViewColumn -> Int -> IO ()

Set maximum width of the column.

treeViewColumnGetMaxWidth :: TreeViewColumn -> IO Int

Get the maximum width of a column. Returns -1 if this width was not set.

treeViewColumnClicked :: TreeViewColumn -> IO ()

Emit the `clicked` signal on the column.

treeViewColumnSetTitle :: TreeViewColumn -> String -> IO ()

Set the widget's title if a custom widget has not been set.

treeViewColumnGetTitle :: TreeViewColumn -> IO (Maybe String)

Get the widget's title.

treeViewColumnSetClickable :: TreeViewColumn -> Bool -> IO ()

Set if the column should be sensitive to mouse clicks.

treeViewColumnGetClickable :: TreeViewColumn -> IO Bool

Returns True if the user can click on the header for the column.

treeViewColumnSetWidget :: WidgetClass widget => TreeViewColumn -> Maybe widget -> IO ()

Set the column's title to this widget.

treeViewColumnGetWidget

Arguments

:: TreeViewColumn |
-> IO (Maybe Widget) | returns the `Widget` in the column header, or `Nothing`

Retrieve the widget responsible for showing the column title. In case only a text title was set this will be a `Alignment` widget with a `Label` inside.

treeViewColumnSetAlignment

Arguments

:: TreeViewColumn |
-> Float | `xalign` - The alignment, which is between [0.0 and 1.0] inclusive.
-> IO () |

Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right.

treeViewColumnGetAlignment :: TreeViewColumn -> IO Float

Returns the current x alignment of the tree column. This value can range between 0.0 and 1.0.

treeViewColumnSetReorderable :: TreeViewColumn -> Bool -> IO ()

Set if the column can be reordered by the end user dragging the header.

treeViewColumnGetReorderable :: TreeViewColumn -> IO Bool

Returns whether the column can be reordered by the user.

treeViewColumnSetSortColumnId :: TreeViewColumn -> SortColumnId -> IO ()

Set the column by which to sort.

- Sets the logical `columnId` that this column sorts on when this column is selected for sorting. The selected column's header will be clickable after this call. Logical refers to the `Graphics.UI.Gtk.ModelView.TreeSortable.SortColumnId` for which a comparison function was set.

treeViewColumnGetSortColumnId :: TreeViewColumn -> IO SortColumnId

Get the column by which to sort.

- Retrieves the logical `columnId` that the model sorts on when this column is selected for sorting.
- Returns `Graphics.UI.Gtk.ModelView.TreeSortable.treeSortableDefaultSortColumnId` if this tree view column has no `Graphics.UI.Gtk.ModelView.TreeSortable.SortColumnId` associated with it.

treeViewColumnSetSortIndicator :: TreeViewColumn -> Bool -> IO ()

Set if a given column has sorting arrows in its heading.

treeViewColumnGetSortIndicator :: TreeViewColumn -> IO Bool

Query if a given column has sorting arrows in its heading.

treeViewColumnSetSortOrder :: TreeViewColumn -> SortType -> IO ()

Set if a given column is sorted in ascending or descending order.

- In order for sorting to work, it is necessary to either use automatic sorting via `treeViewColumnSetSortColumnId` or to use a user defined sorting on the elements in a `TreeModel`.

treeViewColumnGetSortOrder :: TreeViewColumn -> IO SortType

Query if a given column is sorted in ascending or descending order.

data SortType

Constructors

SortAscending |
SortDescending |

Instances

Enum SortType |
Eq SortType |
Show SortType |

treeViewColumnSetExpand

Arguments

:: TreeViewColumn |
-> Bool | `expand` - `True` if the column should take available extra space, `False` if not
-> IO () |

Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to `True`. If no column has this option set, then the last column gets all extra space. By default, every column is created with this `False`.

- Available since Gtk+ version 2.4

treeViewColumnGetExpand

Arguments

:: TreeViewColumn |
-> IO Bool | returns `True`, if the column expands

Return `True` if the column expands to take any available space.

- Available since Gtk+ version 2.4

treeViewColumnCellIsVisible

Arguments

:: TreeViewColumn |
-> IO Bool | returns `True`, if any of the cells packed into the `treeColumn` are currently visible

Returns `True` if any of the cells packed into the `treeColumn` are visible. For this to be meaningful, you must first initialize the cells with `treeViewColumnCellSetCellData`

treeViewColumnFocusCell

Arguments

:: CellRendererClass cell |
=> TreeViewColumn |
-> cell | `cell` - A `CellRenderer`
-> IO () |

Sets the current keyboard focus to be at `cell`, if the column contains 2 or more editable and activatable cells.

- Available since Gtk+ version 2.2

treeViewColumnQueueResize :: TreeViewColumn -> IO ()

Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

- Available since Gtk+ version 2.8

# Attributes

treeViewColumnVisible :: Attr TreeViewColumn Bool

Whether to display the column.

Default value: `True`

treeViewColumnResizable :: Attr TreeViewColumn Bool

Column is user-resizable.

Default value: `False`

treeViewColumnWidth :: ReadAttr TreeViewColumn Int

Current width of the column.

Allowed values: >= 0

Default value: 0

treeViewColumnSpacing :: Attr TreeViewColumn Int

Space which is inserted between cells.

Allowed values: >= 0

Default value: 0

treeViewColumnSizing :: Attr TreeViewColumn TreeViewColumnSizing

Resize mode of the column.

Default value: `TreeViewColumnGrowOnly`

treeViewColumnFixedWidth :: Attr TreeViewColumn Int

Current fixed width of the column.

Allowed values: >= 1

Default value: 1

treeViewColumnMinWidth :: Attr TreeViewColumn Int

Minimum allowed width of the column.

Allowed values: >= -1

Default value: -1

treeViewColumnMaxWidth :: Attr TreeViewColumn Int

Maximum allowed width of the column.

Allowed values: >= -1

Default value: -1

treeViewColumnTitle :: ReadWriteAttr TreeViewColumn (Maybe String) String

Title to appear in column header.

Default value: ""

treeViewColumnExpand :: Attr TreeViewColumn Bool

Column gets share of extra width allocated to the widget.

Default value: `False`

treeViewColumnClickable :: Attr TreeViewColumn Bool

Whether the header can be clicked.

Default value: `False`

treeViewColumnWidget :: WidgetClass widget => ReadWriteAttr TreeViewColumn (Maybe Widget) (Maybe widget)

Widget to put in column header button instead of column title.

treeViewColumnAlignment :: Attr TreeViewColumn Float

X Alignment of the column header text or widget.

Allowed values: [0,1]

Default value: 0

treeViewColumnReorderable :: Attr TreeViewColumn Bool

Whether the column can be reordered around the headers.

Default value: `False`

treeViewColumnSortIndicator :: Attr TreeViewColumn Bool

Whether to show a sort indicator.

Default value: `False`

treeViewColumnSortOrder :: Attr TreeViewColumn SortType

Sort direction the sort indicator should indicate.

Default value: `SortAscending`

treeViewColumnSortColumnId :: Attr TreeViewColumn SortColumnId

'sortColumnId' property. See `treeViewColumnGetSortColumnId` and `treeViewColumnSetSortColumnId`

# Signals

onColClicked :: TreeViewColumnClass self => self -> IO () -> IO (ConnectId self)

afterColClicked :: TreeViewColumnClass self => self -> IO () -> IO (ConnectId self)

Emitted when the header of this column has been clicked on.