AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
c00b234440
gtk2/gtk/gtklistitemfactory.c

167 lines
6.1 KiB
C
Raw Normal View History

listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +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>
*/
#include "config.h"
#include "gtklistitemfactoryprivate.h"
listview: Add GtkListItem GtkListItem is a generic row widget that is supposed to replace GtkListBoxRow and GtkFlowBoxChild.
2018-09-21 03:05:34 +00:00
#include "gtklistitemprivate.h"
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
/**
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* GtkListItemFactory:
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* A `GtkListItemFactory` creates widgets for the items taken from a `GListModel`.
*
* This is one of the core concepts of handling list widgets such
* as [class@Gtk.ListView] or [class@Gtk.GridView].
*
* The `GtkListItemFactory` is tasked with creating widgets for items
* taken from the model when the views need them and updating them as
* the items displayed by the view change.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*
* A view is usually only able to display anything after both a factory
* and a model have been set on the view. So it is important that you do
* not skip this step when setting up your first view.
*
* Because views do not display the whole list at once but only a few
* items, they only need to maintain a few widgets at a time. They will
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* instruct the `GtkListItemFactory` to create these widgets and bind them
gtklistitemfactory: Cosmetic documentation fixes
2020-06-30 02:08:51 +00:00
* to the items that are currently displayed.
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
*
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
* As the list model changes or the user scrolls to the list, the items will
* change and the view will instruct the factory to bind the widgets to those
* new items.
*
* The actual widgets used for displaying those widgets is provided by you.
*
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* When the factory needs widgets created, it will create a `GtkListItem`
* and hand it to your code to set up a widget for. This list item will provide
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
* various properties with information about what item to display and provide
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* you with some opportunities to configure its behavior. See the
* [class@Gtk.ListItem] documentation for further details.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* Various implementations of `GtkListItemFactory` exist to allow you different
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
* ways to provide those widgets. The most common implementations are
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* [class@Gtk.BuilderListItemFactory] which takes a `GtkBuilder` .ui file
* and then creates widgets and manages everything automatically from the
* information in that file and [class@Gtk.SignalListItemFactory] which allows
* you to connect to signals with your own code and retain full control over
* how the widgets are setup and managed.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* A `GtkListItemFactory` is supposed to be final - that means its behavior should
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
* not change and the first widget created from it should behave the same way as
gtklistitemfactory: Cosmetic documentation fixes
2020-06-30 02:08:51 +00:00
* the last widget created from it.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
* If you intend to do changes to the behavior, it is recommended that you create
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* a new `GtkListItemFactory` which will allow the views to recreate its widgets.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*
listitemfactory: Convert docs
2021-02-27 23:18:12 +00:00
* Once you have chosen your factory and created it, you need to set it
* on the view widget you want to use it with, such as via
* [method@Gtk.ListView.set_factory]. Reusing factories across different
* views is allowed, but very uncommon.
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
*/
G_DEFINE_TYPE (GtkListItemFactory, gtk_list_item_factory, G_TYPE_OBJECT)
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
static void
gtk_list_item_factory_default_setup (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget,
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
GtkListItem *list_item)
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
gtk_list_item_widget_default_setup (widget, list_item);
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
}
static void
gtk_list_item_factory_default_teardown (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget,
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
GtkListItem *list_item)
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
gtk_list_item_widget_default_teardown (widget, list_item);
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
gtk_list_item_set_child (list_item, NULL);
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
}
static void
listitemfactory: Reorganize vfuncs Instead of bind/rebind/update/unbind, we now just have update, and the factories get to interpret that in the way they want.
2019-11-02 17:56:36 +00:00
gtk_list_item_factory_default_update (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget,
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
GtkListItem *list_item,
guint position,
gpointer item,
gboolean selected)
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
gtk_list_item_widget_default_update (widget, list_item, position, item, selected);
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
}
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
static void
gtk_list_item_factory_class_init (GtkListItemFactoryClass *klass)
{
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
klass->setup = gtk_list_item_factory_default_setup;
klass->teardown = gtk_list_item_factory_default_teardown;
klass->update = gtk_list_item_factory_default_update;
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
}
static void
gtk_list_item_factory_init (GtkListItemFactory *self)
{
}
listitem: Add a press gesture to select the item This is implemented by using actions, which are a neat trick to get to allow the ListItem to call functions on the ListView without actually needing to be aware of it.
2018-10-05 21:24:18 +00:00
void
gtk_list_item_factory_setup (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget)
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItem *list_item;
listitem: Add a press gesture to select the item This is implemented by using actions, which are a neat trick to get to allow the ListItem to call functions on the ListView without actually needing to be aware of it.
2018-10-05 21:24:18 +00:00
g_return_if_fail (GTK_IS_LIST_ITEM_FACTORY (self));
listview: Add GtkListItem GtkListItem is a generic row widget that is supposed to replace GtkListBoxRow and GtkFlowBoxChild.
2018-09-21 03:05:34 +00:00
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
list_item = gtk_list_item_new ();
GTK_LIST_ITEM_FACTORY_GET_CLASS (self)->setup (self, widget, list_item);
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
}
void
gtk_list_item_factory_teardown (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget)
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItem *list_item;
listitemfactory: vfuncify No functional changes other than a new indirection.
2019-06-09 22:17:44 +00:00
g_return_if_fail (GTK_IS_LIST_ITEM_FACTORY (self));
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
list_item = gtk_list_item_widget_get_list_item (widget);
GTK_LIST_ITEM_FACTORY_GET_CLASS (self)->teardown (self, widget, list_item);
g_object_unref (list_item);
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
}
listitem: Add gtk_list_item_get_position() Also refactor the whole list item management yet again. Now, list item APIs doesn't have bind/unbind functions anymore, but only property setters. The item factory is the only one doing the binding. As before, the item manager manages when items need to be bound.
2018-09-24 02:01:37 +00:00
void
gtk_list_item_factory_update (GtkListItemFactory *self,
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItemWidget *widget,
listview: Add selection properties to ListItem This just brings the infrastructure into place, we're not using the properties yet.
2018-09-29 20:34:43 +00:00
guint position,
listitemfactory: Reorganize vfuncs Instead of bind/rebind/update/unbind, we now just have update, and the factories get to interpret that in the way they want.
2019-11-02 17:56:36 +00:00
gpointer item,
listview: Add selection properties to ListItem This just brings the infrastructure into place, we're not using the properties yet.
2018-09-29 20:34:43 +00:00
gboolean selected)
listitem: Add gtk_list_item_get_position() Also refactor the whole list item management yet again. Now, list item APIs doesn't have bind/unbind functions anymore, but only property setters. The item factory is the only one doing the binding. As before, the item manager manages when items need to be bound.
2018-09-24 02:01:37 +00:00
{
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GtkListItem *list_item;
listitem: Add gtk_list_item_get_position() Also refactor the whole list item management yet again. Now, list item APIs doesn't have bind/unbind functions anymore, but only property setters. The item factory is the only one doing the binding. As before, the item manager manages when items need to be bound.
2018-09-24 02:01:37 +00:00
g_return_if_fail (GTK_IS_LIST_ITEM_FACTORY (self));
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
g_return_if_fail (GTK_IS_LIST_ITEM_WIDGET (widget));
list_item = gtk_list_item_widget_get_list_item (widget);
listitem: Add gtk_list_item_get_position() Also refactor the whole list item management yet again. Now, list item APIs doesn't have bind/unbind functions anymore, but only property setters. The item factory is the only one doing the binding. As before, the item manager manages when items need to be bound.
2018-09-24 02:01:37 +00:00
listitemfactory: Simplify Instead of 6 vfuncs, we now have 3 and rely on the factory keeping track of what it needs to do. We're doing lots of dancing from one object to another here, but this will hopefully get simpler with further commits.
2019-11-03 01:23:46 +00:00
GTK_LIST_ITEM_FACTORY_GET_CLASS (self)->update (self, widget, list_item, position, item, selected);
listview: Introduce GtkListItemFactory Thisis the abstraction I intend to use for creating widgets and binding them to the item out of the listview. For now this is a very dumb wrapper around the functions that exist in the API. But it leaves the freedom to turn this into public API, make an interface out of it and most of all write different implementations, in particular one that uses GtkBuilder.
2018-09-17 05:29:50 +00:00
}
Reference in New Issue Copy Permalink