gtk2/gtk/gtkmaplistmodel.h
Matthias Clasen 8ba16eb4f1 Documentation fixes
Mostly fixing up indentation of continuation lines,
and other small cleanups.
2021-05-20 19:17:49 -04:00

76 lines
2.9 KiB
C

/*
* 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_MAP_LIST_MODEL_H__
#define __GTK_MAP_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_MAP_LIST_MODEL (gtk_map_list_model_get_type ())
GDK_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (GtkMapListModel, gtk_map_list_model, GTK, MAP_LIST_MODEL, GObject)
/**
* GtkMapListModelMapFunc:
* @item: (type GObject) (transfer full): The item to map
* @user_data: user data
*
* User function that is called to map an @item of the original model to
* an item expected by the map model.
*
* The returned items must conform to the item type of the model they are
* used with.
*
* Returns: (type GObject) (transfer full): The item to map to
*/
typedef gpointer (* GtkMapListModelMapFunc) (gpointer item, gpointer user_data);
GDK_AVAILABLE_IN_ALL
GtkMapListModel * gtk_map_list_model_new (GListModel *model,
GtkMapListModelMapFunc map_func,
gpointer user_data,
GDestroyNotify user_destroy);
GDK_AVAILABLE_IN_ALL
void gtk_map_list_model_set_map_func (GtkMapListModel *self,
GtkMapListModelMapFunc map_func,
gpointer user_data,
GDestroyNotify user_destroy);
GDK_AVAILABLE_IN_ALL
void gtk_map_list_model_set_model (GtkMapListModel *self,
GListModel *model);
GDK_AVAILABLE_IN_ALL
GListModel * gtk_map_list_model_get_model (GtkMapListModel *self);
GDK_AVAILABLE_IN_ALL
gboolean gtk_map_list_model_has_map (GtkMapListModel *self);
G_END_DECLS
#endif /* __GTK_MAP_LIST_MODEL_H__ */