From 19c85a596d1ef4c6e1c1670ba330415e3a6367a6 Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Sun, 13 Apr 2003 12:55:01 +0000 Subject: [PATCH] First raw draft of TreeSelection docs. svn path=/trunk/gtk-sharp/; revision=13574 --- doc/ChangeLog | 4 ++ doc/en/Gtk/TreeSelection.xml | 121 ++++++++++++++++++----------------- 2 files changed, 66 insertions(+), 59 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index c492c1176..6ffb43ae9 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-04-13 Lee Mallabone + + * en/Gtk/TreeSelection.xml: First draft. + 2003-04-11 Hector E. Gomez Morales * en/Gtk/GammeCurve.xml diff --git a/doc/en/Gtk/TreeSelection.xml b/doc/en/Gtk/TreeSelection.xml index 08c68bd5e..c804a50c1 100644 --- a/doc/en/Gtk/TreeSelection.xml +++ b/doc/en/Gtk/TreeSelection.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The selection object for . + TreeSelection provides a single class for managing selection information on the List/Tree widget. + A TreeSelection object is automatically created when a new widget is created and is inherently tied to it. A TreeSelection cannot exist independently of a . Selection information is retrieved from the with the property. + TreeSelection can check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely on the view. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row that is not currently displayed by the view without expanding its parents first. + One of the important things to remember when monitoring the selection of a view is that the event is mostly a hint. For example, it may only fire once when a range of rows is selected. It may also fire when nothing has happened, such as when is called on a row that is already selected. GLib.Object @@ -34,11 +37,11 @@ - To be added - To be added: an object of type 'Gtk.TreeModel&' - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'bool' - To be added + Get information about the currently selected node. + A convenient accessor to the that this TreeSelection's is associated with. + The position that was selected. + if a row was selected + This method will not work if the TreeSelection has been set to . In that case you should use . @@ -51,9 +54,9 @@ - To be added - To be added: an object of type 'Gtk.TreePath' - To be added + Selects the specified row that represents. + A row to be selected. + @@ -66,10 +69,10 @@ - To be added - To be added: an object of type 'Gtk.TreePath' - To be added: an object of type 'bool' - To be added + Determines whether a TreePath has been selected in this TreeView. + The path to a node whose selected status should be checked. + if is selected, otherwise. + @@ -82,9 +85,9 @@ - To be added - To be added: an object of type 'Gtk.TreeIter' - To be added + Deselects the specified position in the tree. + The tree position that should be deselected. + See also, and . @@ -97,10 +100,10 @@ - To be added - To be added: an object of type 'Gtk.TreeIter' - To be added: an object of type 'bool' - To be added + Determine if the iter is selected. + The tree location to check + if the tree node specified by is selected, otherwise. + See also . @@ -111,8 +114,8 @@ - To be added - To be added + Selects every node in this . + The must be set to for this method to work. @@ -125,9 +128,9 @@ - To be added - To be added: an object of type 'Gtk.TreePath' - To be added + Deselects the tree node that refers to. + A node in the tree. + See also . @@ -141,10 +144,10 @@ - To be added - To be added: an object of type 'Gtk.TreePath' - To be added: an object of type 'Gtk.TreePath' - To be added + Selects all the nodes that appear between and . + The first node to select on the tree. + The last node to select on the tree. + @@ -155,8 +158,8 @@ - To be added - To be added + Sets all nodes in the as unselected. + @@ -169,9 +172,9 @@ - To be added - To be added: an object of type 'Gtk.TreeSelectionForeachFunc' - To be added + Invokes the delegate passed in by for each selected row in the . + The delegate that should be called for each selected row. + This method is useful when the of this TreeSelection is set to . It is currently the only way to access selection information for multiple rows. See the class overview for an example on how to effectively use this method for selection tracking. @@ -186,11 +189,11 @@ - To be added - To be added: an object of type 'Gtk.TreeSelectionFunc' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.DestroyNotify' - To be added + Add a hook into selection and unselection. + A delegate to invoke before a node is (un)selected. + Raw data to pass to when it is called. + A delegate to be notified when should be destroyed. Can be . + If set, is called before any node is selected or unselected, giving some control over which nodes are selected. The select function should return if the state of the node may be toggled, and if the state of the node should be left unchanged. @@ -203,9 +206,9 @@ - To be added - To be added: an object of type 'Gtk.TreeIter' - To be added + Selects the specified . + Indicates which row to select. + See also and . @@ -242,9 +245,9 @@ - To be added - To be added: an object of type 'Gtk.TreeSelection' - To be added + Internal constructor. + + @@ -269,10 +272,10 @@ - To be added - To be added: an object of type 'Gtk.SelectionMode' - To be added: an object of type 'Gtk.SelectionMode' - To be added + Manages the way rows can be selected. + A new mode of selection. + The current mode dictating selection behaviour. + Rows may be deselected by changing this property. For example, if rows are selected and the mode is changed to or . @@ -282,9 +285,9 @@ System.IntPtr - To be added - To be added: an object of type 'IntPtr' - To be added + Get the data associated with the that has been setup for this TreeSelection. + The raw data that was set when was called. + @@ -294,9 +297,9 @@ Gtk.TreeView - To be added - To be added: an object of type 'Gtk.TreeView' - To be added + Get the that this TreeSelection is associated with. + The that this TreeSelection is tied to. + A TreeSelection object can only be retrieved from a . That is done with its property. @@ -305,8 +308,8 @@ - To be added - To be added + Fired when the selection (may have) changed. + This event is mostly a hint. It may only be fired once when a range of rows are selected, and it may occasionally be fired when nothing has happened.