|
Graphics.UI.Gtk.ModelView.TreeViewColumn | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors
|
|
|
Generate a new TreeViewColumn widget.
|
|
Methods
|
|
|
Add a cell renderer at the beginning of a column.
- Excess space is divided equally among all renderers which have
expand set to True.
|
|
|
Add a cell renderer at the end of a column.
- Excess space is divided equally among all renderers which have
expand set to True.
|
|
|
Remove the associations of attributes to a store for all CellRenderers.
|
|
|
Retrieve all CellRenderers that are contained in this column.
|
|
|
Set the number of pixels between two cell renderers.
|
|
|
Get the number of pixels between two cell renderers.
|
|
|
Set the visibility of a given column.
|
|
|
Get the visibility of a given column.
|
|
|
Set if a given column is resizable by the user.
|
|
|
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 | |
|
|
|
|
Set wether the column can be resized.
|
|
|
Return the resizing type of the column.
|
|
|
Query the current width of the column.
|
|
|
Set the width of the column.
|
|
|
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.
|
|
|
Set minimum width of the column.
|
|
|
Get the minimum width of a column. Returns -1 if this width was not set.
|
|
|
Set maximum width of the column.
|
|
|
Get the maximum width of a column. Returns -1 if this width was not set.
|
|
|
Emit the clicked signal on the column.
|
|
|
Set the widget's title if a custom widget has not been set.
|
|
|
Get the widget's title.
|
|
|
Set if the column should be sensitive to mouse clicks.
|
|
|
Returns True if the user can click on the header for the column.
|
|
|
Set the column's title to this widget.
|
|
|
|
|
treeViewColumnSetAlignment | Source |
|
:: 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.
|
|
|
|
Returns the current x alignment of the tree column. This value can range
between 0.0 and 1.0.
|
|
|
Set if the column can be reordered by the end user dragging the header.
|
|
|
Returns whether the column can be reordered by the user.
|
|
|
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.
|
|
|
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.
|
|
|
Set if a given column has sorting arrows in its heading.
|
|
|
Query if a given column has sorting arrows in its heading.
|
|
|
Set if a given column is sorted in ascending or descending order.
|
|
|
Query if a given column is sorted in ascending or descending order.
|
|
|
Constructors | SortAscending | | SortDescending | |
|
|
|
|
:: 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
|
|
|
|
:: 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 |
|
:: 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
|
|
|
|
|
|
|
Flags the column, and the cell renderers added to this column, to have
their sizes renegotiated.
- Available since Gtk+ version 2.8
|
|
Attributes
|
|
|
Whether to display the column.
Default value: True
|
|
|
Column is user-resizable.
Default value: False
|
|
|
Current width of the column.
Allowed values: >= 0
Default value: 0
|
|
|
Space which is inserted between cells.
Allowed values: >= 0
Default value: 0
|
|
|
Resize mode of the column.
Default value: TreeViewColumnGrowOnly
|
|
|
Current fixed width of the column.
Allowed values: >= 1
Default value: 1
|
|
|
Minimum allowed width of the column.
Allowed values: >= -1
Default value: -1
|
|
|
Maximum allowed width of the column.
Allowed values: >= -1
Default value: -1
|
|
|
Title to appear in column header.
Default value: ""
|
|
|
Column gets share of extra width allocated to the widget.
Default value: False
|
|
|
Whether the header can be clicked.
Default value: False
|
|
|
Widget to put in column header button instead of column title.
|
|
|
X Alignment of the column header text or widget.
Allowed values: [0,1]
Default value: 0
|
|
|
Whether the column can be reordered around the headers.
Default value: False
|
|
|
Whether to show a sort indicator.
Default value: False
|
|
|
Sort direction the sort indicator should indicate.
Default value: SortAscending
|
|
|
'sortColumnId' property. See treeViewColumnGetSortColumnId and
treeViewColumnSetSortColumnId
|
|
Signals
|
|
|
|
|
Emitted when the header of this column has been clicked on.
|
|
Produced by Haddock version 2.6.0 |