This widget constitutes the main widget for displaying lists and other structured data.

• The widget supports scrolling natively. This implies that pixel coordinates can be given in two formats: relative to the current view's upper left corner or relative to the whole list's coordinates. The former are called widget coordinates while the letter are called tree coordinates.

TODO

• treeViewMoveColumnAfter and treeViewMoveColumnFirst are not dealt with in Mogul
• gtk_tree_view_get_bin_window is to compare the GDK window from incoming events. We don't marshal that window parameter, so this function is not bound either.
• All functions related to drag and drop are missing.
• get_search_equal_func is missing: proper memory management is impossible
• gtk_tree_view_set_destroy_count_func is not meant to be useful
• expand-collapse-cursor-row needs to be bound if it is useful to expand and collapse rows in a user-defined manner. Would only work on Gtk 2.2 and higher since the return parameter changed
• move_cursor, select_all, select_cursor_parent, select_cursor_row toggle_cursor_row, unselect_all are not bound. These functions are only useful to change the widgets behaviour for these actions. Everything else can be done with cursor_changed and columns_changed
• set_scroll_adjustment makes sense if the user monitors the scroll bars *and* the scroll bars can be replaced anytime (the latter is odd)

Give visual aid for wide columns.

• This function tells GTK+ that the user interface for your application requires users to read across tree columns. By default, GTK+ will then render the tree with alternating row colors. Do not use it just because you prefer the appearance of the ruled tree; that's a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors useful from a functional standpoint (since it has lots of columns, generally).

Insert new TreeViewColumn.

• Inserts new column into the TreeView tv at position pos with title ref argtitle, cell renderer cr and attributes attribs. Specify -1 for pos to insert the column at the end.

Retrieve a TreeViewColumn.

• Retrieve the pos th columns of TreeView. If the index is out of range Nothing is returned.

Move a specific column.

• Use treeViewMoveColumnToFront if you want to move the column to the left end of the TreeView.

Move a specific column.

• Use treeViewMoveColumnAfter if you want to move the column somewhere else than to the leftmost position.

Set location of hierarchy controls.

• Sets the column to draw the expander arrow at. If col is Nothing, then the expander arrow is always at the first visible column.

Get location of hierarchy controls.

• Gets the column to draw the expander arrow at. If col is Nothing, then the expander arrow is always at the first visible column.

Specify where a column may be dropped.

• Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. * The callback function take the TreeViewColumn to be moved, the second and third arguments are the columns on the left and right side of the new location. At most one of them might be Nothing which indicates that the column is about to be dropped at the left or right end of the TreeView. * The predicate pred should return True if it is ok to insert the column at this place. * Use Nothing for the predicate if columns can be inserted anywhere.

Scroll to a coordinate.

• Scrolls the tree view such that the top-left corner of the visible area is treeX, treeY, where treeX and treeY are specified in tree window coordinates. The TreeView must be realized before this function is called. If it isn't, you probably want to use treeViewScrollToCell.

Scroll to a cell.

• Scroll to a cell as specified by path and tvc. The cell is aligned within the TreeView widget as follows: horizontally by hor from left (0.0) to right (1.0) and vertically by ver from top (0.0) to buttom (1.0).

Selects a specific row.

• Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focusColumn is given, then the input focus is given to the column specified by it. Additionally, if focusColumn is specified, and startEditing is True, then editing will be started in the specified cell. This function is often followed by a widgetGrabFocus to the TreeView in order to give keyboard focus to the widget.

Selects a cell in a specific row.

• Similar to treeViewSetCursor but allows a column to containt several CellRenderers.
• Only available in Gtk 2.2 and higher.

Retrieves the position of the focus.

• Returns a pair (path, column).If the cursor is not currently set, path will be Nothing. If no column is currently selected, column will be Nothing.

Make a certain path visible.

• This will expand all parent rows of tp as necessary.
• Only available in Gtk 2.2 and higher.

Expand a row.

• Expand a node that is specified by path. If the all is True every child will be expanded recursively. Returns True if the row existed and had children.

Query if rows can be moved around.

• See treeViewSetReorderable.

Check if rows can be moved around.

• Set whether the user can use drag and drop (DND) to reorder the rows in the store. This works on both TreeStore and ListStore models. If ro is True, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's signals. This function does not give you any degree of control over the order -- any reorderering is allowed. If more control is needed, you should probably handle drag and drop manually.

Map a pixel to the specific cell.

• Finds the path at the Point (x, y). The coordinates x and y are relative to the top left corner of the TreeView drawing window. As such, coordinates in a mouse click event can be used directly to determine the cell which the user clicked on. This is therefore a way to realize for popup menus.
• The returned point is the input point relative to the cell's upper left corner. The whole TreeView is divided between all cells. The returned point is relative to the rectangle this cell occupies within the TreeView.

Retrieve the smallest bounding box of a cell.

• Fills the bounding rectangle in tree window coordinates for the cell at the row specified by tp and the column specified by tvc. If path is Nothing or points to a path not currently displayed, the y and height fields of the Rectangle will be filled with 0. The sum of all cell rectangles does not cover the entire tree; there are extra pixels in between rows, for example.

Retrieve the largest bounding box of a cell.

• Fills the bounding rectangle in tree window coordinates for the cell at the row specified by tp and the column specified by tvc. If path is Nothing or points to a path not currently displayed, the y and height fields of the Rectangle will be filled with 0. The background areas tile the widget's area to cover the entire tree window (except for the area used for header buttons). Contrast this with treeViewGetCellArea.

Retrieve the currently visible area.

• The returned rectangle gives the visible part of the tree in tree coordinates.

Convert widget to tree pixel coordinates.

• See module description.

Convert tree to widget pixel coordinates.

• See module description.

Set if user can search entries.

• If enabled, the user can type in text which will set the cursor to the first matching entry.

Set the column searched on by by the interactive search.

• Additionally, turns on interactive searching.

Set the predicate to test for equality.

• The default function assumes that the column col has contains Attribute cr String. It conducts a case insensitive comparison of the text typed by the user and the text in the tree model. This function can be used to override this behaviour. The predicate returns True if the entries should be considered to match. The parameters are the column number, the text the user typed in and a TreeIter which points to the cell to be compared.

A row was activated.

• Activation usually means the user has pressed return on a row.

The user wants to search interactively.

• Connect to this signal if you want to provide you own search facility. Note that you must handle all keyboard input yourself.

Determine if this row should be collapsed.

• If the application connects to this function and returns False, the specifc row will not be altered.

Determine if this row should be expanded.

• If the application connects to this function and returns False, the specifc row will not be altered.