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

205 lines
6.8 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
/**
* SECTION:gtklistitemfactory
* @Title: GtkListItemFactory
* @Short_description: Mapping list items to widgets
*
* #GtkListItemFactory is one of the core concepts of handling list widgets.
* It is the object tasked with creating widgets for items taken from a
* #GListModel when the views need them and updating them as the items
* displayed by the view change.
*
* 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
* instruct the #GtkListItemFactory to create these widgets and bind them
* to the items that are currently displayed.
* 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.
*
* 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
* various properties with information about what item to display and provide
* you with some opportunities to configure its behavior. See the #GtkListItem
* documentation for further details.
*
* Various implementations of #GtkListItemFactory exist to allow you different
* ways to provide those widgets. The most common implementations are
* #GtkBuilderListItemFactory which takes a #GtkBuilder .ui file and then creates
* and manages widgets everything automatically from the information in that file
* and #GtkSignalListItemFactory which allows you to connect to signals with your
* own code and retain full control over how the widgets are setup and managed.
*
* A #GtkListItemFactory is supposed to be final - that means its behavior should
* not change and the first widget created from it should behave the same way as
* the last widget created from it.
* If you intend to do changes to the behavior, it is recommended that you create
* a new #GtkListItemFactory which will allow the views to recreate its widgets.
*
* 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 gtk_list_view_set_factory().
* Reusing factories across different views is allowed, but very uncommon.
*/
struct _GtkListItemFactory
{
GObject parent_instance;
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
GtkListItemSetupFunc setup_func;
GtkListItemBindFunc bind_func;
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
gpointer user_data;
GDestroyNotify user_destroy;
};
struct _GtkListItemFactoryClass
{
GObjectClass parent_class;
};
G_DEFINE_TYPE (GtkListItemFactory, gtk_list_item_factory, G_TYPE_OBJECT)
static void
gtk_list_item_factory_finalize (GObject *object)
{
GtkListItemFactory *self = GTK_LIST_ITEM_FACTORY (object);
if (self->user_destroy)
self->user_destroy (self->user_data);
G_OBJECT_CLASS (gtk_list_item_factory_parent_class)->finalize (object);
}
static void
gtk_list_item_factory_class_init (GtkListItemFactoryClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = gtk_list_item_factory_finalize;
}
static void
gtk_list_item_factory_init (GtkListItemFactory *self)
{
}
GtkListItemFactory *
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
gtk_list_item_factory_new (GtkListItemSetupFunc setup_func,
GtkListItemBindFunc bind_func,
gpointer user_data,
GDestroyNotify user_destroy)
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
{
GtkListItemFactory *self;
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
g_return_val_if_fail (setup_func || bind_func, NULL);
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_return_val_if_fail (user_data != NULL || user_destroy == NULL, NULL);
self = g_object_new (GTK_TYPE_LIST_ITEM_FACTORY, NULL);
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
self->setup_func = setup_func;
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
self->bind_func = bind_func;
self->user_data = user_data;
self->user_destroy = user_destroy;
return 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
GtkListItem *
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
gtk_list_item_factory_create (GtkListItemFactory *self)
{
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
GtkWidget *result;
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
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_return_val_if_fail (GTK_IS_LIST_ITEM_FACTORY (self), NULL);
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
result = gtk_list_item_new ("row");
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
if (self->setup_func)
self->setup_func (GTK_LIST_ITEM (result), self->user_data);
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
return GTK_LIST_ITEM (result);
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
}
void
gtk_list_item_factory_bind (GtkListItemFactory *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
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
guint position,
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
gpointer item,
gboolean 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
{
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
g_return_if_fail (GTK_IS_LIST_ITEM (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_object_freeze_notify (G_OBJECT (list_item));
gtk_list_item_set_item (list_item, item);
gtk_list_item_set_position (list_item, position);
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
gtk_list_item_set_selected (list_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
listview: Change how binding is done We now don't let the functions create widgets for the item from the listmodel, instead we hand out a GtkListItem for them to add a widget to. GtkListItems are created in advance and can only be filled in by the binding code by gtk_container_add()ing a widget. However, they are GObjects, so they can provide properties that the binding code can make use of - either via notify signals or GBinding.
2018-09-24 02:42:15 +00:00
if (self->bind_func)
self->bind_func (list_item, self->user_data);
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_object_thaw_notify (G_OBJECT (list_item));
}
void
gtk_list_item_factory_update (GtkListItemFactory *self,
GtkListItem *list_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
guint position,
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
{
g_return_if_fail (GTK_IS_LIST_ITEM_FACTORY (self));
g_return_if_fail (GTK_IS_LIST_ITEM (list_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
g_object_freeze_notify (G_OBJECT (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
gtk_list_item_set_position (list_item, position);
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
gtk_list_item_set_selected (list_item, selected);
g_object_thaw_notify (G_OBJECT (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
}
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
void
gtk_list_item_factory_unbind (GtkListItemFactory *self,
GtkListItem *list_item)
{
g_return_if_fail (GTK_IS_LIST_ITEM_FACTORY (self));
g_return_if_fail (GTK_IS_LIST_ITEM (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_object_freeze_notify (G_OBJECT (list_item));
gtk_list_item_set_item (list_item, NULL);
gtk_list_item_set_position (list_item, 0);
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
gtk_list_item_set_selected (list_item, FALSE);
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_object_thaw_notify (G_OBJECT (list_item));
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
}
Reference in New Issue Copy Permalink