AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
948e032072
gtk2/gtk/gtktreelistmodel.h

110 lines
5.0 KiB
C
Raw Normal View History

gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
/*
* Copyright © 2018 Benjamin Otte
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Benjamin Otte <otte@gnome.org>
*/
#ifndef __GTK_TREE_LIST_MODEL_H__
#define __GTK_TREE_LIST_MODEL_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gio/gio.h>
#include <gtk/gtkwidget.h>
G_BEGIN_DECLS
#define GTK_TYPE_TREE_LIST_MODEL (gtk_tree_list_model_get_type ())
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
#define GTK_TYPE_TREE_LIST_ROW (gtk_tree_list_row_get_type ())
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (GtkTreeListModel, gtk_tree_list_model, GTK, TREE_LIST_MODEL, GObject)
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
GDK_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (GtkTreeListRow, gtk_tree_list_row, GTK, TREE_LIST_ROW, GObject)
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
docs: Add missing TreeListModel docs
2018-09-16 17:38:25 +00:00
/**
* GtkTreeListModelCreateModelFunc:
listmodels: Clarify documentation for function prototypes Fixes #1341
2018-09-18 05:27:48 +00:00
* @item: (type GObject): The item that is being expanded
gtk: Fix some g-i annotations warnings
2018-09-17 11:00:36 +00:00
* @user_data: User data passed when registering the function
docs: Add missing TreeListModel docs
2018-09-16 17:38:25 +00:00
*
* Prototype of the function called to create new child models when
* gtk_tree_list_row_set_expanded() is called.
listmodels: Clarify documentation for function prototypes Fixes #1341
2018-09-18 05:27:48 +00:00
*
* This function can return %NULL to indicate that @item is guaranteed to be
Trivial typo fix
2020-06-05 21:08:29 +00:00
* a leaf node and will never have children.
listmodels: Clarify documentation for function prototypes Fixes #1341
2018-09-18 05:27:48 +00:00
* If it does not have children but may get children later, it should return
* an empty model that is filled once children arrive.
*
tree list model: Add a missing annotation The GtkTreeListModelCreateModelFunc returns a new reference.
2019-12-08 03:39:35 +00:00
* Returns: (nullable) (transfer full): The model tracking the children of @item or %NULL if
listmodels: Clarify documentation for function prototypes Fixes #1341
2018-09-18 05:27:48 +00:00
* @item can never have children
docs: Add missing TreeListModel docs
2018-09-16 17:38:25 +00:00
*/
gtk: Fix some g-i annotations warnings
2018-09-17 11:00:36 +00:00
typedef GListModel * (* GtkTreeListModelCreateModelFunc) (gpointer item, gpointer user_data);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
treelistmodel: Make constructor transfer full Make gtk_tree_list_model_new() take the root model as first argument, and make it transfer full, for consistency with other wrapping list constructors. Update all callers. Still missing here: Make the model property writable, and allow passing NULL in the constructor.
2020-07-26 20:38:53 +00:00
GtkTreeListModel * gtk_tree_list_model_new (GListModel *root,
gboolean passthrough,
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
gboolean autoexpand,
GtkTreeListModelCreateModelFunc create_func,
gtk: Fix some g-i annotations warnings
2018-09-17 11:00:36 +00:00
gpointer user_data,
GDestroyNotify user_destroy);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
treelistmodel: Add more API to navigate the tree This adds functionality from GtkTreeIter into GtkTreeListRow that allows finding items in the model and getting their position for use in GtkListBox.
2018-09-01 16:48:38 +00:00
GDK_AVAILABLE_IN_ALL
GListModel * gtk_tree_list_model_get_model (GtkTreeListModel *self);
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
GDK_AVAILABLE_IN_ALL
gboolean gtk_tree_list_model_get_passthrough (GtkTreeListModel *self);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
void gtk_tree_list_model_set_autoexpand (GtkTreeListModel *self,
gboolean autoexpand);
GDK_AVAILABLE_IN_ALL
gboolean gtk_tree_list_model_get_autoexpand (GtkTreeListModel *self);
treelistmodel: Add more API to navigate the tree This adds functionality from GtkTreeIter into GtkTreeListRow that allows finding items in the model and getting their position for use in GtkListBox.
2018-09-01 16:48:38 +00:00
GDK_AVAILABLE_IN_ALL
treelistmodel: Improve naming a bit The complexity with model items vs row items is really confusing. Add to that treelistmodel position vs child model position vs parent position, and you're so confused, even the best naming can't help. And once you're there, consider passthrough vs non-passthrough...
2018-09-18 05:50:33 +00:00
GtkTreeListRow * gtk_tree_list_model_get_child_row (GtkTreeListModel *self,
treelistmodel: Add more API to navigate the tree This adds functionality from GtkTreeIter into GtkTreeListRow that allows finding items in the model and getting their position for use in GtkListBox.
2018-09-01 16:48:38 +00:00
guint position);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
GtkTreeListRow * gtk_tree_list_model_get_row (GtkTreeListModel *self,
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
guint position);
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
GDK_AVAILABLE_IN_ALL
gpointer gtk_tree_list_row_get_item (GtkTreeListRow *self);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
void gtk_tree_list_row_set_expanded (GtkTreeListRow *self,
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
gboolean expanded);
GDK_AVAILABLE_IN_ALL
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
gboolean gtk_tree_list_row_get_expanded (GtkTreeListRow *self);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
GDK_AVAILABLE_IN_ALL
treelistmodel: Refactor to add GtkTreeListRow This patch does multiple things: 1. Add a custom persistent per-row object. 2. Move all per-row API to that object. This means notifications are now possible. 3. Add a "passthrough" construct-only property to the TreeListModel that influences if the model returns these new object or passes through the ones from the model. This greatly simplifies the code needed to be written for widgetry, because one can just connect the per-row object to the expanders that expand and collapse rows. As an added power feature, these objects can also be passed through further models (like filter models). It also adds kind of a hack to Adwaita to make the test look neat.
2018-09-01 02:59:06 +00:00
gboolean gtk_tree_list_row_is_expandable (GtkTreeListRow *self);
treelistmodel: Add more API to navigate the tree This adds functionality from GtkTreeIter into GtkTreeListRow that allows finding items in the model and getting their position for use in GtkListBox.
2018-09-01 16:48:38 +00:00
GDK_AVAILABLE_IN_ALL
guint gtk_tree_list_row_get_position (GtkTreeListRow *self);
GDK_AVAILABLE_IN_ALL
guint gtk_tree_list_row_get_depth (GtkTreeListRow *self);
GDK_AVAILABLE_IN_ALL
GListModel * gtk_tree_list_row_get_children (GtkTreeListRow *self);
GDK_AVAILABLE_IN_ALL
GtkTreeListRow * gtk_tree_list_row_get_parent (GtkTreeListRow *self);
GDK_AVAILABLE_IN_ALL
treelistmodel: Improve naming a bit The complexity with model items vs row items is really confusing. Add to that treelistmodel position vs child model position vs parent position, and you're so confused, even the best naming can't help. And once you're there, consider passthrough vs non-passthrough...
2018-09-18 05:50:33 +00:00
GtkTreeListRow * gtk_tree_list_row_get_child_row (GtkTreeListRow *self,
gtk: Fix some g-i annotations warnings
2018-09-17 11:00:36 +00:00
guint position);
gtk: Add GtkTreeListModel This is a GListModel implementation with a neat API that can be used to implement trees inside GtkListBox.
2018-06-12 01:56:21 +00:00
G_END_DECLS
#endif /* __GTK_TREE_LIST_MODEL_H__ */
Reference in New Issue Copy Permalink