1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gtk.TreeModelT; 26 27 public import glib.MemorySlice; 28 public import glib.Str; 29 public import gobject.ObjectG; 30 public import gobject.Signals; 31 public import gobject.Value; 32 public import gtk.TreeIter; 33 public import gtk.TreePath; 34 public import gtk.c.functions; 35 public import gtk.c.types; 36 public import gtkc.gtktypes; 37 public import std.algorithm; 38 39 40 /** 41 * The #GtkTreeModel interface defines a generic tree interface for 42 * use by the #GtkTreeView widget. It is an abstract interface, and 43 * is designed to be usable with any appropriate data structure. The 44 * programmer just has to implement this interface on their own data 45 * type for it to be viewable by a #GtkTreeView widget. 46 * 47 * The model is represented as a hierarchical tree of strongly-typed, 48 * columned data. In other words, the model can be seen as a tree where 49 * every node has different values depending on which column is being 50 * queried. The type of data found in a column is determined by using 51 * the GType system (ie. #G_TYPE_INT, #GTK_TYPE_BUTTON, #G_TYPE_POINTER, 52 * etc). The types are homogeneous per column across all nodes. It is 53 * important to note that this interface only provides a way of examining 54 * a model and observing changes. The implementation of each individual 55 * model decides how and if changes are made. 56 * 57 * In order to make life simpler for programmers who do not need to 58 * write their own specialized model, two generic models are provided 59 * — the #GtkTreeStore and the #GtkListStore. To use these, the 60 * developer simply pushes data into these models as necessary. These 61 * models provide the data structure as well as all appropriate tree 62 * interfaces. As a result, implementing drag and drop, sorting, and 63 * storing data is trivial. For the vast majority of trees and lists, 64 * these two models are sufficient. 65 * 66 * Models are accessed on a node/column level of granularity. One can 67 * query for the value of a model at a certain node and a certain 68 * column on that node. There are two structures used to reference a 69 * particular node in a model. They are the #GtkTreePath-struct and 70 * the #GtkTreeIter-struct (“iter” is short for iterator). Most of the 71 * interface consists of operations on a #GtkTreeIter-struct. 72 * 73 * A path is essentially a potential node. It is a location on a model 74 * that may or may not actually correspond to a node on a specific 75 * model. The #GtkTreePath-struct can be converted into either an 76 * array of unsigned integers or a string. The string form is a list 77 * of numbers separated by a colon. Each number refers to the offset 78 * at that level. Thus, the path `0` refers to the root 79 * node and the path `2:4` refers to the fifth child of 80 * the third node. 81 * 82 * By contrast, a #GtkTreeIter-struct is a reference to a specific node on 83 * a specific model. It is a generic struct with an integer and three 84 * generic pointers. These are filled in by the model in a model-specific 85 * way. One can convert a path to an iterator by calling 86 * gtk_tree_model_get_iter(). These iterators are the primary way 87 * of accessing a model and are similar to the iterators used by 88 * #GtkTextBuffer. They are generally statically allocated on the 89 * stack and only used for a short time. The model interface defines 90 * a set of operations using them for navigating the model. 91 * 92 * It is expected that models fill in the iterator with private data. 93 * For example, the #GtkListStore model, which is internally a simple 94 * linked list, stores a list node in one of the pointers. The 95 * #GtkTreeModelSort stores an array and an offset in two of the 96 * pointers. Additionally, there is an integer field. This field is 97 * generally filled with a unique stamp per model. This stamp is for 98 * catching errors resulting from using invalid iterators with a model. 99 * 100 * The lifecycle of an iterator can be a little confusing at first. 101 * Iterators are expected to always be valid for as long as the model 102 * is unchanged (and doesn’t emit a signal). The model is considered 103 * to own all outstanding iterators and nothing needs to be done to 104 * free them from the user’s point of view. Additionally, some models 105 * guarantee that an iterator is valid for as long as the node it refers 106 * to is valid (most notably the #GtkTreeStore and #GtkListStore). 107 * Although generally uninteresting, as one always has to allow for 108 * the case where iterators do not persist beyond a signal, some very 109 * important performance enhancements were made in the sort model. 110 * As a result, the #GTK_TREE_MODEL_ITERS_PERSIST flag was added to 111 * indicate this behavior. 112 * 113 * To help show some common operation of a model, some examples are 114 * provided. The first example shows three ways of getting the iter at 115 * the location `3:2:5`. While the first method shown is 116 * easier, the second is much more common, as you often get paths from 117 * callbacks. 118 * 119 * ## Acquiring a #GtkTreeIter-struct 120 * 121 * |[<!-- language="C" --> 122 * // Three ways of getting the iter pointing to the location 123 * GtkTreePath *path; 124 * GtkTreeIter iter; 125 * GtkTreeIter parent_iter; 126 * 127 * // get the iterator from a string 128 * gtk_tree_model_get_iter_from_string (model, 129 * &iter, 130 * "3:2:5"); 131 * 132 * // get the iterator from a path 133 * path = gtk_tree_path_new_from_string ("3:2:5"); 134 * gtk_tree_model_get_iter (model, &iter, path); 135 * gtk_tree_path_free (path); 136 * 137 * // walk the tree to find the iterator 138 * gtk_tree_model_iter_nth_child (model, &iter, 139 * NULL, 3); 140 * parent_iter = iter; 141 * gtk_tree_model_iter_nth_child (model, &iter, 142 * &parent_iter, 2); 143 * parent_iter = iter; 144 * gtk_tree_model_iter_nth_child (model, &iter, 145 * &parent_iter, 5); 146 * ]| 147 * 148 * This second example shows a quick way of iterating through a list 149 * and getting a string and an integer from each row. The 150 * populate_model() function used below is not 151 * shown, as it is specific to the #GtkListStore. For information on 152 * how to write such a function, see the #GtkListStore documentation. 153 * 154 * ## Reading data from a #GtkTreeModel 155 * 156 * |[<!-- language="C" --> 157 * enum 158 * { 159 * STRING_COLUMN, 160 * INT_COLUMN, 161 * N_COLUMNS 162 * }; 163 * 164 * ... 165 * 166 * GtkTreeModel *list_store; 167 * GtkTreeIter iter; 168 * gboolean valid; 169 * gint row_count = 0; 170 * 171 * // make a new list_store 172 * list_store = gtk_list_store_new (N_COLUMNS, 173 * G_TYPE_STRING, 174 * G_TYPE_INT); 175 * 176 * // Fill the list store with data 177 * populate_model (list_store); 178 * 179 * // Get the first iter in the list, check it is valid and walk 180 * // through the list, reading each row. 181 * 182 * valid = gtk_tree_model_get_iter_first (list_store, 183 * &iter); 184 * while (valid) 185 * { 186 * gchar *str_data; 187 * gint int_data; 188 * 189 * // Make sure you terminate calls to gtk_tree_model_get() with a “-1” value 190 * gtk_tree_model_get (list_store, &iter, 191 * STRING_COLUMN, &str_data, 192 * INT_COLUMN, &int_data, 193 * -1); 194 * 195 * // Do something with the data 196 * g_print ("Row %d: (%s,%d)\n", 197 * row_count, str_data, int_data); 198 * g_free (str_data); 199 * 200 * valid = gtk_tree_model_iter_next (list_store, 201 * &iter); 202 * row_count++; 203 * } 204 * ]| 205 * 206 * The #GtkTreeModel interface contains two methods for reference 207 * counting: gtk_tree_model_ref_node() and gtk_tree_model_unref_node(). 208 * These two methods are optional to implement. The reference counting 209 * is meant as a way for views to let models know when nodes are being 210 * displayed. #GtkTreeView will take a reference on a node when it is 211 * visible, which means the node is either in the toplevel or expanded. 212 * Being displayed does not mean that the node is currently directly 213 * visible to the user in the viewport. Based on this reference counting 214 * scheme a caching model, for example, can decide whether or not to cache 215 * a node based on the reference count. A file-system based model would 216 * not want to keep the entire file hierarchy in memory, but just the 217 * folders that are currently expanded in every current view. 218 * 219 * When working with reference counting, the following rules must be taken 220 * into account: 221 * 222 * - Never take a reference on a node without owning a reference on its parent. 223 * This means that all parent nodes of a referenced node must be referenced 224 * as well. 225 * 226 * - Outstanding references on a deleted node are not released. This is not 227 * possible because the node has already been deleted by the time the 228 * row-deleted signal is received. 229 * 230 * - Models are not obligated to emit a signal on rows of which none of its 231 * siblings are referenced. To phrase this differently, signals are only 232 * required for levels in which nodes are referenced. For the root level 233 * however, signals must be emitted at all times (however the root level 234 * is always referenced when any view is attached). 235 */ 236 public template TreeModelT(TStruct) 237 { 238 /** Get the main Gtk struct */ 239 public GtkTreeModel* getTreeModelStruct(bool transferOwnership = false) 240 { 241 if (transferOwnership) 242 ownedRef = false; 243 return cast(GtkTreeModel*)getStruct(); 244 } 245 246 /** 247 * Get the value of a column as a char array. 248 * this is the same calling getValue and get the string from the value object 249 */ 250 string getValueString(TreeIter iter, int column) 251 { 252 Value value = getValue(iter, column); 253 return value.getString(); 254 } 255 256 /** 257 * Get the value of a column as a char array. 258 * this is the same calling getValue and get the int from the value object 259 */ 260 int getValueInt(TreeIter iter, int column) 261 { 262 Value value = getValue(iter, column); 263 return value.getInt(); 264 } 265 266 /** 267 * Sets iter to a valid iterator pointing to path. 268 * Params: 269 * iter = The uninitialized GtkTreeIter. 270 * path = The GtkTreePath. 271 * Returns: 272 * TRUE, if iter was set. 273 */ 274 public int getIter(TreeIter iter, TreePath path) 275 { 276 iter.setModel(this); 277 return gtk_tree_model_get_iter( 278 getTreeModelStruct(), 279 (iter is null) ? null : iter.getTreeIterStruct(), 280 (path is null) ? null : path.getTreePathStruct()); 281 } 282 283 /** 284 * Initializes and sets value to that at column. 285 * When done with value, g_value_unset() needs to be called 286 * to free any allocated memory. 287 * Params: 288 * iter = The GtkTreeIter. 289 * column = The column to lookup the value at. 290 * value = (inout) (transfer none) An empty GValue to set. 291 */ 292 public Value getValue(TreeIter iter, int column, Value value = null) 293 { 294 if ( value is null ) 295 value = new Value(); 296 297 gtk_tree_model_get_value(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct(), column, (value is null) ? null : value.getValueStruct()); 298 299 return value; 300 } 301 302 /** 303 */ 304 305 alias foreac = foreach_; 306 /** 307 * Calls func on each node in model in a depth-first fashion. 308 * 309 * If @func returns %TRUE, then the tree ceases to be walked, 310 * and gtk_tree_model_foreach() returns. 311 * 312 * Params: 313 * func = a function to be called on each row 314 * userData = user data to passed to @func 315 */ 316 public void foreach_(GtkTreeModelForeachFunc func, void* userData) 317 { 318 gtk_tree_model_foreach(getTreeModelStruct(), func, userData); 319 } 320 321 /** 322 * Returns the type of the column. 323 * 324 * Params: 325 * index = the column index 326 * 327 * Returns: the type of the column 328 */ 329 public GType getColumnType(int index) 330 { 331 return gtk_tree_model_get_column_type(getTreeModelStruct(), index); 332 } 333 334 /** 335 * Returns a set of flags supported by this interface. 336 * 337 * The flags are a bitwise combination of #GtkTreeModelFlags. 338 * The flags supported should not change during the lifetime 339 * of the @tree_model. 340 * 341 * Returns: the flags supported by this interface 342 */ 343 public GtkTreeModelFlags getFlags() 344 { 345 return gtk_tree_model_get_flags(getTreeModelStruct()); 346 } 347 348 /** 349 * Initializes @iter with the first iterator in the tree 350 * (the one at the path "0") and returns %TRUE. Returns 351 * %FALSE if the tree is empty. 352 * 353 * Params: 354 * iter = the uninitialized #GtkTreeIter-struct 355 * 356 * Returns: %TRUE, if @iter was set 357 */ 358 public bool getIterFirst(out TreeIter iter) 359 { 360 GtkTreeIter* outiter = sliceNew!GtkTreeIter(); 361 362 auto p = gtk_tree_model_get_iter_first(getTreeModelStruct(), outiter) != 0; 363 364 iter = ObjectG.getDObject!(TreeIter)(outiter, true); 365 366 return p; 367 } 368 369 /** 370 * Sets @iter to a valid iterator pointing to @path_string, if it 371 * exists. Otherwise, @iter is left invalid and %FALSE is returned. 372 * 373 * Params: 374 * iter = an uninitialized #GtkTreeIter-struct 375 * pathString = a string representation of a #GtkTreePath-struct 376 * 377 * Returns: %TRUE, if @iter was set 378 */ 379 public bool getIterFromString(out TreeIter iter, string pathString) 380 { 381 GtkTreeIter* outiter = sliceNew!GtkTreeIter(); 382 383 auto p = gtk_tree_model_get_iter_from_string(getTreeModelStruct(), outiter, Str.toStringz(pathString)) != 0; 384 385 iter = ObjectG.getDObject!(TreeIter)(outiter, true); 386 387 return p; 388 } 389 390 /** 391 * Returns the number of columns supported by @tree_model. 392 * 393 * Returns: the number of columns 394 */ 395 public int getNColumns() 396 { 397 return gtk_tree_model_get_n_columns(getTreeModelStruct()); 398 } 399 400 /** 401 * Returns a newly-created #GtkTreePath-struct referenced by @iter. 402 * 403 * This path should be freed with gtk_tree_path_free(). 404 * 405 * Params: 406 * iter = the #GtkTreeIter-struct 407 * 408 * Returns: a newly-created #GtkTreePath-struct 409 */ 410 public TreePath getPath(TreeIter iter) 411 { 412 auto p = gtk_tree_model_get_path(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 413 414 if(p is null) 415 { 416 return null; 417 } 418 419 return ObjectG.getDObject!(TreePath)(cast(GtkTreePath*) p, true); 420 } 421 422 /** 423 * Generates a string representation of the iter. 424 * 425 * This string is a “:” separated list of numbers. 426 * For example, “4:10:0:3” would be an acceptable 427 * return value for this string. 428 * 429 * Params: 430 * iter = a #GtkTreeIter-struct 431 * 432 * Returns: a newly-allocated string. 433 * Must be freed with g_free(). 434 * 435 * Since: 2.2 436 */ 437 public string getStringFromIter(TreeIter iter) 438 { 439 auto retStr = gtk_tree_model_get_string_from_iter(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 440 441 scope(exit) Str.freeString(retStr); 442 return Str.toString(retStr); 443 } 444 445 /** 446 * See gtk_tree_model_get(), this version takes a va_list 447 * for language bindings to use. 448 * 449 * Params: 450 * iter = a row in @tree_model 451 * varArgs = va_list of column/return location pairs 452 */ 453 public void getValist(TreeIter iter, void* varArgs) 454 { 455 gtk_tree_model_get_valist(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct(), varArgs); 456 } 457 458 /** 459 * Sets @iter to point to the first child of @parent. 460 * 461 * If @parent has no children, %FALSE is returned and @iter is 462 * set to be invalid. @parent will remain a valid node after this 463 * function has been called. 464 * 465 * If @parent is %NULL returns the first node, equivalent to 466 * `gtk_tree_model_get_iter_first (tree_model, iter);` 467 * 468 * Params: 469 * iter = the new #GtkTreeIter-struct to be set to the child 470 * parent = the #GtkTreeIter-struct, or %NULL 471 * 472 * Returns: %TRUE, if @iter has been set to the first child 473 */ 474 public bool iterChildren(out TreeIter iter, TreeIter parent) 475 { 476 GtkTreeIter* outiter = sliceNew!GtkTreeIter(); 477 478 auto p = gtk_tree_model_iter_children(getTreeModelStruct(), outiter, (parent is null) ? null : parent.getTreeIterStruct()) != 0; 479 480 iter = ObjectG.getDObject!(TreeIter)(outiter, true); 481 482 return p; 483 } 484 485 /** 486 * Returns %TRUE if @iter has children, %FALSE otherwise. 487 * 488 * Params: 489 * iter = the #GtkTreeIter-struct to test for children 490 * 491 * Returns: %TRUE if @iter has children 492 */ 493 public bool iterHasChild(TreeIter iter) 494 { 495 return gtk_tree_model_iter_has_child(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()) != 0; 496 } 497 498 /** 499 * Returns the number of children that @iter has. 500 * 501 * As a special case, if @iter is %NULL, then the number 502 * of toplevel nodes is returned. 503 * 504 * Params: 505 * iter = the #GtkTreeIter-struct, or %NULL 506 * 507 * Returns: the number of children of @iter 508 */ 509 public int iterNChildren(TreeIter iter) 510 { 511 return gtk_tree_model_iter_n_children(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 512 } 513 514 /** 515 * Sets @iter to point to the node following it at the current level. 516 * 517 * If there is no next @iter, %FALSE is returned and @iter is set 518 * to be invalid. 519 * 520 * Params: 521 * iter = the #GtkTreeIter-struct 522 * 523 * Returns: %TRUE if @iter has been changed to the next node 524 */ 525 public bool iterNext(TreeIter iter) 526 { 527 return gtk_tree_model_iter_next(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()) != 0; 528 } 529 530 /** 531 * Sets @iter to be the child of @parent, using the given index. 532 * 533 * The first index is 0. If @n is too big, or @parent has no children, 534 * @iter is set to an invalid iterator and %FALSE is returned. @parent 535 * will remain a valid node after this function has been called. As a 536 * special case, if @parent is %NULL, then the @n-th root node 537 * is set. 538 * 539 * Params: 540 * iter = the #GtkTreeIter-struct to set to the nth child 541 * parent = the #GtkTreeIter-struct to get the child from, or %NULL. 542 * n = the index of the desired child 543 * 544 * Returns: %TRUE, if @parent has an @n-th child 545 */ 546 public bool iterNthChild(out TreeIter iter, TreeIter parent, int n) 547 { 548 GtkTreeIter* outiter = sliceNew!GtkTreeIter(); 549 550 auto p = gtk_tree_model_iter_nth_child(getTreeModelStruct(), outiter, (parent is null) ? null : parent.getTreeIterStruct(), n) != 0; 551 552 iter = ObjectG.getDObject!(TreeIter)(outiter, true); 553 554 return p; 555 } 556 557 /** 558 * Sets @iter to be the parent of @child. 559 * 560 * If @child is at the toplevel, and doesn’t have a parent, then 561 * @iter is set to an invalid iterator and %FALSE is returned. 562 * @child will remain a valid node after this function has been 563 * called. 564 * 565 * @iter will be initialized before the lookup is performed, so @child 566 * and @iter cannot point to the same memory location. 567 * 568 * Params: 569 * iter = the new #GtkTreeIter-struct to set to the parent 570 * child = the #GtkTreeIter-struct 571 * 572 * Returns: %TRUE, if @iter is set to the parent of @child 573 */ 574 public bool iterParent(out TreeIter iter, TreeIter child) 575 { 576 GtkTreeIter* outiter = sliceNew!GtkTreeIter(); 577 578 auto p = gtk_tree_model_iter_parent(getTreeModelStruct(), outiter, (child is null) ? null : child.getTreeIterStruct()) != 0; 579 580 iter = ObjectG.getDObject!(TreeIter)(outiter, true); 581 582 return p; 583 } 584 585 /** 586 * Sets @iter to point to the previous node at the current level. 587 * 588 * If there is no previous @iter, %FALSE is returned and @iter is 589 * set to be invalid. 590 * 591 * Params: 592 * iter = the #GtkTreeIter-struct 593 * 594 * Returns: %TRUE if @iter has been changed to the previous node 595 * 596 * Since: 3.0 597 */ 598 public bool iterPrevious(TreeIter iter) 599 { 600 return gtk_tree_model_iter_previous(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()) != 0; 601 } 602 603 /** 604 * Lets the tree ref the node. 605 * 606 * This is an optional method for models to implement. 607 * To be more specific, models may ignore this call as it exists 608 * primarily for performance reasons. 609 * 610 * This function is primarily meant as a way for views to let 611 * caching models know when nodes are being displayed (and hence, 612 * whether or not to cache that node). Being displayed means a node 613 * is in an expanded branch, regardless of whether the node is currently 614 * visible in the viewport. For example, a file-system based model 615 * would not want to keep the entire file-hierarchy in memory, 616 * just the sections that are currently being displayed by 617 * every current view. 618 * 619 * A model should be expected to be able to get an iter independent 620 * of its reffed state. 621 * 622 * Params: 623 * iter = the #GtkTreeIter-struct 624 */ 625 public void refNode(TreeIter iter) 626 { 627 gtk_tree_model_ref_node(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 628 } 629 630 /** 631 * Emits the #GtkTreeModel::row-changed signal on @tree_model. 632 * 633 * Params: 634 * path = a #GtkTreePath-struct pointing to the changed row 635 * iter = a valid #GtkTreeIter-struct pointing to the changed row 636 */ 637 public void rowChanged(TreePath path, TreeIter iter) 638 { 639 gtk_tree_model_row_changed(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 640 } 641 642 /** 643 * Emits the #GtkTreeModel::row-deleted signal on @tree_model. 644 * 645 * This should be called by models after a row has been removed. 646 * The location pointed to by @path should be the location that 647 * the row previously was at. It may not be a valid location anymore. 648 * 649 * Nodes that are deleted are not unreffed, this means that any 650 * outstanding references on the deleted node should not be released. 651 * 652 * Params: 653 * path = a #GtkTreePath-struct pointing to the previous location of 654 * the deleted row 655 */ 656 public void rowDeleted(TreePath path) 657 { 658 gtk_tree_model_row_deleted(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct()); 659 } 660 661 /** 662 * Emits the #GtkTreeModel::row-has-child-toggled signal on 663 * @tree_model. This should be called by models after the child 664 * state of a node changes. 665 * 666 * Params: 667 * path = a #GtkTreePath-struct pointing to the changed row 668 * iter = a valid #GtkTreeIter-struct pointing to the changed row 669 */ 670 public void rowHasChildToggled(TreePath path, TreeIter iter) 671 { 672 gtk_tree_model_row_has_child_toggled(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 673 } 674 675 /** 676 * Emits the #GtkTreeModel::row-inserted signal on @tree_model. 677 * 678 * Params: 679 * path = a #GtkTreePath-struct pointing to the inserted row 680 * iter = a valid #GtkTreeIter-struct pointing to the inserted row 681 */ 682 public void rowInserted(TreePath path, TreeIter iter) 683 { 684 gtk_tree_model_row_inserted(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 685 } 686 687 /** 688 * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. 689 * 690 * This should be called by models when their rows have been 691 * reordered. 692 * 693 * Params: 694 * path = a #GtkTreePath-struct pointing to the tree node whose children 695 * have been reordered 696 * iter = a valid #GtkTreeIter-struct pointing to the node whose children 697 * have been reordered, or %NULL if the depth of @path is 0 698 * newOrder = an array of integers mapping the current position of 699 * each child to its old position before the re-ordering, 700 * i.e. @new_order`[newpos] = oldpos` 701 */ 702 public void rowsReordered(TreePath path, TreeIter iter, int* newOrder) 703 { 704 gtk_tree_model_rows_reordered(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct(), (iter is null) ? null : iter.getTreeIterStruct(), newOrder); 705 } 706 707 /** 708 * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. 709 * 710 * This should be called by models when their rows have been 711 * reordered. 712 * 713 * Params: 714 * path = a #GtkTreePath-struct pointing to the tree node whose children 715 * have been reordered 716 * iter = a valid #GtkTreeIter-struct pointing to the node 717 * whose children have been reordered, or %NULL if the depth 718 * of @path is 0 719 * newOrder = an array of integers 720 * mapping the current position of each child to its old 721 * position before the re-ordering, 722 * i.e. @new_order`[newpos] = oldpos` 723 * 724 * Since: 3.10 725 */ 726 public void rowsReorderedWithLength(TreePath path, TreeIter iter, int[] newOrder) 727 { 728 gtk_tree_model_rows_reordered_with_length(getTreeModelStruct(), (path is null) ? null : path.getTreePathStruct(), (iter is null) ? null : iter.getTreeIterStruct(), newOrder.ptr, cast(int)newOrder.length); 729 } 730 731 /** 732 * Lets the tree unref the node. 733 * 734 * This is an optional method for models to implement. 735 * To be more specific, models may ignore this call as it exists 736 * primarily for performance reasons. For more information on what 737 * this means, see gtk_tree_model_ref_node(). 738 * 739 * Please note that nodes that are deleted are not unreffed. 740 * 741 * Params: 742 * iter = the #GtkTreeIter-struct 743 */ 744 public void unrefNode(TreeIter iter) 745 { 746 gtk_tree_model_unref_node(getTreeModelStruct(), (iter is null) ? null : iter.getTreeIterStruct()); 747 } 748 749 /** 750 * This signal is emitted when a row in the model has changed. 751 * 752 * Params: 753 * path = a #GtkTreePath-struct identifying the changed row 754 * iter = a valid #GtkTreeIter-struct pointing to the changed row 755 */ 756 gulong addOnRowChanged(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 757 { 758 return Signals.connect(this, "row-changed", dlg, connectFlags ^ ConnectFlags.SWAPPED); 759 } 760 761 /** 762 * This signal is emitted when a row has been deleted. 763 * 764 * Note that no iterator is passed to the signal handler, 765 * since the row is already deleted. 766 * 767 * This should be called by models after a row has been removed. 768 * The location pointed to by @path should be the location that 769 * the row previously was at. It may not be a valid location anymore. 770 * 771 * Params: 772 * path = a #GtkTreePath-struct identifying the row 773 */ 774 gulong addOnRowDeleted(void delegate(TreePath, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 775 { 776 return Signals.connect(this, "row-deleted", dlg, connectFlags ^ ConnectFlags.SWAPPED); 777 } 778 779 /** 780 * This signal is emitted when a row has gotten the first child 781 * row or lost its last child row. 782 * 783 * Params: 784 * path = a #GtkTreePath-struct identifying the row 785 * iter = a valid #GtkTreeIter-struct pointing to the row 786 */ 787 gulong addOnRowHasChildToggled(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 788 { 789 return Signals.connect(this, "row-has-child-toggled", dlg, connectFlags ^ ConnectFlags.SWAPPED); 790 } 791 792 /** 793 * This signal is emitted when a new row has been inserted in 794 * the model. 795 * 796 * Note that the row may still be empty at this point, since 797 * it is a common pattern to first insert an empty row, and 798 * then fill it with the desired values. 799 * 800 * Params: 801 * path = a #GtkTreePath-struct identifying the new row 802 * iter = a valid #GtkTreeIter-struct pointing to the new row 803 */ 804 gulong addOnRowInserted(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 805 { 806 return Signals.connect(this, "row-inserted", dlg, connectFlags ^ ConnectFlags.SWAPPED); 807 } 808 809 /** 810 * This signal is emitted when the children of a node in the 811 * #GtkTreeModel have been reordered. 812 * 813 * Note that this signal is not emitted 814 * when rows are reordered by DND, since this is implemented 815 * by removing and then reinserting the row. 816 * 817 * Params: 818 * path = a #GtkTreePath-struct identifying the tree node whose children 819 * have been reordered 820 * iter = a valid #GtkTreeIter-struct pointing to the node whose children 821 * have been reordered, or %NULL if the depth of @path is 0 822 * newOrder = an array of integers mapping the current position 823 * of each child to its old position before the re-ordering, 824 * i.e. @new_order`[newpos] = oldpos` 825 */ 826 gulong addOnRowsReordered(void delegate(TreePath, TreeIter, void*, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 827 { 828 return Signals.connect(this, "rows-reordered", dlg, connectFlags ^ ConnectFlags.SWAPPED); 829 } 830 }