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.TreeModelIF; 26 27 private import glib.MemorySlice; 28 private import glib.Str; 29 private import gobject.ObjectG; 30 private import gobject.Signals; 31 private import gobject.Value; 32 private import gtk.TreeIter; 33 private import gtk.TreePath; 34 private import gtk.c.functions; 35 public import gtk.c.types; 36 public import gtkc.gtktypes; 37 private 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 interface TreeModelIF{ 237 /** Get the main Gtk struct */ 238 public GtkTreeModel* getTreeModelStruct(bool transferOwnership = false); 239 240 /** the main Gtk struct as a void* */ 241 protected void* getStruct(); 242 243 /** 244 * Get the value of a column as a char array. 245 * this is the same calling getValue and get the string from the value object 246 */ 247 string getValueString(TreeIter iter, int column); 248 249 /** 250 * Get the value of a column as a char array. 251 * this is the same calling getValue and get the int from the value object 252 */ 253 int getValueInt(TreeIter iter, int column); 254 255 /** 256 * Sets iter to a valid iterator pointing to path. 257 * Params: 258 * iter = The uninitialized GtkTreeIter. 259 * path = The GtkTreePath. 260 * Returns: 261 * TRUE, if iter was set. 262 */ 263 public int getIter(TreeIter iter, TreePath path); 264 265 /** 266 * Initializes and sets value to that at column. 267 * When done with value, g_value_unset() needs to be called 268 * to free any allocated memory. 269 * Params: 270 * iter = The GtkTreeIter. 271 * column = The column to lookup the value at. 272 * value = (inout) (transfer none) An empty GValue to set. 273 */ 274 public Value getValue(TreeIter iter, int column, Value value = null); 275 276 /** 277 */ 278 279 /** */ 280 public static GType getType() 281 { 282 return gtk_tree_model_get_type(); 283 } 284 285 /** 286 * Calls func on each node in model in a depth-first fashion. 287 * 288 * If @func returns %TRUE, then the tree ceases to be walked, 289 * and gtk_tree_model_foreach() returns. 290 * 291 * Params: 292 * func = a function to be called on each row 293 * userData = user data to passed to @func 294 */ 295 public void foreac(GtkTreeModelForeachFunc func, void* userData); 296 297 /** 298 * Returns the type of the column. 299 * 300 * Params: 301 * index = the column index 302 * 303 * Returns: the type of the column 304 */ 305 public GType getColumnType(int index); 306 307 /** 308 * Returns a set of flags supported by this interface. 309 * 310 * The flags are a bitwise combination of #GtkTreeModelFlags. 311 * The flags supported should not change during the lifetime 312 * of the @tree_model. 313 * 314 * Returns: the flags supported by this interface 315 */ 316 public GtkTreeModelFlags getFlags(); 317 318 /** 319 * Initializes @iter with the first iterator in the tree 320 * (the one at the path "0") and returns %TRUE. Returns 321 * %FALSE if the tree is empty. 322 * 323 * Params: 324 * iter = the uninitialized #GtkTreeIter-struct 325 * 326 * Returns: %TRUE, if @iter was set 327 */ 328 public bool getIterFirst(out TreeIter iter); 329 330 /** 331 * Sets @iter to a valid iterator pointing to @path_string, if it 332 * exists. Otherwise, @iter is left invalid and %FALSE is returned. 333 * 334 * Params: 335 * iter = an uninitialized #GtkTreeIter-struct 336 * pathString = a string representation of a #GtkTreePath-struct 337 * 338 * Returns: %TRUE, if @iter was set 339 */ 340 public bool getIterFromString(out TreeIter iter, string pathString); 341 342 /** 343 * Returns the number of columns supported by @tree_model. 344 * 345 * Returns: the number of columns 346 */ 347 public int getNColumns(); 348 349 /** 350 * Returns a newly-created #GtkTreePath-struct referenced by @iter. 351 * 352 * This path should be freed with gtk_tree_path_free(). 353 * 354 * Params: 355 * iter = the #GtkTreeIter-struct 356 * 357 * Returns: a newly-created #GtkTreePath-struct 358 */ 359 public TreePath getPath(TreeIter iter); 360 361 /** 362 * Generates a string representation of the iter. 363 * 364 * This string is a “:” separated list of numbers. 365 * For example, “4:10:0:3” would be an acceptable 366 * return value for this string. 367 * 368 * Params: 369 * iter = a #GtkTreeIter-struct 370 * 371 * Returns: a newly-allocated string. 372 * Must be freed with g_free(). 373 * 374 * Since: 2.2 375 */ 376 public string getStringFromIter(TreeIter iter); 377 378 /** 379 * See gtk_tree_model_get(), this version takes a va_list 380 * for language bindings to use. 381 * 382 * Params: 383 * iter = a row in @tree_model 384 * varArgs = va_list of column/return location pairs 385 */ 386 public void getValist(TreeIter iter, void* varArgs); 387 388 /** 389 * Sets @iter to point to the first child of @parent. 390 * 391 * If @parent has no children, %FALSE is returned and @iter is 392 * set to be invalid. @parent will remain a valid node after this 393 * function has been called. 394 * 395 * If @parent is %NULL returns the first node, equivalent to 396 * `gtk_tree_model_get_iter_first (tree_model, iter);` 397 * 398 * Params: 399 * iter = the new #GtkTreeIter-struct to be set to the child 400 * parent = the #GtkTreeIter-struct, or %NULL 401 * 402 * Returns: %TRUE, if @iter has been set to the first child 403 */ 404 public bool iterChildren(out TreeIter iter, TreeIter parent); 405 406 /** 407 * Returns %TRUE if @iter has children, %FALSE otherwise. 408 * 409 * Params: 410 * iter = the #GtkTreeIter-struct to test for children 411 * 412 * Returns: %TRUE if @iter has children 413 */ 414 public bool iterHasChild(TreeIter iter); 415 416 /** 417 * Returns the number of children that @iter has. 418 * 419 * As a special case, if @iter is %NULL, then the number 420 * of toplevel nodes is returned. 421 * 422 * Params: 423 * iter = the #GtkTreeIter-struct, or %NULL 424 * 425 * Returns: the number of children of @iter 426 */ 427 public int iterNChildren(TreeIter iter); 428 429 /** 430 * Sets @iter to point to the node following it at the current level. 431 * 432 * If there is no next @iter, %FALSE is returned and @iter is set 433 * to be invalid. 434 * 435 * Params: 436 * iter = the #GtkTreeIter-struct 437 * 438 * Returns: %TRUE if @iter has been changed to the next node 439 */ 440 public bool iterNext(TreeIter iter); 441 442 /** 443 * Sets @iter to be the child of @parent, using the given index. 444 * 445 * The first index is 0. If @n is too big, or @parent has no children, 446 * @iter is set to an invalid iterator and %FALSE is returned. @parent 447 * will remain a valid node after this function has been called. As a 448 * special case, if @parent is %NULL, then the @n-th root node 449 * is set. 450 * 451 * Params: 452 * iter = the #GtkTreeIter-struct to set to the nth child 453 * parent = the #GtkTreeIter-struct to get the child from, or %NULL. 454 * n = the index of the desired child 455 * 456 * Returns: %TRUE, if @parent has an @n-th child 457 */ 458 public bool iterNthChild(out TreeIter iter, TreeIter parent, int n); 459 460 /** 461 * Sets @iter to be the parent of @child. 462 * 463 * If @child is at the toplevel, and doesn’t have a parent, then 464 * @iter is set to an invalid iterator and %FALSE is returned. 465 * @child will remain a valid node after this function has been 466 * called. 467 * 468 * @iter will be initialized before the lookup is performed, so @child 469 * and @iter cannot point to the same memory location. 470 * 471 * Params: 472 * iter = the new #GtkTreeIter-struct to set to the parent 473 * child = the #GtkTreeIter-struct 474 * 475 * Returns: %TRUE, if @iter is set to the parent of @child 476 */ 477 public bool iterParent(out TreeIter iter, TreeIter child); 478 479 /** 480 * Sets @iter to point to the previous node at the current level. 481 * 482 * If there is no previous @iter, %FALSE is returned and @iter is 483 * set to be invalid. 484 * 485 * Params: 486 * iter = the #GtkTreeIter-struct 487 * 488 * Returns: %TRUE if @iter has been changed to the previous node 489 * 490 * Since: 3.0 491 */ 492 public bool iterPrevious(TreeIter iter); 493 494 /** 495 * Lets the tree ref the node. 496 * 497 * This is an optional method for models to implement. 498 * To be more specific, models may ignore this call as it exists 499 * primarily for performance reasons. 500 * 501 * This function is primarily meant as a way for views to let 502 * caching models know when nodes are being displayed (and hence, 503 * whether or not to cache that node). Being displayed means a node 504 * is in an expanded branch, regardless of whether the node is currently 505 * visible in the viewport. For example, a file-system based model 506 * would not want to keep the entire file-hierarchy in memory, 507 * just the sections that are currently being displayed by 508 * every current view. 509 * 510 * A model should be expected to be able to get an iter independent 511 * of its reffed state. 512 * 513 * Params: 514 * iter = the #GtkTreeIter-struct 515 */ 516 public void refNode(TreeIter iter); 517 518 /** 519 * Emits the #GtkTreeModel::row-changed signal on @tree_model. 520 * 521 * Params: 522 * path = a #GtkTreePath-struct pointing to the changed row 523 * iter = a valid #GtkTreeIter-struct pointing to the changed row 524 */ 525 public void rowChanged(TreePath path, TreeIter iter); 526 527 /** 528 * Emits the #GtkTreeModel::row-deleted signal on @tree_model. 529 * 530 * This should be called by models after a row has been removed. 531 * The location pointed to by @path should be the location that 532 * the row previously was at. It may not be a valid location anymore. 533 * 534 * Nodes that are deleted are not unreffed, this means that any 535 * outstanding references on the deleted node should not be released. 536 * 537 * Params: 538 * path = a #GtkTreePath-struct pointing to the previous location of 539 * the deleted row 540 */ 541 public void rowDeleted(TreePath path); 542 543 /** 544 * Emits the #GtkTreeModel::row-has-child-toggled signal on 545 * @tree_model. This should be called by models after the child 546 * state of a node changes. 547 * 548 * Params: 549 * path = a #GtkTreePath-struct pointing to the changed row 550 * iter = a valid #GtkTreeIter-struct pointing to the changed row 551 */ 552 public void rowHasChildToggled(TreePath path, TreeIter iter); 553 554 /** 555 * Emits the #GtkTreeModel::row-inserted signal on @tree_model. 556 * 557 * Params: 558 * path = a #GtkTreePath-struct pointing to the inserted row 559 * iter = a valid #GtkTreeIter-struct pointing to the inserted row 560 */ 561 public void rowInserted(TreePath path, TreeIter iter); 562 563 /** 564 * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. 565 * 566 * This should be called by models when their rows have been 567 * reordered. 568 * 569 * Params: 570 * path = a #GtkTreePath-struct pointing to the tree node whose children 571 * have been reordered 572 * iter = a valid #GtkTreeIter-struct pointing to the node whose children 573 * have been reordered, or %NULL if the depth of @path is 0 574 * newOrder = an array of integers mapping the current position of 575 * each child to its old position before the re-ordering, 576 * i.e. @new_order`[newpos] = oldpos` 577 */ 578 public void rowsReordered(TreePath path, TreeIter iter, int* newOrder); 579 580 /** 581 * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. 582 * 583 * This should be called by models when their rows have been 584 * reordered. 585 * 586 * Params: 587 * path = a #GtkTreePath-struct pointing to the tree node whose children 588 * have been reordered 589 * iter = a valid #GtkTreeIter-struct pointing to the node 590 * whose children have been reordered, or %NULL if the depth 591 * of @path is 0 592 * newOrder = an array of integers 593 * mapping the current position of each child to its old 594 * position before the re-ordering, 595 * i.e. @new_order`[newpos] = oldpos` 596 * 597 * Since: 3.10 598 */ 599 public void rowsReorderedWithLength(TreePath path, TreeIter iter, int[] newOrder); 600 601 /** 602 * Lets the tree unref the node. 603 * 604 * This is an optional method for models to implement. 605 * To be more specific, models may ignore this call as it exists 606 * primarily for performance reasons. For more information on what 607 * this means, see gtk_tree_model_ref_node(). 608 * 609 * Please note that nodes that are deleted are not unreffed. 610 * 611 * Params: 612 * iter = the #GtkTreeIter-struct 613 */ 614 public void unrefNode(TreeIter iter); 615 616 /** 617 * This signal is emitted when a row in the model has changed. 618 * 619 * Params: 620 * path = a #GtkTreePath-struct identifying the changed row 621 * iter = a valid #GtkTreeIter-struct pointing to the changed row 622 */ 623 gulong addOnRowChanged(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0); 624 625 /** 626 * This signal is emitted when a row has been deleted. 627 * 628 * Note that no iterator is passed to the signal handler, 629 * since the row is already deleted. 630 * 631 * This should be called by models after a row has been removed. 632 * The location pointed to by @path should be the location that 633 * the row previously was at. It may not be a valid location anymore. 634 * 635 * Params: 636 * path = a #GtkTreePath-struct identifying the row 637 */ 638 gulong addOnRowDeleted(void delegate(TreePath, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0); 639 640 /** 641 * This signal is emitted when a row has gotten the first child 642 * row or lost its last child row. 643 * 644 * Params: 645 * path = a #GtkTreePath-struct identifying the row 646 * iter = a valid #GtkTreeIter-struct pointing to the row 647 */ 648 gulong addOnRowHasChildToggled(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0); 649 650 /** 651 * This signal is emitted when a new row has been inserted in 652 * the model. 653 * 654 * Note that the row may still be empty at this point, since 655 * it is a common pattern to first insert an empty row, and 656 * then fill it with the desired values. 657 * 658 * Params: 659 * path = a #GtkTreePath-struct identifying the new row 660 * iter = a valid #GtkTreeIter-struct pointing to the new row 661 */ 662 gulong addOnRowInserted(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0); 663 664 /** 665 * This signal is emitted when the children of a node in the 666 * #GtkTreeModel have been reordered. 667 * 668 * Note that this signal is not emitted 669 * when rows are reordered by DND, since this is implemented 670 * by removing and then reinserting the row. 671 * 672 * Params: 673 * path = a #GtkTreePath-struct identifying the tree node whose children 674 * have been reordered 675 * iter = a valid #GtkTreeIter-struct pointing to the node whose children 676 * have been reordered, or %NULL if the depth of @path is 0 677 * newOrder = an array of integers mapping the current position 678 * of each child to its old position before the re-ordering, 679 * i.e. @new_order`[newpos] = oldpos` 680 */ 681 gulong addOnRowsReordered(void delegate(TreePath, TreeIter, void*, TreeModelIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0); 682 }