/*
 * 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_LIST_VIEW_H__
#define __GTK_LIST_VIEW_H__

#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

#include <gtk/gtklistbase.h>
#include <gtk/gtkfilter.h>

G_BEGIN_DECLS

#define GTK_TYPE_LIST_VIEW         (gtk_list_view_get_type ())
#define GTK_LIST_VIEW(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_LIST_VIEW, GtkListView))
#define GTK_LIST_VIEW_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_LIST_VIEW, GtkListViewClass))
#define GTK_IS_LIST_VIEW(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_LIST_VIEW))
#define GTK_IS_LIST_VIEW_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_LIST_VIEW))
#define GTK_LIST_VIEW_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_LIST_VIEW, GtkListViewClass))

/**
 * GtkListView:
 *
 * GtkListView is the simple list implementation for GTK's list widgets.
 */
typedef struct _GtkListView GtkListView;
typedef struct _GtkListViewClass GtkListViewClass;

GDK_AVAILABLE_IN_ALL
GType           gtk_list_view_get_type                          (void) G_GNUC_CONST;

GDK_AVAILABLE_IN_ALL
GtkWidget *     gtk_list_view_new                               (void);
GDK_AVAILABLE_IN_ALL
GtkWidget *     gtk_list_view_new_with_factory                  (GtkListItemFactory     *factory);

GDK_AVAILABLE_IN_ALL
GListModel *    gtk_list_view_get_model                         (GtkListView            *self);
GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_model                         (GtkListView            *self,
                                                                 GListModel             *model);
GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_factory                       (GtkListView            *self,
                                                                 GtkListItemFactory     *factory);
GDK_AVAILABLE_IN_ALL
GtkListItemFactory *
                gtk_list_view_get_factory                       (GtkListView            *self);

GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_show_separators               (GtkListView            *self,
                                                                 gboolean                show_separators);
GDK_AVAILABLE_IN_ALL
gboolean        gtk_list_view_get_show_separators               (GtkListView            *self);

GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_single_click_activate         (GtkListView            *self,
                                                                 gboolean                single_click_activate);
GDK_AVAILABLE_IN_ALL
gboolean        gtk_list_view_get_single_click_activate         (GtkListView            *self);

GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_enable_rubberband             (GtkListView            *self,
                                                                 gboolean                enable_rubberband);
GDK_AVAILABLE_IN_ALL
gboolean        gtk_list_view_get_enable_rubberband             (GtkListView            *self);

GDK_AVAILABLE_IN_ALL
void            gtk_list_view_set_search_filter                 (GtkListView            *self,
                                                                 GtkFilter              *filter);
GDK_AVAILABLE_IN_ALL
GtkFilter *     gtk_list_view_get_search_filter                 (GtkListView            *self);

GDK_AVAILABLE_IN_ALL
void            gtk_list_view_select_next_match                 (GtkListView            *self,
                                                                 gboolean                forward);

G_END_DECLS

#endif  /* __GTK_LIST_VIEW_H__ */