краткое описание

#include <gtk/gtk.h>

            gtktreemodelsort;
gtktreemodel* gtk_tree_model_sort_new_with_model
                                            (gtktreemodel *child_model);
gtktreemodel* gtk_tree_model_sort_get_model (gtktreemodelsort *tree_model);

gtktreepath* gtk_tree_model_sort_convert_child_path_to_path
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreepath *child_path);
void        gtk_tree_model_sort_convert_child_iter_to_iter
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *sort_iter,
                                             gtktreeiter *child_iter);

gtktreepath* gtk_tree_model_sort_convert_path_to_child_path
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreepath *sorted_path);
void        gtk_tree_model_sort_convert_iter_to_child_iter
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *child_iter,
                                             gtktreeiter *sorted_iter);
void        gtk_tree_model_sort_reset_default_sort_func

                                            (gtktreemodelsort *tree_model_sort);
void        gtk_tree_model_sort_clear_cache (gtktreemodelsort *tree_model_sort);
gboolean    gtk_tree_model_sort_iter_is_valid
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *iter);

иерархия объектов

  gobject
   +----gtktreemodelsort

осуществляемые интерфейсы

gtktreemodelsort осуществляет gtktreemodel, gtktreedragsource и gtktreesortable.

свойства

  "model"                gtktreemodel          : read / write / construct only

описание

gtktreemodelsort это модель которая осуществляет интерфейс gtktreesortable. она не содержит никаких данных непосредственно, а скорее создаёт дочернюю модель и уполномочивает её данные. она имеет идентичные типы столбцов для этой дочерней модели и изменения в ней. первичная цель этой модели обеспечить способ сортировки других моделей не изменяя их. помните что функции сортировки используемые gtktreemodelsort не гарантируют стабильность.

использование лучше демонстрируется через пример. в следующем приведённом коде примера мы создаём два виджета gtktreeview каждый с одними и теме же данными. так как оболочкой модели здесь является gtktreemodelsort, оба gtktreeviews могут сортировать свой вид данных не влияя на другой. в отличии от этого, если бы мы просто поместили некоторую модель в каждый виджет, то при сортировки одного сортировался бы и другой.

пример 3. использование gtktreemodelsort

{
  gtktreeview *tree_view1;
  gtktreeview *tree_view2;
  gtktreemodel *sort_model1;
  gtktreemodel *sort_model2;
  gtktreemodel *child_model;

  /* получаем дочернюю модель */
  child_model = get_my_model();

  /* создаём первое дерево */
  sort_model1 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view1 = gtk_tree_view_new_with_model (sort_model1);

  /* создаём второе дерево */
  sort_model2 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view2 = gtk_tree_view_new_with_model (sort_model2);

  /* теперь мы можем сортировать обе модели независимо */
  gtk_tree_sortable_set_sort_column_id (gtk_tree_sortable (sort_model1),
                                        column_1, gtk_sort_ascending);
  gtk_tree_sortable_set_sort_column_id (gtk_tree_sortable (sort_model2),
                                        column_1, gtk_sort_descending);
}

для демонстрации доступа к основной дочерней модели из модели сортировки в следующем примере применён обратный вызов для gtktreeselection "changed" сигнала. в этом вызове, мы получаем строку из column_1 модели. когда мы изменяем строку, находим туже самую выбранную сроку в дочерней модели и изменяем строку в ней.

пример 4. доступ к дочерней модели выбором изменения обратного вызова

void
selection_changed (gtktreeselection *selection, gpointer data)
{
  gtktreemodel *sort_model = null;
  gtktreemodel *child_model;
  gtktreeiter sort_iter;
  gtktreeiter child_iter;
  char *some_data = null;
  char *modified_data;

  /* получаем текущий выбор и модель. */
  if (! gtk_tree_selection_get_selected (selection,
                                         &sort_model,
                                         &sort_iter))
    return;


  /* находим текущеме значение выбранной строки и получаем новое значение
   * для изменения.
   */
  gtk_tree_model_get (gtk_tree_model (sort_model), &sort_iter,
                      column_1, &some_data,
                      -1);

  modified_data = change_the_data (some_data);
  g_free (some_data);

  /* получаем итератор дочерней модели, вместо сортируемой модели. */
  gtk_tree_model_sort_convert_iter_to_child_iter (gtk_tree_model_sort (sort_model),
                                                  &child_iter,
                                                  &sort_iter);

  /* получаем дочернюю модель и изменяем значение строки.  в этом
   * примере, дочерняя модель это gtkliststore.  однако она может быть
   * любого другого типа.
   */
  child_model = gtk_tree_model_sort_get_model (gtk_tree_model_sort (sort_model));
  gtk_list_store_set (gtk_list_store (child_model), &child_iter,
                      column_1, &modified_data,
                      -1);
  g_free (modified_data);
}

