/*
* Copyright © 2019 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 .
*
* Authors: Benjamin Otte
*/
#pragma once
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only can be included directly."
#endif
#include
#include
G_BEGIN_DECLS
#define GTK_TYPE_LIST_BASE (gtk_list_base_get_type ())
#define GTK_LIST_BASE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_LIST_BASE, GtkListBase))
#define GTK_LIST_BASE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_LIST_BASE, GtkListBaseClass))
#define GTK_IS_LIST_BASE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_LIST_BASE))
#define GTK_IS_LIST_BASE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_LIST_BASE))
#define GTK_LIST_BASE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_LIST_BASE, GtkListBaseClass))
/**
* GtkListBase:
*
* The abstract base class for GTK's list widgets.
*
* # Shortcuts and Gestures
*
* `GtkListBase` supports the following keyboard shortcuts:
*
* - Ctrl+A or Ctrl+/
* selects all items.
* - Ctrl+Shift+A or
* Ctrl+\ unselects all items.
*
* The focused item is controlled by the navigation keys below, combined
* with the Ctrl modifier to prevent moving the selection,
* and the Shift modifier to extend the current selection.
*
* - ←, →, ↑, ↓ move the focus
* on the next item in the designed direction.
* - Home and End focus the first or last item.
* - PgUp and PgDn move the focus one page up or down.
*
* List item widgets support the following keyboard shortcuts:
*
* - Enter activates the item.
* - ␣ selects the item, with the same Ctrl and
* Shift modifiers combinations as the navigation keys.
*
* # Actions
*
* `GtkListBase` defines a set of built-in actions:
*
* - `list.scroll-to-item` moves the visible area to the item at given position
* with the minimum amount of scrolling required. If the item is already
* visible, nothing happens.
* - `list.select-item` changes the selection.
* - `list.select-all` selects all items in the model, if the selection model
* supports it.
* - `list.unselect-all` unselects all items in the model, if the selection
* model supports it.
*
* List item widgets install the following actions:
*
* - `listitem.select` changes selection if the item is selectable.
* - `listitem.scroll-to` moves the visible area of the list to this item with
* the minimum amount of scrolling required.
*/
typedef struct _GtkListBase GtkListBase;
typedef struct _GtkListBaseClass GtkListBaseClass;
GDK_AVAILABLE_IN_ALL
GType gtk_list_base_get_type (void);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkListBase, g_object_unref)
G_END_DECLS