stylecontext: Do invalidation on first resize container

[~andy/gtk] / gtk / gtktreemodelfilter.h

diff --git a/gtk/gtktreemodelfilter.h b/gtk/gtktreemodelfilter.h
index 3e17680518f231991ce49dbf47312eecfbbf9ce7..832de5069844404eb177359bd91f42fbd2e8a455 100644 (file)
--- a/gtk/gtktreemodelfilter.h
+++ b/gtk/gtktreemodelfilter.h
@@ -13,14 +13,16 @@
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef __GTK_TREE_MODEL_FILTER_H__
 #define __GTK_TREE_MODEL_FILTER_H__
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <gtk/gtktreemodel.h>
 
 G_BEGIN_DECLS
@@ -30,11 +32,40 @@ G_BEGIN_DECLS
 #define GTK_TREE_MODEL_FILTER_CLASS(vtable)     (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
 #define GTK_IS_TREE_MODEL_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL_FILTER))
 #define GTK_IS_TREE_MODEL_FILTER_CLASS(vtable)  (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_TREE_MODEL_FILTER))
-#define GTK_TREE_MODEL_FILTER_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
-
+#define GTK_TREE_MODEL_FILTER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterClass))
+
+/**
+ * GtkTreeModelFilterVisibleFunc:
+ * @model: the child model of the #GtkTreeModelFilter
+ * @iter: a #GtkTreeIter pointing to the row in @model whose visibility
+ *   is determined
+ * @data: (closure): user data given to gtk_tree_model_filter_set_visible_func()
+ *
+ * A function which decides whether the row indicated by @iter is visible.
+ *
+ * Returns: Whether the row indicated by @iter is visible.
+ */
 typedef gboolean (* GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model,
                                                     GtkTreeIter  *iter,
                                                     gpointer      data);
+
+/**
+ * GtkTreeModelFilterModifyFunc:
+ * @model: the #GtkTreeModelFilter
+ * @iter: a #GtkTreeIter pointing to the row whose display values are determined
+ * @value: A #GValue which is already initialized for with the correct type for
+ *  the column @column.
+ * @column: the column whose display value is determined
+ * @data: (closure): user data given to gtk_tree_model_filter_set_modify_func()
+ *
+ * A function which calculates display values from raw values in the model.
+ * It must fill @value with the display value for the column @column in the
+ * row indicated by @iter.
+ *
+ * Since this function is called for each data access, it's not a
+ * particularly efficient operation.
+ */
+
 typedef void (* GtkTreeModelFilterModifyFunc) (GtkTreeModel *model,
                                                GtkTreeIter  *iter,
                                                GValue       *value,
@@ -57,34 +88,43 @@ struct _GtkTreeModelFilterClass
 {
   GObjectClass parent_class;
 
+  gboolean (* visible) (GtkTreeModelFilter *self,
+                        GtkTreeModel       *child_model,
+                        GtkTreeIter        *iter);
+  void (* modify) (GtkTreeModelFilter *self,
+                   GtkTreeModel       *child_model,
+                   GtkTreeIter        *iter,
+                   GValue             *value,
+                   gint                column);
+
   /* Padding for future expansion */
-  void (*_gtk_reserved0) (void);
   void (*_gtk_reserved1) (void);
   void (*_gtk_reserved2) (void);
   void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };
 
 /* base */
-GType         gtk_tree_model_filter_get_type                   (void);
+GType         gtk_tree_model_filter_get_type                   (void) G_GNUC_CONST;
 GtkTreeModel *gtk_tree_model_filter_new                        (GtkTreeModel                 *child_model,
                                                                 GtkTreePath                  *root);
 void          gtk_tree_model_filter_set_visible_func           (GtkTreeModelFilter           *filter,
                                                                 GtkTreeModelFilterVisibleFunc func,
                                                                 gpointer                      data,
-                                                                GtkDestroyNotify              destroy);
+                                                                GDestroyNotify                destroy);
 void          gtk_tree_model_filter_set_modify_func            (GtkTreeModelFilter           *filter,
                                                                 gint                          n_columns,
                                                                 GType                        *types,
                                                                 GtkTreeModelFilterModifyFunc  func,
                                                                 gpointer                      data,
-                                                                GtkDestroyNotify              destroy);
+                                                                GDestroyNotify                destroy);
 void          gtk_tree_model_filter_set_visible_column         (GtkTreeModelFilter           *filter,
                                                                 gint                          column);
 
 GtkTreeModel *gtk_tree_model_filter_get_model                  (GtkTreeModelFilter           *filter);
 
 /* conversion */
-void          gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter           *filter,
+gboolean      gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter           *filter,
                                                                 GtkTreeIter                  *filter_iter,
                                                                 GtkTreeIter                  *child_iter);
 void          gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter           *filter,
@@ -92,7 +132,7 @@ void          gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilt
                                                                 GtkTreeIter                  *filter_iter);
 GtkTreePath  *gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter           *filter,
                                                                 GtkTreePath                  *child_path);
-GtkTreePath  *gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter           *path,
+GtkTreePath  *gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter           *filter,
                                                                 GtkTreePath                  *filter_path);
 
 /* extras */