Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/TreeList Modified Files: TreeStore.chs.pp CellRendererText.chs TreeModel.chs.pp TreeView.chs.pp TreeViewColumn.chs.pp TreeModelSort.chs.pp Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: TreeStore.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeStore.chs.pp,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- TreeStore.chs.pp 25 Feb 2005 01:11:37 -0000 1.4 +++ TreeStore.chs.pp 25 Feb 2005 22:53:42 -0000 1.5 @@ -25,7 +25,7 @@ -- Portability : portable (depends on GHC) -- -- A tree-like data structure that can be used with the 'TreeView' --- +-- module Graphics.UI.Gtk.TreeList.TreeStore ( -- * Description -- Index: CellRendererText.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/CellRendererText.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- CellRendererText.chs 25 Feb 2005 01:11:37 -0000 1.3 +++ CellRendererText.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -26,12 +26,13 @@ -- -- A 'CellRenderer' which displays a single-line text. -- --- * This widget derives from 'CellRenderer'. It provides the --- possibility to display some text by setting the 'Attribute' --- 'cellText' to the column of a 'TreeModel' by means of --- 'treeViewAddAttribute' from 'TreeModelColumn'. --- module Graphics.UI.Gtk.TreeList.CellRendererText ( +-- * Description +-- +-- | This widget derives from 'CellRenderer'. It provides the +-- possibility to display some text by setting the 'Attribute' +-- 'cellText' to the column of a 'TreeModel' by means of +-- 'treeViewAddAttribute' from 'TreeModelColumn'. -- * Class Hierarchy -- | Index: TreeViewColumn.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeViewColumn.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TreeViewColumn.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 +++ TreeViewColumn.chs.pp 25 Feb 2005 22:53:42 -0000 1.3 @@ -19,26 +19,30 @@ -- 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) +-- NOTES -- --- * tree_view_column_new_with_attributes and tree_view_column_set_attributes +-- tree_view_column_new_with_attributes and tree_view_column_set_attributes -- are variadic and the funcitonality can be achieved through other -- functions. -- --- * tree_view_column_set_cell_data and tree_view_column_cell_get_size are not +-- tree_view_column_set_cell_data and tree_view_column_cell_get_size are not -- bound because I am not sure what they do and when they are useful -- -- TODO -- --- * treeViewColumnSetCellData is not bound. With this function the user has +-- treeViewColumnSetCellData is not bound. With this function the user has -- control over how data in the store is mapped to the attributes of a -- cell renderer. This functin should be bound in the future to allow the -- user to insert Haskell data types into the store and convert these -- values to attributes of cell renderers. -- +-- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- A visible column in a 'TreeView' widget +-- module Graphics.UI.Gtk.TreeList.TreeViewColumn ( -- * Description -- @@ -124,8 +128,6 @@ {# context lib="gtk" prefix="gtk" #} --- TreeViewColumn type declaration - -------------------- -- Constructors Index: TreeModelSort.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModelSort.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TreeModelSort.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 +++ TreeModelSort.chs.pp 25 Feb 2005 22:53:42 -0000 1.3 @@ -75,6 +75,11 @@ {# context lib="gtk" prefix="gtk" #} -------------------- +-- Interfaces + +instance TreeModelClass TreeModelSort + +-------------------- -- Constructors -- | Creates a new 'TreeModelSort', that will be a sorted view of the given Index: TreeView.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeView.chs.pp,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- TreeView.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 +++ TreeView.chs.pp 25 Feb 2005 22:53:42 -0000 1.6 @@ -54,16 +54,17 @@ -- -- A widget for displaying both trees and lists. -- --- Widget that displays any object that implements the GtkTreeModel +module Graphics.UI.Gtk.TreeList.TreeView ( +-- * Description +-- +-- | Widget that displays any object that implements the 'TreeModel' -- 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 ( +-- 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. -- * Class Hierarchy -- | Index: TreeModel.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModel.chs.pp,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- TreeModel.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 +++ TreeModel.chs.pp 25 Feb 2005 22:53:42 -0000 1.6 @@ -24,14 +24,14 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- The tree interface used by "TreeView" +-- The tree interface used by 'TreeView' -- module Graphics.UI.Gtk.TreeList.TreeModel ( -- * Description -- --- | The "TreeModel" interface defines a generic storage object for use by the --- "TreeView" widget. It is purely abstract, concrete implementations that --- store data for a list or tree widget are e.g. "ListStore" and "TreeStore". +-- | The 'TreeModel' interface defines a generic storage object for use by the +-- 'TreeView' widget. It is purely abstract, concrete implementations that +-- store data for a list or tree widget are e.g. 'ListStore' and 'TreeStore'. -- -- The model is represented as a hierarchical tree of strongly-typed, -- columned data. In other words, the model can be seen as a tree where every @@ -43,44 +43,44 @@ -- The implementation of each individual model decides how and if changes are -- made. -- --- Two generic models are provided that implement the "TreeModel" interface: +-- Two generic models are provided that implement the 'TreeModel' interface: -- the --- "TreeStore" and the "ListStore". To use these, the developer simply pushes +-- 'TreeStore' and the 'ListStore'. To use these, the developer simply pushes -- data into these models as necessary. These models provide the data --- structure as well as the "TreeModel" interface. In fact, they implement +-- structure as well as the 'TreeModel' interface. In fact, they implement -- other interfaces making drag --- and drop, sorting, and storing data trivial. +-- and drop, sorting, and storing data trivial. -- -- Models are accessed on a node\/column level of granularity. One can query -- for the value of a model at a certain node and a certain column on that -- node. There are two structures used to reference a particular node in a --- model. They are the "TreePath" and the "TreeIter" Most of the interface --- consists of operations on a "TreeIter". +-- model. They are the 'TreePath' and the 'TreeIter' Most of the interface +-- consists of operations on a 'TreeIter'. -- -- A path is essentially a potential node. It is a location on a model that -- may or may not actually correspond to a node on a specific model. A --- "TreePath" is in fact just a list of "Int"s and hence are easy to +-- 'TreePath' is in fact just a list of 'Int's and hence are easy to -- manipulate. Each number refers to the offset at that level. Thus, the -- path @[0]@ refers to the -- root node and the path @[2,4]@ refers to the fifth child of the third node. -- --- By contrast, a "TreeIter" is a reference to a specific node on a specific +-- By contrast, a 'TreeIter' is a reference to a specific node on a specific -- model. It is an abstract data type filled in by the model. One can convert a -- path to an iterator by calling 'treeModelGetIter'. These iterators are the -- primary way of accessing a model and are similar to the iterators used by --- "TextBuffer". The model interface defines a set of operations using +-- 'TextBuffer'. The model interface defines a set of operations using -- them for navigating the model. -- -- The lifecycle of an iterator can be a little confusing at first. -- Iterators are expected to always be valid for as long as the model is -- unchanged (and doesn't emit a signal). --- Additionally, the "TreeStore" and "ListStore" models guarantee that +-- Additionally, the 'TreeStore' and 'ListStore' models guarantee that -- an iterator is valid for as long as the node it refers to is valid. -- Although generally uninteresting, as one -- always has to allow for the case where iterators do not persist beyond a -- signal, some very important performance enhancements were made in the sort --- model. As a result, the \"TreeModelItersPersist\" flag was added to --- indicate this behavior. +-- model. As a result, the 'TreeModelItersPersist' flag was added to indicate +-- this behavior. -- -- * Class Hierarchy |