детали

gtktreemodelsort

typedef struct _gtktreemodelsort gtktreemodelsort;

структура не имеет непосредственного доступа. используйте для доступа функции приведённые ниже.

gtk_tree_model_sort_new_with_model ()

gtktreemodel* gtk_tree_model_sort_new_with_model
                                            (gtktreemodel *child_model);

создаёт новый gtktreemodel, с child_model как дочерней моделью.

gtk_tree_model_sort_get_model ()

gtktreemodel* gtk_tree_model_sort_get_model (gtktreemodelsort *tree_model);

возвращает модель сортировки gtktreemodelsort.

gtk_tree_model_sort_convert_child_path_to_path ()

gtktreepath* gtk_tree_model_sort_convert_child_path_to_path
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreepath *child_path);

преобразует child_path в относительный путь для tree_model_sort. таким образом, child_path указывает путь в дочерней модели. возвращаемый путь будет указывать на туже строку в отсортированной модели. еслиchild_path не доступный путь в дочерней модели, возвращается null.

gtk_tree_model_sort_convert_child_iter_to_iter ()

void        gtk_tree_model_sort_convert_child_iter_to_iter
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *sort_iter,
                                             gtktreeiter *child_iter);

устанавливает sort_iter указывающий строку в tree_model_sort, который соответствует строке указанной в child_iter.

gtk_tree_model_sort_convert_path_to_child_path ()

gtktreepath* gtk_tree_model_sort_convert_path_to_child_path
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreepath *sorted_path);

преобразует sorted_path в путь дочерней модели tree_model_sort. таким образом, sorted_path указывает на размещение в tree_model_sort. возвращаемый путь будет указывать на тоже расположение в не отсортированной модели. если sorted_path не указывает на расположение в дочерней модели, возвращается null.

gtk_tree_model_sort_convert_iter_to_child_iter ()

void        gtk_tree_model_sort_convert_iter_to_child_iter
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *child_iter,
                                             gtktreeiter *sorted_iter);

устанавливает child_iter указывающий строку указанную в sorted_iter.

gtk_tree_model_sort_reset_default_sort_func ()

void        gtk_tree_model_sort_reset_default_sort_func
                                            (gtktreemodelsort *tree_model_sort);

сбрасывает функцию сортировки по умолчанию в состояние 'unsorted'. таким образом, определяется тот же порядок, что и у дочерней модели. пересортировка модели в тот же порядок что и у дочерней, будет производится, только если модель gtktreemodelsort в 'unsorted' состоянии.

gtk_tree_model_sort_clear_cache ()

void        gtk_tree_model_sort_clear_cache (gtktreemodelsort *tree_model_sort);

эта функция почти никогда не вызывается. она очищает tree_model_sort от любых кэшированных итераторов которые не были очищены с помощью gtk_tree_model_ref_node(). это может быть полезно, если дочерняя модель отсортирована статично (и не часто изменяется) и был длительный доступ к неочищенным узлам. как побочный эффект этой функции, все неочищенные итераторы будут недоступны.

gtk_tree_model_sort_iter_is_valid ()

gboolean    gtk_tree_model_sort_iter_is_valid
                                            (gtktreemodelsort *tree_model_sort,
                                             gtktreeiter *iter);

внимание

эта функция бесполезна. используйте её только в случаях отладки или тестирования.

проверяет доступен ли полученный итератор в этой gtktreemodelsort.

начиная с версии 2.2

детали свойств

свойство "model"

  "model"                gtktreemodel          : read / write / construct only

модель для сортировки в treemodelsort.

смотрите также

gtktreemodel, gtkliststore, gtktreestore, gtktreesortable, gtktreemodelfilter