From: Duncan C. <dun...@us...> - 2005-02-25 01:12:05
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/TreeList Modified Files: CellRendererPixbuf.chs CellRendererText.chs CellRendererToggle.chs ListStore.chs.pp TreeModel.chs.pp TreeModelSort.chs.pp TreeSelection.chs.pp TreeStore.chs.pp TreeView.chs.pp TreeViewColumn.chs.pp Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: TreeStore.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeStore.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- TreeStore.chs.pp 12 Feb 2005 17:19:26 -0000 1.3 +++ TreeStore.chs.pp 25 Feb 2005 01:11:37 -0000 1.4 @@ -24,13 +24,35 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A tree-like data structure that can be used with the "TreeView" +-- A tree-like data structure that can be used with the 'TreeView' -- module Graphics.UI.Gtk.TreeList.TreeStore ( +-- * Description +-- +-- | The 'TreeStore' object is a list model for use with a 'TreeView' widget. +-- It implements the 'TreeModel' interface, and consequentialy, can use all of +-- the methods available there. It also implements the 'TreeSortable' interface +-- so it can be sorted by the view. Finally, it also implements the tree drag +-- and drop interfaces. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----TreeStore +-- @ + +-- * Types TreeStore, + TreeStoreClass, + castToTreeStore, TMType(..), GenericValue(..), + +-- * Constructors treeStoreNew, + +-- * Methods treeStoreSetValue, treeStoreRemove, treeStoreInsert, @@ -58,7 +80,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Generate a new entity to store tree information. -- @@ -68,6 +91,9 @@ (map (fromIntegral.fromEnum) cols) $ {#call unsafe tree_store_newv#} ((fromIntegral.length) cols) +-------------------- +-- Methods + -- | Set the data of a specific node. The supplied -- value must match the type that was set for the column. -- Index: TreeSelection.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeSelection.chs.pp,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- TreeSelection.chs.pp 17 Feb 2005 00:13:20 -0000 1.1 +++ TreeSelection.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 @@ -2,12 +2,12 @@ -- GIMP Toolkit (GTK) Widget TreeSelection -- -- Author : Axel Simon --- +-- -- Created: 8 May 2001 -- -- Version $Revision$ from $Date$ -- --- Copyright (c) 1999..2005 Axel Simon +-- Copyright (C) 1999-2005 Axel Simon -- -- This library is free software; you can redistribute it and/or -- modify it under the terms of the GNU Lesser General Public @@ -24,22 +24,23 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- The selection object for GtkTreeView +-- The selection object for 'TreeView' +-- module Graphics.UI.Gtk.TreeList.TreeSelection ( -- * Description -- --- | The "TreeSelection" object is a helper object to manage the selection for --- a "TreeView" widget. The "TreeSelection" object is automatically created --- when a new "TreeView" widget is created, and cannot exist independentally of --- this widget. The primary reason the "TreeSelection" objects exists is for +-- | The 'TreeSelection' object is a helper object to manage the selection for +-- a 'TreeView' widget. The 'TreeSelection' object is automatically created +-- when a new 'TreeView' widget is created, and cannot exist independentally of +-- this widget. The primary reason the 'TreeSelection' objects exists is for -- cleanliness of code and API. That is, there is no conceptual reason all --- these functions could not be methods on the "TreeView" widget instead of a +-- these functions could not be methods on the 'TreeView' widget instead of a -- separate function. -- --- The "TreeSelection" object is gotten from a "TreeView" by calling +-- The 'TreeSelection' object is gotten from a 'TreeView' by calling -- 'treeViewGetSelection'. It can be manipulated to check the selection status -- of the tree, as well as select and deselect individual rows. Selection is --- done completely on the "TreeView" side. +-- done completely on the 'TreeView' side. -- As a result, multiple views of the same model can -- have completely different selections. Additionally, you cannot change the -- selection of a row on the model that is not currently displayed by the view @@ -54,8 +55,8 @@ -- * Class Hierarchy -- | -- @ --- | "GObject" --- | +----GtkTreeSelection +-- | 'GObject' +-- | +----TreeSelection -- @ -- * Types @@ -110,7 +111,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Methods -- | Set single or multiple choice. -- @@ -330,6 +332,8 @@ nativeTreePathFree nP2 #endif +-------------------- +-- Signals -- | Emitted each time the user changes the selection. -- Index: CellRendererText.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/CellRendererText.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CellRendererText.chs 12 Feb 2005 17:19:26 -0000 1.2 +++ CellRendererText.chs 25 Feb 2005 01:11:37 -0000 1.3 @@ -32,15 +32,32 @@ -- 'treeViewAddAttribute' from 'TreeModelColumn'. -- module Graphics.UI.Gtk.TreeList.CellRendererText ( + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'CellRenderer' +-- | +----CellRendererText +-- @ + +-- * Types CellRendererText, CellRendererTextClass, castToCellRendererText, + +-- * Constructors cellRendererTextNew, + +-- * Attributes cellText, cellMarkup, cellBackground, cellForeground, cellEditable, + +-- * Signals onEdited, afterEdited ) where @@ -59,7 +76,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new CellRendererText object. -- @@ -79,6 +97,9 @@ (return . (\x -> [x]) . GVstring) (\[GVstring str] -> return str) +-------------------- +-- Properties + -- | Define the attribute that specifies the text to be -- rendered. -- Index: TreeViewColumn.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeViewColumn.chs.pp,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- TreeViewColumn.chs.pp 17 Feb 2005 00:13:20 -0000 1.1 +++ TreeViewColumn.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 @@ -2,12 +2,12 @@ -- GIMP Toolkit (GTK) TreeViewColumn TreeView -- -- Author : Axel Simon --- +-- -- Created: 9 May 2001 -- -- Version $Revision$ from $Date$ -- --- Copyright (c) 2001 Axel Simon +-- Copyright (C) 2001-2005 Axel Simon -- -- This library is free software; you can redistribute it and/or -- modify it under the terms of the GNU Lesser General Public @@ -40,11 +40,28 @@ -- values to attributes of cell renderers. -- module Graphics.UI.Gtk.TreeList.TreeViewColumn ( +-- * Description +-- +-- | The 'TreeViewColumn' object is a visible column in a 'TreeView' widget. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----TreeViewColumn +-- @ + +-- * Types TreeViewColumn, TreeViewColumnClass, castToTreeViewColumn, + +-- * Constructors treeViewColumnNew, treeViewColumnNewWithAttributes, + +-- * Methods treeViewColumnPackStart, treeViewColumnPackEnd, treeViewColumnClear, @@ -87,6 +104,8 @@ treeViewColumnSetSortOrder, treeViewColumnGetSortOrder, SortType(..), + +-- * Signals onColClicked, afterColClicked ) where @@ -107,7 +126,8 @@ -- TreeViewColumn type declaration --- methods +-------------------- +-- Constructors -- | Generate a new TreeViewColumn widget. -- @@ -128,6 +148,9 @@ treeViewColumnAddAttributes tvc cr attribs return tvc +-------------------- +-- Methods + -- | Add a cell renderer at the beginning of -- a column. -- @@ -471,6 +494,9 @@ treeViewColumnGetSortOrder tvc = liftM (toEnum.fromIntegral) $ {#call unsafe tree_view_column_get_sort_order#} (toTreeViewColumn tvc) +-------------------- +-- Signals + -- | Emitted when the header of this column has been -- clicked on. -- Index: ListStore.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/ListStore.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ListStore.chs.pp 12 Feb 2005 17:19:26 -0000 1.3 +++ ListStore.chs.pp 25 Feb 2005 01:11:37 -0000 1.4 @@ -27,10 +27,42 @@ -- The database for simple (non-hierarchical) tables. -- module Graphics.UI.Gtk.TreeList.ListStore ( +-- * Description +-- +-- | The 'ListStore' object is a list model for use with a 'TreeView' widget. +-- It implements the 'TreeModel' interface, and consequentialy, can use all of +-- the methods available there. It also implements the 'TreeSortable' interface +-- so it can be sorted by the view. Finally, it also implements the tree drag +-- and drop interfaces. + +-- ** Performance Considerations +-- +-- | Internally, the 'ListStore' is implemented with a linked list with a tail +-- pointer. As a result, it is fast at data insertion and deletion, and not as +-- fast at random data access. The 'ListStore' sets the 'TreeModelItersPersist' +-- flag, which means that 'TreeIter's can be cached while the row exists. Thus, +-- if access to a particular row is needed often, it is worth keeping the iter +-- around. +-- + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----ListStore +-- @ + +-- * Types ListStore, + ListStoreClass, + castToListStore, TMType(..), GenericValue(..), + +-- * Constructors listStoreNew, + +-- * Methods listStoreSetValue, listStoreRemove, listStoreInsert, @@ -62,7 +94,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Generate a new entity to store tree information. -- @@ -72,6 +105,9 @@ (map (fromIntegral.fromEnum) cols) $ {#call unsafe list_store_newv#} ((fromIntegral.length) cols) +-------------------- +-- Methods + -- | Set the data of a specific node. -- -- * The supplied value must match the type that was set for the column. Index: CellRendererToggle.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/CellRendererToggle.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CellRendererToggle.chs 12 Feb 2005 17:19:26 -0000 1.2 +++ CellRendererToggle.chs 25 Feb 2005 01:11:37 -0000 1.3 @@ -27,10 +27,25 @@ -- Renders a toggle button in a cell -- module Graphics.UI.Gtk.TreeList.CellRendererToggle ( + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'CellRenderer' +-- | +----CellRendererToggle +-- @ + +-- * Types CellRendererToggle, CellRendererToggleClass, castToCellRendererToggle, + +-- * Constructors cellRendererToggleNew, + +-- * Methods cellRendererToggleGetRadio, cellRendererToggleSetRadio, cellRendererToggleGetActive, @@ -50,7 +65,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new 'CellRenderer' that displays a 'ToggleButton'. -- @@ -58,6 +74,9 @@ cellRendererToggleNew = makeNewObject mkCellRendererToggle $ liftM castPtr $ {#call unsafe cell_renderer_toggle_new#} +-------------------- +-- Methods + -- | Determine whether the button is drawn as 'RadioButton' or not. -- cellRendererToggleSetRadio :: CellRendererToggleClass crt => crt -> Bool -> Index: CellRendererPixbuf.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/CellRendererPixbuf.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CellRendererPixbuf.chs 12 Feb 2005 17:19:26 -0000 1.2 +++ CellRendererPixbuf.chs 25 Feb 2005 01:11:37 -0000 1.3 @@ -27,9 +27,22 @@ -- Renders a pixbuf in a cell -- module Graphics.UI.Gtk.TreeList.CellRendererPixbuf ( + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'CellRenderer' +-- | +----CellRendererPixbuf +-- @ + +-- * Types CellRendererPixbuf, CellRendererPixbufClass, castToCellRendererPixbuf, + +-- * Constructors cellRendererPixbufNew, -- cellPixbuf ) where @@ -47,7 +60,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new CellRendererPixbuf object. -- @@ -55,6 +69,9 @@ cellRendererPixbufNew = makeNewObject mkCellRendererPixbuf $ liftM castPtr $ {#call unsafe cell_renderer_pixbuf_new#} +-------------------- +-- Properties + -- | Define the attribute that specifies the -- 'Pixbuf' to be rendered. -- Index: TreeModel.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModel.chs.pp,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- TreeModel.chs.pp 17 Feb 2005 12:55:47 -0000 1.4 +++ TreeModel.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 @@ -86,7 +86,7 @@ -- * Class Hierarchy -- | -- @ --- | "GInterface" +-- | GInterface -- | +----TreeModel -- @ @@ -171,7 +171,8 @@ instance Flags TreeModelFlags --- methods +-------------------- +-- Methods -- | Returns a set of flags supported by this interface. -- Index: TreeView.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeView.chs.pp,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- TreeView.chs.pp 17 Feb 2005 12:55:48 -0000 1.4 +++ TreeView.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 @@ -19,60 +19,59 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- --- | --- Maintainer : gtk...@li... --- Stability : provisional --- Portability : portable (depends on GHC) --- --- A widget for displaying both trees and lists. --- --- Widget that displays any object that implements the GtkTreeModel --- interface. --- --- * 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 +-- treeViewMoveColumnAfter and treeViewMoveColumnFirst are not dealt with in -- Mogul -- --- * gtk_tree_view_get_bin_window is to compare the GDK window from incoming +-- 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. +-- All functions related to drag and drop are missing. -- --- * get_search_equal_func is missing: proper memory management is impossible +-- get_search_equal_func is missing: proper memory management is impossible -- --- * gtk_tree_view_set_destroy_count_func is not meant to be useful +-- 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 +-- 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 +-- 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) +-- set_scroll_adjustment makes sense if the user monitors the scroll bars +-- and the scroll bars can be replaced anytime (the latter is odd) +-- +-- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- A widget for displaying both trees and lists. +-- +-- Widget that displays any object that implements the GtkTreeModel +-- interface. +-- +-- * 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. -- - module Graphics.UI.Gtk.TreeList.TreeView ( -- * Class Hierarchy -- | -- @ --- | "GObject" --- | +----"Object" --- | +----"Widget" --- | +----"Container" +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' -- | +----TreeView -- @ @@ -182,7 +181,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Make a new 'TreeView' widget. -- @@ -196,6 +196,9 @@ treeViewNewWithModel tm = makeNewObject mkTreeView $ liftM castPtr $ {#call tree_view_new_with_model#} (toTreeModel tm) +-------------------- +-- Methods + -- | Retrieve the TreeModel that supplies the data for -- this 'TreeView'. Returns Nothing if no model is currently set. -- @@ -827,6 +830,9 @@ readNTP :: Ptr TreePath -> IO TreePath readNTP ptr = nativeTreePathGetIndices (NativeTreePath (castPtr ptr)) +-------------------- +-- Signals + -- | The user has dragged a column to another -- position. -- Index: TreeModelSort.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModelSort.chs.pp,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- TreeModelSort.chs.pp 17 Feb 2005 00:13:20 -0000 1.1 +++ TreeModelSort.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 @@ -2,9 +2,12 @@ -- GIMP Toolkit (GTK) TreeModelSort -- -- Author : Duncan Coutts +-- -- Created: 4 August 2004 -- --- Copyright (c) 2004..2005 Duncan Coutts, Axel Simon +-- Version $Revision$ from $Date$ +-- +-- Copyright (C) 2004-2005 Duncan Coutts, Axel Simon -- -- This library is free software; you can redistribute it and/or -- modify it under the terms of the GNU Lesser General Public @@ -21,117 +24,29 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A GtkTreeModel which makes an underlying tree model sortable +-- A 'TreeModel' which makes an underlying tree model sortable -- -module Graphics.UI.Gtk.TreeList.TreeModelSort ( +module Graphics.UI.Gtk.TreeList.TreeModelSort ( -- * Description -- --- | The "TreeModelSort" is a model which implements the "TreeSortable" +-- | The 'TreeModelSort' is a model which implements the 'TreeSortable' -- interface. It does not hold any data itself, but rather is created with a -- child model and proxies its data. It has identical column types to this -- child model, and the changes in the child are propagated. The primary -- purpose of this model is to provide a way to sort a different model without -- modifying it. --- --- The use of this is best demonstrated through an example. In the following --- sample code we create two "TreeView" widgets each with a view of the same --- data. As the model is wrapped here by a "TreeModelSort", the two "TreeView"s --- can each sort their view of the data without affecting the other. By --- contrast, if we simply put the same model in each widget, then sorting the --- first would sort the second. --- --- * Using a GtkTreeModelSort --- --- * FIXME: if the follwing is a C code example, port it to Haskell or remove it --- --- > { --- > GtkTreeView *tree_view1; --- > GtkTreeView *tree_view2; --- > GtkTreeModel *sort_model1; --- > GtkTreeModel *sort_model2; --- > GtkTreeModel *child_model; --- > --- > /* get the child model */ --- > child_model = get_my_model(); --- > --- > /* Create the first tree */ --- > sort_model1 = gtk_tree_model_sort_new_with_model (child_model); --- > tree_view1 = gtk_tree_view_new_with_model (sort_model1); --- > --- > /* Create the second tree */ --- > sort_model2 = gtk_tree_model_sort_new_with_model (child_model); --- > tree_view2 = gtk_tree_view_new_with_model (sort_model2); --- > --- > /* Now we can sort the two models independently */ --- > gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1), --- > COLUMN_1, GTK_SORT_ASCENDING); --- > gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2), --- > COLUMN_1, GTK_SORT_DESCENDING); --- > } --- --- To demonstrate how to access the underlying child model from the sort --- model, the next example will be a callback for the "TreeSelection" --- \"changed\" signal. In this callback, we get a string from COLUMN_1 of the --- model. We then modify the string, find the same selected row on the child --- model, and change the row there. --- --- * Accessing the child model of in a selection changed callback --- --- * FIXME: if the follwing is a C code example, port it to Haskell or remove it --- --- > void --- > selection_changed (GtkTreeSelection *selection, gpointer data) --- > { --- > GtkTreeModel *sort_model = NULL; --- > GtkTreeModel *child_model; --- > GtkTreeIter sort_iter; --- > GtkTreeIter child_iter; --- > char *some_data = NULL; --- > char *modified_data; --- > --- > /* Get the current selected row and the model. */ --- > if (! gtk_tree_selection_get_selected (selection, --- > sort_model, --- > sort_iter)) --- > return; --- > --- > --- > /* Look up the current value on the selected row and get a new value --- > * to change it to. --- > */ --- > gtk_tree_model_get (GTK_TREE_MODEL (sort_model), sort_iter, --- > COLUMN_1, some_data, --- > -1); --- > --- > modified_data = change_the_data (some_data); --- > g_free (some_data); --- > --- > /* Get an iterator on the child model, instead of the sort model. */ --- > gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model), --- > child_iter, --- > sort_iter); --- > --- > /* Get the child model and change the value of the row. In this --- > * example, the child model is a GtkListStore. It could be any other --- > * type of model, though. --- > */ --- > child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model)); --- > gtk_list_store_set (GTK_LIST_STORE (child_model), child_iter, --- > COLUMN_1, modified_data, --- > -1); --- > g_free (modified_data); --- > } -- * Class Hierarchy -- | -- @ --- | "GObject" --- | +----GtkTreeModelSort +-- | 'GObject' +-- | +----TreeModelSort -- @ -- * Types TreeModelSort, TreeModelSortClass, + castToTreeModelSort, -- * Constructors treeModelSortNewWithModel, @@ -141,7 +56,7 @@ treeModelSortConvertChildPathToPath, treeModelSortConvertPathToChildPath, treeModelSortConvertChildIterToIter, - treeModelSortConvertIterToChildIter, + treeModelSortConvertIterToChildIter, treeModelSortResetDefaultSortFunc, treeModelSortClearCache, #if GTK_CHECK_VERSION(2,2,0) @@ -159,6 +74,8 @@ {# context lib="gtk" prefix="gtk" #} +-------------------- +-- Constructors -- | Creates a new 'TreeModelSort', that will be a sorted view of the given -- model. @@ -168,6 +85,9 @@ makeNewGObject mkTreeModelSort $ liftM castPtr $ {#call unsafe tree_model_sort_new_with_model#} (toTreeModel model) +-------------------- +-- Methods + -- | Returns the underlying model the 'TreeModelSort' is sorting. -- treeModelSortGetModel :: TreeModelSortClass obj => obj -> IO TreeModel |