forked from AuroraMiddleware/gtk
541aaa2392
This is not just about consistency with other functions. It is about avoiding reentrancy problems. GtkListBase first doing an unselect_all() will then force the SelectionModel to consider a state where all items are unselected (and potentially deciding to autoselect one) and then cause a "selection-changed" emission that unselects all items and potentially updates all the list item widgets in the GtkListBase to the unselected state. After this, GtkListBase selects new items, but to the SelectionModel and the list item widgets this looks like an enitrely new operation and there is no way to associate it with the previous state, so the SelectionModel cannot undo any previous actions it took when unselecting. And all listitem widgets will now think they were just selected and start running animations about selecting.
177 lines
9.7 KiB
C
177 lines
9.7 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_SELECTION_MODEL_H__
|
|
#define __GTK_SELECTION_MODEL_H__
|
|
|
|
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
|
#error "Only <gtk/gtk.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gdk/gdk.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GTK_TYPE_SELECTION_MODEL (gtk_selection_model_get_type ())
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
G_DECLARE_INTERFACE (GtkSelectionModel, gtk_selection_model, GTK, SELECTION_MODEL, GListModel)
|
|
|
|
/**
|
|
* GtkSelectionCallback:
|
|
* @position: the position to query
|
|
* @start_range: (out): returns the position of the first element of the range
|
|
* @n_items: (out): returns the size of the range
|
|
* @selected: (out): returns whether items in @range are selected
|
|
* @data: callback data
|
|
*
|
|
* Callback type for determining items to operate on with
|
|
* gtk_selection_model_select_callback() or
|
|
* gtk_selection_model_unselect_callback().
|
|
*
|
|
* The callback determines a range of consecutive items around
|
|
* @position which should either all
|
|
* be changed, in which case @selected is set to %TRUE, or all not
|
|
* be changed, in which case @selected is set to %FALSE.
|
|
*
|
|
* @start_range and @n_items are set to return the range.
|
|
*
|
|
* The callback will be called repeatedly to find all ranges
|
|
* to operate on until it has exhausted the items of the model,
|
|
* or until it returns an empty range (ie @n_items == 0).
|
|
*/
|
|
typedef void (* GtkSelectionCallback) (guint position,
|
|
guint *start_range,
|
|
guint *n_items,
|
|
gboolean *selected,
|
|
gpointer data);
|
|
|
|
|
|
/**
|
|
* GtkSelectionModelInterface:
|
|
* @is_selected: Return if the item at the given position is selected.
|
|
* @select_item: Select the item in the given position. If the operation
|
|
* is known to fail, return %FALSE.
|
|
* @unselect_item: Unselect the item in the given position. If the
|
|
* operation is known to fail, return %FALSE.
|
|
* @select_range: Select all items in the given range. If the operation
|
|
* is unsupported or known to fail for all items, return %FALSE.
|
|
* @unselect_range: Unselect all items in the given range. If the
|
|
* operation is unsupported or known to fail for all items, return
|
|
* %FALSE.
|
|
* @select_all: Select all items in the model. If the operation is
|
|
* unsupported or known to fail for all items, return %FALSE.
|
|
* @unselect_all: Unselect all items in the model. If the operation is
|
|
* unsupported or known to fail for all items, return %FALSE.
|
|
*
|
|
* The list of virtual functions for the #GtkSelectionModel interface.
|
|
* All getter functions are mandatory to implement, but the model does
|
|
* not need to implement any functions to support selecting or unselecting
|
|
* items. Of course, if the model does not do that, it means that users
|
|
* cannot select or unselect items in a list widgets using the model.
|
|
*/
|
|
struct _GtkSelectionModelInterface
|
|
{
|
|
/*< private >*/
|
|
GTypeInterface g_iface;
|
|
|
|
/*< public >*/
|
|
gboolean (* is_selected) (GtkSelectionModel *model,
|
|
guint position);
|
|
|
|
gboolean (* select_item) (GtkSelectionModel *model,
|
|
guint position,
|
|
gboolean unselect_rest);
|
|
gboolean (* unselect_item) (GtkSelectionModel *model,
|
|
guint position);
|
|
gboolean (* select_range) (GtkSelectionModel *model,
|
|
guint position,
|
|
guint n_items,
|
|
gboolean unselect_rest);
|
|
gboolean (* unselect_range) (GtkSelectionModel *model,
|
|
guint position,
|
|
guint n_items);
|
|
gboolean (* select_all) (GtkSelectionModel *model);
|
|
gboolean (* unselect_all) (GtkSelectionModel *model);
|
|
gboolean (* select_callback) (GtkSelectionModel *model,
|
|
gboolean unselect_rest,
|
|
GtkSelectionCallback callback,
|
|
gpointer data);
|
|
gboolean (* unselect_callback) (GtkSelectionModel *model,
|
|
GtkSelectionCallback callback,
|
|
gpointer data);
|
|
void (* query_range) (GtkSelectionModel *model,
|
|
guint position,
|
|
guint *start_range,
|
|
guint *n_items,
|
|
gboolean *selected);
|
|
};
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_is_selected (GtkSelectionModel *model,
|
|
guint position);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_select_item (GtkSelectionModel *model,
|
|
guint position,
|
|
gboolean unselect_rest);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_unselect_item (GtkSelectionModel *model,
|
|
guint position);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_select_range (GtkSelectionModel *model,
|
|
guint position,
|
|
guint n_items,
|
|
gboolean unselect_rest);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_unselect_range (GtkSelectionModel *model,
|
|
guint position,
|
|
guint n_items);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_select_all (GtkSelectionModel *model);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_unselect_all (GtkSelectionModel *model);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_select_callback (GtkSelectionModel *model,
|
|
gboolean unselect_rest,
|
|
GtkSelectionCallback callback,
|
|
gpointer data);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_selection_model_unselect_callback (GtkSelectionModel *model,
|
|
GtkSelectionCallback callback,
|
|
gpointer data);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_selection_model_query_range (GtkSelectionModel *model,
|
|
guint position,
|
|
guint *start_range,
|
|
guint *n_items,
|
|
gboolean *selected);
|
|
|
|
/* for implementations only */
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_selection_model_selection_changed (GtkSelectionModel *model,
|
|
guint position,
|
|
guint n_items);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GTK_SELECTION_MODEL_H__ */
|