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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::TreeIter;
use crate::TreeModelFlags;
use crate::TreePath;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// Use [`gio::ListModel`][crate::gio::ListModel] instead
    /// The tree interface used by GtkTreeView
    ///
    /// The [`TreeModel`][crate::TreeModel] interface defines a generic tree interface for
    /// use by the [`TreeView`][crate::TreeView] widget. It is an abstract interface, and
    /// is designed to be usable with any appropriate data structure. The
    /// programmer just has to implement this interface on their own data
    /// type for it to be viewable by a [`TreeView`][crate::TreeView] widget.
    ///
    /// The model is represented as a hierarchical tree of strongly-typed,
    /// columned data. In other words, the model can be seen as a tree where
    /// every node has different values depending on which column is being
    /// queried. The type of data found in a column is determined by using
    /// the GType system (ie. `G_TYPE_INT`, `GTK_TYPE_BUTTON`, `G_TYPE_POINTER`,
    /// etc). The types are homogeneous per column across all nodes. It is
    /// important to note that this interface only provides a way of examining
    /// a model and observing changes. The implementation of each individual
    /// model decides how and if changes are made.
    ///
    /// In order to make life simpler for programmers who do not need to
    /// write their own specialized model, two generic models are provided
    /// — the [`TreeStore`][crate::TreeStore] and the [`ListStore`][crate::ListStore]. To use these, the
    /// developer simply pushes data into these models as necessary. These
    /// models provide the data structure as well as all appropriate tree
    /// interfaces. As a result, implementing drag and drop, sorting, and
    /// storing data is trivial. For the vast majority of trees and lists,
    /// these two models are sufficient.
    ///
    /// Models are accessed on a node/column level of granularity. One can
    /// query for the value of a model at a certain node and a certain
    /// column on that node. There are two structures used to reference a
    /// particular node in a model. They are the [`TreePath`][crate::TreePath] and
    /// the [`TreeIter`][crate::TreeIter] (“iter” is short for iterator). Most of the
    /// interface consists of operations on a [`TreeIter`][crate::TreeIter].
    ///
    /// A path is essentially a potential node. It is a location on a model
    /// that may or may not actually correspond to a node on a specific
    /// model. A [`TreePath`][crate::TreePath] can be converted into either an
    /// array of unsigned integers or a string. The string form is a list
    /// of numbers separated by a colon. Each number refers to the offset
    /// at that level. Thus, the path `0` refers to the root
    /// node and the path `2:4` refers to the fifth child of
    /// the third node.
    ///
    /// By contrast, a [`TreeIter`][crate::TreeIter] is a reference to a specific node on
    /// a specific model. It is a generic struct with an integer and three
    /// generic pointers. These are filled in by the model in a model-specific
    /// way. One can convert a path to an iterator by calling
    /// gtk_tree_model_get_iter(). These iterators are the primary way
    /// of accessing a model and are similar to the iterators used by
    /// [`TextBuffer`][crate::TextBuffer]. They are generally statically allocated on the
    /// stack and only used for a short time. The model interface defines
    /// a set of operations using them for navigating the model.
    ///
    /// It is expected that models fill in the iterator with private data.
    /// For example, the [`ListStore`][crate::ListStore] model, which is internally a simple
    /// linked list, stores a list node in one of the pointers. The
    /// [`TreeModel`][crate::TreeModel]Sort stores an array and an offset in two of the
    /// pointers. Additionally, there is an integer field. This field is
    /// generally filled with a unique stamp per model. This stamp is for
    /// catching errors resulting from using invalid iterators with a model.
    ///
    /// The lifecycle of an iterator can be a little confusing at first.
    /// Iterators are expected to always be valid for as long as the model
    /// is unchanged (and doesn’t emit a signal). The model is considered
    /// to own all outstanding iterators and nothing needs to be done to
    /// free them from the user’s point of view. Additionally, some models
    /// guarantee that an iterator is valid for as long as the node it refers
    /// to is valid (most notably the [`TreeStore`][crate::TreeStore] and [`ListStore`][crate::ListStore]).
    /// Although generally uninteresting, as one always has to allow for
    /// the case where iterators do not persist beyond a signal, some very
    /// important performance enhancements were made in the sort model.
    /// As a result, the [`TreeModelFlags::ITERS_PERSIST`][crate::TreeModelFlags::ITERS_PERSIST] flag was added to
    /// indicate this behavior.
    ///
    /// To help show some common operation of a model, some examples are
    /// provided. The first example shows three ways of getting the iter at
    /// the location `3:2:5`. While the first method shown is
    /// easier, the second is much more common, as you often get paths from
    /// callbacks.
    ///
    /// ## Acquiring a [`TreeIter`][crate::TreeIter]
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// // Three ways of getting the iter pointing to the location
    /// GtkTreePath *path;
    /// GtkTreeIter iter;
    /// GtkTreeIter parent_iter;
    ///
    /// // get the iterator from a string
    /// gtk_tree_model_get_iter_from_string (model,
    ///                                      &iter,
    ///                                      "3:2:5");
    ///
    /// // get the iterator from a path
    /// path = gtk_tree_path_new_from_string ("3:2:5");
    /// gtk_tree_model_get_iter (model, &iter, path);
    /// gtk_tree_path_free (path);
    ///
    /// // walk the tree to find the iterator
    /// gtk_tree_model_iter_nth_child (model, &iter,
    ///                                NULL, 3);
    /// parent_iter = iter;
    /// gtk_tree_model_iter_nth_child (model, &iter,
    ///                                &parent_iter, 2);
    /// parent_iter = iter;
    /// gtk_tree_model_iter_nth_child (model, &iter,
    ///                                &parent_iter, 5);
    /// ```
    ///
    /// This second example shows a quick way of iterating through a list
    /// and getting a string and an integer from each row. The
    /// populate_model() function used below is not
    /// shown, as it is specific to the [`ListStore`][crate::ListStore]. For information on
    /// how to write such a function, see the [`ListStore`][crate::ListStore] documentation.
    ///
    /// ## Reading data from a [`TreeModel`][crate::TreeModel]
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// enum
    /// {
    ///   STRING_COLUMN,
    ///   INT_COLUMN,
    ///   N_COLUMNS
    /// };
    ///
    /// ...
    ///
    /// GtkTreeModel *list_store;
    /// GtkTreeIter iter;
    /// gboolean valid;
    /// int row_count = 0;
    ///
    /// // make a new list_store
    /// list_store = gtk_list_store_new (N_COLUMNS,
    ///                                  G_TYPE_STRING,
    ///                                  G_TYPE_INT);
    ///
    /// // Fill the list store with data
    /// populate_model (list_store);
    ///
    /// // Get the first iter in the list, check it is valid and walk
    /// // through the list, reading each row.
    ///
    /// valid = gtk_tree_model_get_iter_first (list_store,
    ///                                        &iter);
    /// while (valid)
    ///  {
    ///    char *str_data;
    ///    int    int_data;
    ///
    ///    // Make sure you terminate calls to gtk_tree_model_get() with a “-1” value
    ///    gtk_tree_model_get (list_store, &iter,
    ///                        STRING_COLUMN, &str_data,
    ///                        INT_COLUMN, &int_data,
    ///                        -1);
    ///
    ///    // Do something with the data
    ///    g_print ("Row %d: (%s,%d)\n",
    ///             row_count, str_data, int_data);
    ///    g_free (str_data);
    ///
    ///    valid = gtk_tree_model_iter_next (list_store,
    ///                                      &iter);
    ///    row_count++;
    ///  }
    /// ```
    ///
    /// The [`TreeModel`][crate::TreeModel] interface contains two methods for reference
    /// counting: gtk_tree_model_ref_node() and gtk_tree_model_unref_node().
    /// These two methods are optional to implement. The reference counting
    /// is meant as a way for views to let models know when nodes are being
    /// displayed. [`TreeView`][crate::TreeView] will take a reference on a node when it is
    /// visible, which means the node is either in the toplevel or expanded.
    /// Being displayed does not mean that the node is currently directly
    /// visible to the user in the viewport. Based on this reference counting
    /// scheme a caching model, for example, can decide whether or not to cache
    /// a node based on the reference count. A file-system based model would
    /// not want to keep the entire file hierarchy in memory, but just the
    /// folders that are currently expanded in every current view.
    ///
    /// When working with reference counting, the following rules must be taken
    /// into account:
    ///
    /// - Never take a reference on a node without owning a reference on its parent.
    ///   This means that all parent nodes of a referenced node must be referenced
    ///   as well.
    ///
    /// - Outstanding references on a deleted node are not released. This is not
    ///   possible because the node has already been deleted by the time the
    ///   row-deleted signal is received.
    ///
    /// - Models are not obligated to emit a signal on rows of which none of its
    ///   siblings are referenced. To phrase this differently, signals are only
    ///   required for levels in which nodes are referenced. For the root level
    ///   however, signals must be emitted at all times (however the root level
    ///   is always referenced when any view is attached).
    ///
    /// # Implements
    ///
    /// [`TreeModelExt`][trait@crate::prelude::TreeModelExt], [`TreeModelExtManual`][trait@crate::prelude::TreeModelExtManual]
    #[doc(alias = "GtkTreeModel")]
    pub struct TreeModel(Interface<ffi::GtkTreeModel, ffi::GtkTreeModelIface>);

    match fn {
        type_ => || ffi::gtk_tree_model_get_type(),
    }
}

