Portability	portable (depends on GHC)
Stability	provisional
Maintainer	[email protected]

Graphics.UI.Gtk.ModelView.TreeViewColumn

Contents

Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals

Description

A visible column in a TreeView widget

Synopsis

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 Source

Instances

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

class ObjectClass o => TreeViewColumnClass o Source

Instances

TreeViewColumnClass TreeViewColumn

castToTreeViewColumn :: GObjectClass obj => obj -> TreeViewColumn Source

gTypeTreeViewColumn :: GType Source

toTreeViewColumn :: TreeViewColumnClass o => o -> TreeViewColumn Source

Constructors

treeViewColumnNew :: IO TreeViewColumn Source

Generate a new TreeViewColumn widget.

Methods

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

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 ()Source

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 ()Source

Remove the associations of attributes to a store for all CellRenderers.

treeViewColumnGetCellRenderers :: TreeViewColumn -> IO [CellRenderer]Source

Retrieve all CellRenderers that are contained in this column.

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

Set the number of pixels between two cell renderers.

treeViewColumnGetSpacing :: TreeViewColumn -> IO Int Source

Get the number of pixels between two cell renderers.

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

Set the visibility of a given column.

treeViewColumnGetVisible :: TreeViewColumn -> IO Bool Source

Get the visibility of a given column.

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

Set if a given column is resizable by the user.

treeViewColumnGetResizable :: TreeViewColumn -> IO Bool Source

Get if a given column is resizable by the user.

data TreeViewColumnSizing Source

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 ()Source

Set wether the column can be resized.

treeViewColumnGetSizing :: TreeViewColumn -> IO TreeViewColumnSizing Source

Return the resizing type of the column.

treeViewColumnGetWidth :: TreeViewColumn -> IO Int Source

Query the current width of the column.

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

Set the width of the column.

This is meaningful only if the sizing type is TreeViewColumnFixed.

treeViewColumnGetFixedWidth :: TreeViewColumn -> IO Int Source

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 ()Source

Set minimum width of the column.

treeViewColumnGetMinWidth :: TreeViewColumn -> IO Int Source

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

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

Set maximum width of the column.

treeViewColumnGetMaxWidth :: TreeViewColumn -> IO Int Source

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

treeViewColumnClicked :: TreeViewColumn -> IO ()Source

Emit the clicked signal on the column.

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

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

treeViewColumnGetTitle :: TreeViewColumn -> IO (Maybe String)Source

Get the widget's title.

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

Set if the column should be sensitive to mouse clicks.

treeViewColumnGetClickable :: TreeViewColumn -> IO Bool Source

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

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

Set the column's title to this widget.

treeViewColumnGetWidget Source

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 Source

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 Source

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

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

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

treeViewColumnGetReorderable :: TreeViewColumn -> IO Bool Source

Returns whether the column can be reordered by the user.

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

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 Source

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 ()Source

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

treeViewColumnGetSortIndicator :: TreeViewColumn -> IO Bool Source

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

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

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 Source

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

data SortType Source

Constructors

SortAscending
SortDescending

Instances

Enum SortType
Eq SortType
Show SortType

treeViewColumnSetExpand Source

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 Source

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 Source

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 Source

Arguments