summaryrefslogtreecommitdiff
path: root/gtk/gtklistitemmanagerprivate.h
blob: ea855f4cc56008cd804f405690d72f216db8c5b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
 * 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>
 */


#pragma once

#include "gtk/gtktypes.h"
#include "gtk/gtkenums.h"

#include "gtk/gtklistitembaseprivate.h"
#include "gtk/gtklistheaderbaseprivate.h"
#include "gtk/gtklistitemfactory.h"
#include "gtk/gtkrbtreeprivate.h"
#include "gtk/gtkselectionmodel.h"

G_BEGIN_DECLS

#define GTK_TYPE_LIST_ITEM_MANAGER         (gtk_list_item_manager_get_type ())
#define GTK_LIST_ITEM_MANAGER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_LIST_ITEM_MANAGER, GtkListItemManager))
#define GTK_LIST_ITEM_MANAGER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_LIST_ITEM_MANAGER, GtkListItemManagerClass))
#define GTK_IS_LIST_ITEM_MANAGER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_LIST_ITEM_MANAGER))
#define GTK_IS_LIST_ITEM_MANAGER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_LIST_ITEM_MANAGER))
#define GTK_LIST_ITEM_MANAGER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_LIST_ITEM_MANAGER, GtkListItemManagerClass))

typedef struct _GtkListItemManager GtkListItemManager;
typedef struct _GtkListItemManagerClass GtkListItemManagerClass;
typedef struct _GtkListTile GtkListTile;
typedef struct _GtkListTileAugment GtkListTileAugment;
typedef struct _GtkListItemTracker GtkListItemTracker;

typedef enum
{
  GTK_LIST_TILE_ITEM,
  GTK_LIST_TILE_HEADER,
  GTK_LIST_TILE_FOOTER,
  GTK_LIST_TILE_UNMATCHED_HEADER,
  GTK_LIST_TILE_UNMATCHED_FOOTER,
  GTK_LIST_TILE_REMOVED,
} GtkListTileType;

struct _GtkListTile
{
  GtkListTileType type;
  GtkWidget *widget;
  guint n_items;
  /* area occupied by tile. May be empty if tile has no allcoation */
  cairo_rectangle_int_t area;
};

struct _GtkListTileAugment
{
  guint n_items;

  guint has_header :1;
  guint has_footer :1;

  /* union of all areas of tile and children */
  cairo_rectangle_int_t area;
};


GType                   gtk_list_item_manager_get_type          (void) G_GNUC_CONST;

GtkListItemManager *    gtk_list_item_manager_new               (GtkWidget              *widget,
                                                                 GtkListTile *           (* split_func) (GtkWidget *, GtkListTile *, guint),
                                                                 GtkListItemBase *       (* create_widget) (GtkWidget *),
                                                                 void                    (* prepare_section) (GtkWidget *, GtkListTile *, guint),
                                                                 GtkListHeaderBase *     (* create_header_widget) (GtkWidget *));

void                    gtk_list_item_manager_get_tile_bounds   (GtkListItemManager     *self,
                                                                 GdkRectangle           *out_bounds);
gpointer                gtk_list_item_manager_get_root          (GtkListItemManager     *self);
gpointer                gtk_list_item_manager_get_first         (GtkListItemManager     *self);
gpointer                gtk_list_item_manager_get_last          (GtkListItemManager     *self);
gpointer                gtk_list_item_manager_get_nth           (GtkListItemManager     *self,
                                                                 guint                   position,
                                                                 guint                  *offset);
GtkListTile *           gtk_list_item_manager_get_nearest_tile  (GtkListItemManager     *self,
                                                                 int                     x,
                                                                 int                     y);

static inline gboolean
gtk_list_tile_is_header (GtkListTile *tile)
{
  return tile->type == GTK_LIST_TILE_HEADER || tile->type == GTK_LIST_TILE_UNMATCHED_HEADER;
}

static inline gboolean
gtk_list_tile_is_footer (GtkListTile *tile)
{
  return tile->type == GTK_LIST_TILE_FOOTER || tile->type == GTK_LIST_TILE_UNMATCHED_FOOTER;
}

guint                   gtk_list_tile_get_position              (GtkListItemManager     *self,
                                                                 GtkListTile            *tile);
gpointer                gtk_list_tile_get_augment               (GtkListItemManager     *self,
                                                                 GtkListTile            *tile);
void                    gtk_list_tile_set_area                  (GtkListItemManager     *self,
                                                                 GtkListTile            *tile,
                                                                 const cairo_rectangle_int_t *area);
void                    gtk_list_tile_set_area_position         (GtkListItemManager     *self,
                                                                 GtkListTile            *tile,
                                                                 int                     x,
                                                                 int                     y);
void                    gtk_list_tile_set_area_size             (GtkListItemManager     *self,
                                                                 GtkListTile            *tile,
                                                                 int                     width,
                                                                 int                     height);

GtkListTile *           gtk_list_tile_split                     (GtkListItemManager     *self,
                                                                 GtkListTile            *tile,
                                                                 guint                   n_items);
GtkListTile *           gtk_list_tile_gc                        (GtkListItemManager     *self,
                                                                 GtkListTile            *tile);

void                    gtk_list_item_manager_set_model         (GtkListItemManager     *self,
                                                                 GtkSelectionModel      *model);
GtkSelectionModel *     gtk_list_item_manager_get_model         (GtkListItemManager     *self);
void                    gtk_list_item_manager_set_has_sections  (GtkListItemManager     *self,
                                                                 gboolean                has_sections);
gboolean                gtk_list_item_manager_get_has_sections  (GtkListItemManager     *self);

GtkListItemTracker *    gtk_list_item_tracker_new               (GtkListItemManager     *self);
void                    gtk_list_item_tracker_free              (GtkListItemManager     *self,
                                                                 GtkListItemTracker     *tracker);
void                    gtk_list_item_tracker_set_position      (GtkListItemManager     *self,
                                                                 GtkListItemTracker     *tracker,
                                                                 guint                   position,
                                                                 guint                   n_before,
                                                                 guint                   n_after);
guint                   gtk_list_item_tracker_get_position      (GtkListItemManager     *self,
                                                                 GtkListItemTracker     *tracker);


G_END_DECLS