impl TreeModel {
    pub const NONE: Option<&'static TreeModel> = None;
}

/// Trait containing all [`struct@TreeModel`] methods.
///
/// # Implementors
///
/// [`ListStore`][struct@crate::ListStore], [`TreeModelFilter`][struct@crate::TreeModelFilter], [`TreeModelSort`][struct@crate::TreeModelSort], [`TreeModel`][struct@crate::TreeModel], [`TreeSortable`][struct@crate::TreeSortable], [`TreeStore`][struct@crate::TreeStore]
pub trait TreeModelExt: 'static {
    /// Calls @func on each node in model in a depth-first fashion.
    ///
    /// If @func returns [`true`], then the tree ceases to be walked,
    /// and gtk_tree_model_foreach() returns.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `func`
    /// a function to be called on each row
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_foreach")]
    fn foreach<P: FnMut(&TreeModel, &TreePath, &TreeIter) -> bool>(&self, func: P);

    /// Returns the type of the column.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `index_`
    /// the column index
    ///
    /// # Returns
    ///
    /// the type of the column
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_column_type")]
    #[doc(alias = "get_column_type")]
    fn column_type(&self, index_: i32) -> glib::types::Type;

    /// Returns a set of flags supported by this interface.
    ///
    /// The flags are a bitwise combination of [`TreeModel`][crate::TreeModel]Flags.
    /// The flags supported should not change during the lifetime
    /// of the @self.
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// the flags supported by this interface
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_flags")]
    #[doc(alias = "get_flags")]
    fn flags(&self) -> TreeModelFlags;

    /// Sets @iter to a valid iterator pointing to @path.
    ///
    /// If @path does not exist, @iter is set to an invalid
    /// iterator and [`false`] is returned.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path`
    /// the [`TreePath`][crate::TreePath]
    ///
    /// # Returns
    ///
    /// [`true`], if @iter was set
    ///
    /// ## `iter`
    /// the uninitialized [`TreeIter`][crate::TreeIter]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_iter")]
    #[doc(alias = "get_iter")]
    fn iter(&self, path: &TreePath) -> Option<TreeIter>;

    /// Initializes @iter with the first iterator in the tree
    /// (the one at the path "0").
    ///
    /// Returns [`false`] if the tree is empty, [`true`] otherwise.
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// [`true`], if @iter was set
    ///
    /// ## `iter`
    /// the uninitialized [`TreeIter`][crate::TreeIter]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_iter_first")]
    #[doc(alias = "get_iter_first")]
    fn iter_first(&self) -> Option<TreeIter>;

    /// Sets @iter to a valid iterator pointing to @path_string, if it
    /// exists.
    ///
    /// Otherwise, @iter is left invalid and [`false`] is returned.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path_string`
    /// a string representation of a [`TreePath`][crate::TreePath]
    ///
    /// # Returns
    ///
    /// [`true`], if @iter was set
    ///
    /// ## `iter`
    /// an uninitialized [`TreeIter`][crate::TreeIter]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_iter_from_string")]
    #[doc(alias = "get_iter_from_string")]
    fn iter_from_string(&self, path_string: &str) -> Option<TreeIter>;

    /// Returns the number of columns supported by @self.
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// the number of columns
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_n_columns")]
    #[doc(alias = "get_n_columns")]
    fn n_columns(&self) -> i32;

    /// Returns a newly-created [`TreePath`][crate::TreePath] referenced by @iter.
    ///
    /// This path should be freed with gtk_tree_path_free().
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// a newly-created [`TreePath`][crate::TreePath]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_path")]
    #[doc(alias = "get_path")]
    fn path(&self, iter: &TreeIter) -> TreePath;

    /// Generates a string representation of the iter.
    ///
    /// This string is a “:” separated list of numbers.
    /// For example, “4:10:0:3” would be an acceptable
    /// return value for this string.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// a [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// a newly-allocated string
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_get_string_from_iter")]
    #[doc(alias = "get_string_from_iter")]
    fn string_from_iter(&self, iter: &TreeIter) -> Option<glib::GString>;

    /// Sets @iter to point to the first child of @parent.
    ///
    /// If @parent has no children, [`false`] is returned and @iter is
    /// set to be invalid. @parent will remain a valid node after this
    /// function has been called.
    ///
    /// If @parent is [`None`] returns the first node, equivalent to
    /// `gtk_tree_model_get_iter_first (tree_model, iter);`
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `parent`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// [`true`], if @iter has been set to the first child
    ///
    /// ## `iter`
    /// the new [`TreeIter`][crate::TreeIter] to be set to the child
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_children")]
    fn iter_children(&self, parent: Option<&TreeIter>) -> Option<TreeIter>;

    /// Returns [`true`] if @iter has children, [`false`] otherwise.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter] to test for children
    ///
    /// # Returns
    ///
    /// [`true`] if @iter has children
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_has_child")]
    fn iter_has_child(&self, iter: &TreeIter) -> bool;

    /// Returns the number of children that @iter has.
    ///
    /// As a special case, if @iter is [`None`], then the number
    /// of toplevel nodes is returned.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// the number of children of @iter
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_n_children")]
    fn iter_n_children(&self, iter: Option<&TreeIter>) -> i32;

    /// Sets @iter to point to the node following it at the current level.
    ///
    /// If there is no next @iter, [`false`] is returned and @iter is set
    /// to be invalid.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// [`true`] if @iter has been changed to the next node
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_next")]
    fn iter_next(&self, iter: &TreeIter) -> bool;

    /// Sets @iter to be the child of @parent, using the given index.
    ///
    /// The first index is 0. If @n is too big, or @parent has no children,
    /// @iter is set to an invalid iterator and [`false`] is returned. @parent
    /// will remain a valid node after this function has been called. As a
    /// special case, if @parent is [`None`], then the @n-th root node
    /// is set.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `parent`
    /// the [`TreeIter`][crate::TreeIter] to get the child from
    /// ## `n`
    /// the index of the desired child
    ///
    /// # Returns
    ///
    /// [`true`], if @parent has an @n-th child
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter] to set to the nth child
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_nth_child")]
    fn iter_nth_child(&self, parent: Option<&TreeIter>, n: i32) -> Option<TreeIter>;

    /// Sets @iter to be the parent of @child.
    ///
    /// If @child is at the toplevel, and doesn’t have a parent, then
    /// @iter is set to an invalid iterator and [`false`] is returned.
    /// @child will remain a valid node after this function has been
    /// called.
    ///
    /// @iter will be initialized before the lookup is performed, so @child
    /// and @iter cannot point to the same memory location.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `child`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// [`true`], if @iter is set to the parent of @child
    ///
    /// ## `iter`
    /// the new [`TreeIter`][crate::TreeIter] to set to the parent
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_parent")]
    fn iter_parent(&self, child: &TreeIter) -> Option<TreeIter>;

    /// Sets @iter to point to the previous node at the current level.
    ///
    /// If there is no previous @iter, [`false`] is returned and @iter is
    /// set to be invalid.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `iter`
    /// the [`TreeIter`][crate::TreeIter]
    ///
    /// # Returns
    ///
    /// [`true`] if @iter has been changed to the previous node
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_iter_previous")]
    fn iter_previous(&self, iter: &TreeIter) -> bool;

    /// Emits the ::row-changed signal on @self.
    ///
    /// See `signal::TreeModel::row-changed`.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] pointing to the changed row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the changed row
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_row_changed")]
    fn row_changed(&self, path: &TreePath, iter: &TreeIter);

    /// Emits the ::row-deleted signal on @self.
    ///
    /// See `signal::TreeModel::row-deleted`.
    ///
    /// This should be called by models after a row has been removed.
    /// The location pointed to by @path should be the location that
    /// the row previously was at. It may not be a valid location anymore.
    ///
    /// Nodes that are deleted are not unreffed, this means that any
    /// outstanding references on the deleted node should not be released.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] pointing to the previous location of
    ///   the deleted row
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_row_deleted")]
    fn row_deleted(&self, path: &TreePath);

    /// Emits the ::row-has-child-toggled signal on @self.
    ///
    /// See `signal::TreeModel::row-has-child-toggled`.
    ///
    /// This should be called by models after the child
    /// state of a node changes.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] pointing to the changed row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the changed row
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_row_has_child_toggled")]
    fn row_has_child_toggled(&self, path: &TreePath, iter: &TreeIter);

    /// Emits the ::row-inserted signal on @self.
    ///
    /// See `signal::TreeModel::row-inserted`.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] pointing to the inserted row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the inserted row
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[doc(alias = "gtk_tree_model_row_inserted")]
    fn row_inserted(&self, path: &TreePath, iter: &TreeIter);

    /// This signal is emitted when a row in the model has changed.
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] identifying the changed row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the changed row
    #[doc(alias = "row-changed")]
    fn connect_row_changed<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    /// This signal is emitted when a row has been deleted.
    ///
    /// Note that no iterator is passed to the signal handler,
    /// since the row is already deleted.
    ///
    /// This should be called by models after a row has been removed.
    /// The location pointed to by @path should be the location that
    /// the row previously was at. It may not be a valid location anymore.
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] identifying the row
    #[doc(alias = "row-deleted")]
    fn connect_row_deleted<F: Fn(&Self, &TreePath) + 'static>(&self, f: F) -> SignalHandlerId;

    /// This signal is emitted when a row has gotten the first child
    /// row or lost its last child row.
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] identifying the row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the row
    #[doc(alias = "row-has-child-toggled")]
    fn connect_row_has_child_toggled<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    /// This signal is emitted when a new row has been inserted in
    /// the model.
    ///
    /// Note that the row may still be empty at this point, since
    /// it is a common pattern to first insert an empty row, and
    /// then fill it with the desired values.
    /// ## `path`
    /// a [`TreePath`][crate::TreePath] identifying the new row
    /// ## `iter`
    /// a valid [`TreeIter`][crate::TreeIter] pointing to the new row
    #[doc(alias = "row-inserted")]
    fn connect_row_inserted<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    //#[doc(alias = "rows-reordered")]
    //fn connect_rows_reordered<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<TreeModel>> TreeModelExt for O {
    fn foreach<P: FnMut(&TreeModel, &TreePath, &TreeIter) -> bool>(&self, func: P) {
        let func_data: P = func;
        unsafe extern "C" fn func_func<P: FnMut(&TreeModel, &TreePath, &TreeIter) -> bool>(
            model: *mut ffi::GtkTreeModel,
            path: *mut ffi::GtkTreePath,
            iter: *mut ffi::GtkTreeIter,
            data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let model = from_glib_borrow(model);
            let path = from_glib_borrow(path);
            let iter = from_glib_borrow(iter);
            let callback: *mut P = data as *const _ as usize as *mut P;
            let res = (*callback)(&model, &path, &iter);
            res.into_glib()
        }
        let func = Some(func_func::<P> as _);
        let super_callback0: &P = &func_data;
        unsafe {
            ffi::gtk_tree_model_foreach(
                self.as_ref().to_glib_none().0,
                func,
                super_callback0 as *const _ as usize as *mut _,
            );
        }
    }

    fn column_type(&self, index_: i32) -> glib::types::Type {
        unsafe {
            from_glib(ffi::gtk_tree_model_get_column_type(
                self.as_ref().to_glib_none().0,
                index_,
            ))
        }
    }

    fn flags(&self) -> TreeModelFlags {
        unsafe {
            from_glib(ffi::gtk_tree_model_get_flags(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn iter(&self, path: &TreePath) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_get_iter(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
                mut_override(path.to_glib_none().0),
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn iter_first(&self) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_get_iter_first(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn iter_from_string(&self, path_string: &str) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_get_iter_from_string(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
                path_string.to_glib_none().0,
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn n_columns(&self) -> i32 {
        unsafe { ffi::gtk_tree_model_get_n_columns(self.as_ref().to_glib_none().0) }
    }

    fn path(&self, iter: &TreeIter) -> TreePath {
        unsafe {
            from_glib_full(ffi::gtk_tree_model_get_path(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            ))
        }
    }

    fn string_from_iter(&self, iter: &TreeIter) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gtk_tree_model_get_string_from_iter(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            ))
        }
    }

    fn iter_children(&self, parent: Option<&TreeIter>) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_iter_children(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
                mut_override(parent.to_glib_none().0),
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn iter_has_child(&self, iter: &TreeIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_tree_model_iter_has_child(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            ))
        }
    }

    fn iter_n_children(&self, iter: Option<&TreeIter>) -> i32 {
        unsafe {
            ffi::gtk_tree_model_iter_n_children(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            )
        }
    }

    fn iter_next(&self, iter: &TreeIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_tree_model_iter_next(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            ))
        }
    }

    fn iter_nth_child(&self, parent: Option<&TreeIter>, n: i32) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_iter_nth_child(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
                mut_override(parent.to_glib_none().0),
                n,
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn iter_parent(&self, child: &TreeIter) -> Option<TreeIter> {
        unsafe {
            let mut iter = TreeIter::uninitialized();
            let ret = from_glib(ffi::gtk_tree_model_iter_parent(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
                mut_override(child.to_glib_none().0),
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    fn iter_previous(&self, iter: &TreeIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_tree_model_iter_previous(
                self.as_ref().to_glib_none().0,
                mut_override(iter.to_glib_none().0),
            ))
        }
    }

    fn row_changed(&self, path: &TreePath, iter: &TreeIter) {
        unsafe {
            ffi::gtk_tree_model_row_changed(
                self.as_ref().to_glib_none().0,
                mut_override(path.to_glib_none().0),
                mut_override(iter.to_glib_none().0),
            );
        }
    }

    fn row_deleted(&self, path: &TreePath) {
        unsafe {
            ffi::gtk_tree_model_row_deleted(
                self.as_ref().to_glib_none().0,
                mut_override(path.to_glib_none().0),
            );
        }
    }

    fn row_has_child_toggled(&self, path: &TreePath, iter: &TreeIter) {
        unsafe {
            ffi::gtk_tree_model_row_has_child_toggled(
                self.as_ref().to_glib_none().0,
                mut_override(path.to_glib_none().0),
                mut_override(iter.to_glib_none().0),
            );
        }
    }

    fn row_inserted(&self, path: &TreePath, iter: &TreeIter) {
        unsafe {
            ffi::gtk_tree_model_row_inserted(
                self.as_ref().to_glib_none().0,
                mut_override(path.to_glib_none().0),
                mut_override(iter.to_glib_none().0),
            );
        }
    }

    fn connect_row_changed<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn row_changed_trampoline<
            P: IsA<TreeModel>,
            F: Fn(&P, &TreePath, &TreeIter) + 'static,
        >(
            this: *mut ffi::GtkTreeModel,
            path: *mut ffi::GtkTreePath,
            iter: *mut ffi::GtkTreeIter,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                TreeModel::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(path),
                &from_glib_borrow(iter),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"row-changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    row_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_row_deleted<F: Fn(&Self, &TreePath) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn row_deleted_trampoline<
            P: IsA<TreeModel>,
            F: Fn(&P, &TreePath) + 'static,
        >(
            this: *mut ffi::GtkTreeModel,
            path: *mut ffi::GtkTreePath,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                TreeModel::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(path),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"row-deleted\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    row_deleted_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_row_has_child_toggled<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn row_has_child_toggled_trampoline<
            P: IsA<TreeModel>,
            F: Fn(&P, &TreePath, &TreeIter) + 'static,
        >(
            this: *mut ffi::GtkTreeModel,
            path: *mut ffi::GtkTreePath,
            iter: *mut ffi::GtkTreeIter,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                TreeModel::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(path),
                &from_glib_borrow(iter),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"row-has-child-toggled\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    row_has_child_toggled_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_row_inserted<F: Fn(&Self, &TreePath, &TreeIter) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn row_inserted_trampoline<
            P: IsA<TreeModel>,
            F: Fn(&P, &TreePath, &TreeIter) + 'static,
        >(
            this: *mut ffi::GtkTreeModel,
            path: *mut ffi::GtkTreePath,
            iter: *mut ffi::GtkTreeIter,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                TreeModel::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(path),
                &from_glib_borrow(iter),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"row-inserted\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    row_inserted_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    //fn connect_rows_reordered<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId {
    //    Unimplemented new_order: *.Pointer
    //}
}

impl fmt::Display for TreeModel {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("TreeModel")
    }
}