diff --git a/doc/ChangeLog b/doc/ChangeLog index 2fcd36bcb..1a6089009 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,14 @@ +2004-11-30 Shane Landrum + + * en/Gtk/ColorSelection.xml: Documented deprecated UpdatePolicy prop. + * en/Gtk/ColorButton.xml: Added docs. + * en/Gtk/TreeModel.xml + * en/Gtk/TreeModelFilter.xml + * en/Gtk/TreeModelFilterModifyFunc.xml + * en/Gtk/TreeModelFilterVisibleFunc.xml + * en/Gtk/TreeModelSort.xml: Added and elaborated docs + for filtering tree models, in compliance with GTK 2.4. + 2004-11-26 Jeroen Zwartepoorte * doc/en/Gtk/ActionEntry.xml: diff --git a/doc/en/Gtk/ColorButton.xml b/doc/en/Gtk/ColorButton.xml index 35a723139..5e145102c 100644 --- a/doc/en/Gtk/ColorButton.xml +++ b/doc/en/Gtk/ColorButton.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A button which displays the currently selected color and allows opening of a color selection dialog to change the color. + This widget is suitable for selecting a color in a preference dialog. Gtk.Button @@ -36,8 +36,8 @@ - To be added - To be added + Protected method called for cleanup. + @@ -48,8 +48,8 @@ - To be added - To be added + Protected method called when the color of the widget is set. + @@ -60,10 +60,10 @@ - To be added + Protected constructor. a a - To be added + @@ -74,10 +74,10 @@ - To be added - a + Constructor; for internal use only. + a , pointer to underlying C object. a - To be added + @@ -86,9 +86,9 @@ - To be added + Constructor for public use. a - To be added + @@ -99,10 +99,10 @@ - To be added - a + Constructor for public use. + a , the color to make the button. a - To be added + @@ -113,9 +113,9 @@ - To be added + Do not use. a - To be added + @@ -126,9 +126,9 @@ - To be added + Whether or not to make this button transparent. a - To be added + @@ -139,9 +139,9 @@ - To be added + The color this widget is set to. a - To be added + @@ -152,9 +152,9 @@ - To be added + The title for this button. a - To be added + @@ -165,9 +165,9 @@ - To be added + How transparent to make this button, if transparency is being used. a - To be added + @@ -178,9 +178,9 @@ - To be added - To be added + Event that happens when the color of this ColorButton is set. + - \ No newline at end of file + diff --git a/doc/en/Gtk/ColorSelection.xml b/doc/en/Gtk/ColorSelection.xml index aa9eb138f..20a38c277 100644 --- a/doc/en/Gtk/ColorSelection.xml +++ b/doc/en/Gtk/ColorSelection.xml @@ -275,9 +275,9 @@ Gtk.UpdateType - To be added + Deprecated. Do not use. a - To be added + Before it was deprecated, this property set the policy controlling when ColorChanged signals are emitted. diff --git a/doc/en/Gtk/TreeModel.xml b/doc/en/Gtk/TreeModel.xml index b88b53fed..edfe24f17 100644 --- a/doc/en/Gtk/TreeModel.xml +++ b/doc/en/Gtk/TreeModel.xml @@ -69,9 +69,9 @@ - Sets the TreeIter object pointed to by the iter param to point to the first child of this tree. + Sets the TreeIter object pointed to by to point to the first child of this tree. an object of type - an object of type + an object of type , true if the iter has been set to the first child. @@ -168,7 +168,7 @@ - Returns if iter has children, otherwise. + Returns if has children, otherwise. an object of type an object of type @@ -474,7 +474,7 @@ an object of type an object of type If is at the toplevel, and does not have a parent, then is set to an invalid iterator and is returned. will remain a valid node after this function has been called. - +] @@ -712,4 +712,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeModelFilter.xml b/doc/en/Gtk/TreeModelFilter.xml index 9c8e87b1b..501104215 100644 --- a/doc/en/Gtk/TreeModelFilter.xml +++ b/doc/en/Gtk/TreeModelFilter.xml @@ -9,8 +9,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object designed to filter the contents of a column or columns +in a for display. + GLib.Object @@ -39,8 +40,8 @@ - To be added - To be added + Protected method called before object destruction. + @@ -53,10 +54,10 @@ - To be added + Sets the filter's iterator to point to the row that corresponds to . a a - To be added + @@ -67,8 +68,8 @@ - To be added - To be added + Emits for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. + Added in GTK 2.4. @@ -81,10 +82,15 @@ - To be added + Converts to a path relative to this filter. + a - a - To be added + a or . + + points to a path in the child model. The returned path will point to the + same row in the filtered model. If isn't a valid path on the + child model, then is returned. + @@ -99,11 +105,16 @@ - To be added + + Sets the visible function used when filtering to be . + a a a - To be added + + The function should return TRUE if the given row should be visible and + FALSE otherwise. + @@ -116,10 +127,11 @@ - To be added + Returns a new iterator that points to the row pointed to + by . a a - To be added + @@ -130,8 +142,14 @@ - To be added - To be added + This function should almost never be called. + This function clears the filter of any cached iterators that haven't been reffed with + . This might be useful if the child model + being filtered is static (and doesn't change often) and there has been + a lot of unreffed access to nodes. As a side effect of this function, + all unreffed iterators will be invalid. + Added in GTK 2.4. + @@ -148,13 +166,21 @@ - To be added + Sets a function to modify the display of the model. a a a a a - To be added + + With the and parameters, you give an array of column + types for this model (which will be exposed to the parent model/view). + The , and parameters are for specifying the modify + function. The modify function will get called for each + data access; the goal of the modify function is to return the data which + should be displayed at the location specified using the parameters of the + modify function. + @@ -167,10 +193,15 @@ - To be added + Converts to a path on the child model of this filter. a a - To be added + points to a location in this + filter. The returned path will point to the same location in the + model not being filtered. If + does not point to a location in the child model, + is returned. + @@ -183,9 +214,9 @@ - To be added + Decrements the reference count for the node at . a - To be added + @@ -198,10 +229,10 @@ - To be added + Gets the data type stored in the column at . a a - To be added + @@ -215,10 +246,10 @@ - To be added + Gets the values of child properties for the row pointed to by a - a - To be added + a , pointer to the va_list data structure of arguments (FIXME: clarify what va_lists look like) + @@ -231,10 +262,10 @@ - To be added + Gets the next row to be filtered. a a - To be added + @@ -247,10 +278,10 @@ - To be added + Generates a string representation of the path of . a a - To be added + This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string. @@ -264,11 +295,11 @@ - To be added - a - a - a - To be added + Sets to be the parent of . + an object of type + an object of type + an object of type + If is at the toplevel, and does not have a parent, then is set to an invalid iterator and is returned. will remain a valid node after this function has been called. @@ -281,9 +312,10 @@ - To be added + Emits an event + for . a - To be added + @@ -297,10 +329,11 @@ - To be added + Emits an event + for . a - a - To be added + a , points to the inserted row. + @@ -313,10 +346,10 @@ - To be added - a - a - To be added + Gets the of . + an object of type + an object of type + @@ -330,11 +363,11 @@ - To be added - a - a - a - To be added + Sets to a valid iterator pointing to . + an object of type + an object of type + an object of type + @@ -348,11 +381,10 @@ - To be added - a - a - a - To be added + Sets the TreeIter object pointed to by to point to the first child of this tree. + an object of type + an object of type , true if the iter has been set to the first child. + @@ -365,10 +397,10 @@ - To be added - a - a - To be added + Returns the number of children that has. + an object of type + an object of type + As a special case, if is , then the number of toplevel nodes is returned. @@ -381,9 +413,13 @@ - To be added - a - To be added + Lets the tree ref the node. + an object of type + + This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. + This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. + A model should be expected to be able to get an iter independent of its referenced state. + @@ -397,11 +433,11 @@ - To be added - a - a - a - To be added + Gets the at . + an object of type + an object of type + an object of type + Otherwise, is left invalid and is returned. @@ -414,10 +450,10 @@ - To be added - a - a - To be added + Returns if has children, otherwise. + an object of type + an object of type + @@ -431,11 +467,12 @@ - To be added + Emits an event + for . a a a - To be added + @@ -450,12 +487,11 @@ - To be added - a - a - a - a - To be added + Sets to be the child of the root node, using the given index. + an object of type + an object of type + an object of type + In this case, the nth root node is set. @@ -468,10 +504,10 @@ - To be added - a - a - To be added + Gets the first iterator in the tree (the one at the path "0") and returns . + an object of type + an object of type + Returns if the tree is empty. @@ -486,11 +522,11 @@ - To be added + Gets the value stored in column of the row pointed to by . a a - a - To be added + a + @@ -504,10 +540,12 @@ - To be added - a - a - To be added + Emits an event + for . + a , points to the changed row + a , points to the changed row + This should be called by models after the child state of + a node changes. @@ -520,9 +558,9 @@ - To be added + Calls a function on each row of a tree. a - To be added + @@ -536,10 +574,11 @@ - To be added - a - a - To be added + Emits an event + for . + a , points to the changed row + a , points to the changed row + @@ -554,11 +593,12 @@ - To be added - a - a - a - To be added + Emits the "rows_reordered" signal for this tree model. + + a pointing to the tree node whose children have been reordered +a pointing to the tree node whose children have been reordered + a , an array of integers containing the new indices of the children, i.e. the former child n is now at position new_order[n]. + This should be called by models when their rows have been reordered. @@ -572,10 +612,10 @@ - To be added + Emits the "row_changed" signal for this model. a a - To be added + This should be called by models when their rows have been reordered. @@ -588,9 +628,9 @@ - To be added + Emits the signal for this model. a - To be added + This should be called by models when their rows have been reordered. @@ -604,10 +644,10 @@ - To be added + Emits the signal for this model. a a - To be added + This should be called by models when a row has been inserted. @@ -621,10 +661,10 @@ - To be added + Emits the signal for this model. a a - To be added + This should be called by models when a row's child has been toggled on or off. @@ -637,10 +677,10 @@ - To be added - a + This method asks the source row for the dragged data to delete itself, because that data has been moved elsewhere. + a , the path of the row that was dragged a - To be added + This method returns FALSE if the deletion fails because path no longer exists, or for some other model-specific reason. @@ -653,10 +693,10 @@ - To be added - a - a - To be added + Checks to see whether a given row can be used as a source for a drag-and-drop operation. + a , the row being checked + a , TRUE if the row is draggable. + If the object does not implement this method, the row is assumed to be draggable. @@ -670,11 +710,11 @@ - To be added - a - a - a - To be added + Asks the to fill in with a representation of the row at . Should robustly handle a path no longer found in the model. + a + a object to fill with data + A see cref="T:System.Boolean" />; true if data of the required type was provided. + @@ -687,10 +727,10 @@ - To be added - a - a - To be added + Sets the TreeIter object pointed to by to point to the first child of this tree. + an object of type + an object of type , true if the iter has been set to the first child. + @@ -701,9 +741,10 @@ - To be added - a - To be added + Returns the number of children that has. + an object of type + an object of type + As a special case, if is , then the number of toplevel nodes is returned. @@ -717,11 +758,11 @@ - To be added - a - a - a - To be added + Sets to be the child of the root node, using the given index. + an object of type + an object of type + an object of type + In this case, the nth root node is set. @@ -736,11 +777,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a boolean. a a a - To be added + @@ -755,11 +796,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -774,11 +815,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -793,11 +834,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -812,11 +853,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -831,11 +872,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -850,11 +891,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -868,11 +909,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -883,10 +924,10 @@ - To be added + Basic constructor. a a - To be added + @@ -897,10 +938,10 @@ - To be added - a + Constructor. For internal use. + a , pointer to the underlying C object. a - To be added + @@ -912,11 +953,11 @@ - To be added - a - a + Constructor + a , the model this object is to filter + a , the node to use as the model's root node. a - To be added + @@ -929,7 +970,7 @@ To be added a - To be added + @@ -940,9 +981,9 @@ - To be added + The virtual root (relative to the child model) for this object. a - To be added + @@ -952,9 +993,9 @@ System.Int32 - To be added + The column of the model where this filter should look for visibility information. a - To be added + @@ -965,9 +1006,9 @@ - To be added + Gets the this filter is being applied to. a - To be added + @@ -978,9 +1019,9 @@ - To be added + Flag values for this tree model; see for possible values. a - To be added + @@ -991,9 +1032,9 @@ - To be added + The number of columns in the model. a - To be added + @@ -1004,8 +1045,8 @@ - To be added - To be added + Event that happens when rows in the model change order. + @@ -1016,8 +1057,8 @@ - To be added - To be added + Event that happens when a row in the model is changed. + @@ -1028,8 +1069,8 @@ - To be added - To be added + Event that happens when a row is deleted. + @@ -1040,8 +1081,8 @@ - To be added - To be added + Event that happens when a row is inserted. + @@ -1052,9 +1093,9 @@ - To be added - To be added + Event that happens when a row's child visibility is turned on or off. + - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeModelFilterModifyFunc.xml b/doc/en/Gtk/TreeModelFilterModifyFunc.xml index c7eba7009..35b4d3ee8 100644 --- a/doc/en/Gtk/TreeModelFilterModifyFunc.xml +++ b/doc/en/Gtk/TreeModelFilterModifyFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for methods to modify a tree. + Used primarily as a parameter for . See that method's documentation for more details. System.Delegate @@ -34,4 +34,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeModelFilterVisibleFunc.xml b/doc/en/Gtk/TreeModelFilterVisibleFunc.xml index f7328653e..de9830ab1 100644 --- a/doc/en/Gtk/TreeModelFilterVisibleFunc.xml +++ b/doc/en/Gtk/TreeModelFilterVisibleFunc.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for methods run when part of a tree is made visible. + Used primarily as a parameter for . Delegates should return TRUE if the given row should be visible and + FALSE otherwise. + System.Delegate @@ -32,4 +34,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeModelSort.xml b/doc/en/Gtk/TreeModelSort.xml index 1cc5fa6ee..181ac758b 100644 --- a/doc/en/Gtk/TreeModelSort.xml +++ b/doc/en/Gtk/TreeModelSort.xml @@ -1103,10 +1103,10 @@ node is always the parent. - To be added - a + This method asks the source row for the dragged data to delete itself, because that data has been moved elsewhere. + a , the path of the row that was dragged a - To be added + This method returns FALSE if the deletion fails because path no longer exists, or for some other model-specific reason. @@ -1119,10 +1119,10 @@ node is always the parent. - To be added - a - a - To be added + Checks to see whether a given row can be used as a source for a drag-and-drop operation. + a , the row being checked + a , TRUE if the row is draggable. + If the object does not implement this method, the row is assumed to be draggable. @@ -1136,12 +1136,12 @@ node is always the parent. - To be added - a - a - a - To be added + Asks the to fill in with a representation of the row at . Should robustly handle a path no longer found in the model. + a + a object to fill with data + A see cref="T:System.Boolean" />; true if data of the required type was provided. + - \ No newline at end of file +