AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
7bebc3e2b2
gtk2/gtk/gtkselectionmodel.h

130 lines
7.1 KiB
C
Raw Normal View History

gtk: Add GtkSelectionModel The selection model is a list model interface that takes care of selections and is to be used by the list model widgets to manage their selections.
2018-10-03 16:49:48 +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>
*/
#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)
/**
* 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 exclusive);
gboolean (* unselect_item) (GtkSelectionModel *model,
guint position);
gboolean (* select_range) (GtkSelectionModel *model,
guint position,
guint n_items,
gboolean exclusive);
gboolean (* unselect_range) (GtkSelectionModel *model,
guint position,
guint n_items);
gboolean (* select_all) (GtkSelectionModel *model);
gboolean (* unselect_all) (GtkSelectionModel *model);
selectionmodel: Change prototype of query_range() 1. Do not make position an inout variable The function is meant to return a range for a given position, not modify a position. So it makes no conceptual sense to use an inout variable. 2. Pass the selected state as an out variable Using a boolean return value - in particular in an interface full of boolean return values - makes the return value intuitively feel like a success/failure return. Using an out variable clarifies the usage. 3. Allow passing every position value Define what happens when position >= list.n_items 4. Clarify the docs about how this function should behave In particular, mention the case from point (3) 5. Add more tests Again, (3) needs testing.
2019-02-11 03:57:46 +00:00
void (* query_range) (GtkSelectionModel *model,
guint position,
guint *start_range,
guint *n_items,
gboolean *selected);
gtk: Add GtkSelectionModel The selection model is a list model interface that takes care of selections and is to be used by the list model widgets to manage their selections.
2018-10-03 16:49:48 +00:00
};
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 exclusive);
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 exclusive);
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
selectionmodel: Change prototype of query_range() 1. Do not make position an inout variable The function is meant to return a range for a given position, not modify a position. So it makes no conceptual sense to use an inout variable. 2. Pass the selected state as an out variable Using a boolean return value - in particular in an interface full of boolean return values - makes the return value intuitively feel like a success/failure return. Using an out variable clarifies the usage. 3. Allow passing every position value Define what happens when position >= list.n_items 4. Clarify the docs about how this function should behave In particular, mention the case from point (3) 5. Add more tests Again, (3) needs testing.
2019-02-11 03:57:46 +00:00
void gtk_selection_model_query_range (GtkSelectionModel *model,
guint position,
guint *start_range,
guint *n_items,
gboolean *selected);
gtk: Add GtkSelectionModel The selection model is a list model interface that takes care of selections and is to be used by the list model widgets to manage their selections.
2018-10-03 16:49:48 +00:00
/* 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__ */
Reference in New Issue Copy Permalink