Spec-Zone.ru › GTK 3.24

GtkIconView

GtkIconView — Виджет, который отображает список значков в сетке

Функции

void (*GtkIconViewForeachFunc) ()
GtkWidget * gtk_icon_view_new ()
GtkWidget * gtk_icon_view_new_with_area ()
GtkWidget * gtk_icon_view_new_with_model ()
void gtk_icon_view_set_model ()
GtkTreeModel * gtk_icon_view_get_model ()
void gtk_icon_view_set_text_column ()
gint gtk_icon_view_get_text_column ()
void gtk_icon_view_set_markup_column ()
gint gtk_icon_view_get_markup_column ()
void gtk_icon_view_set_pixbuf_column ()
gint gtk_icon_view_get_pixbuf_column ()
GtkTreePath * gtk_icon_view_get_path_at_pos ()
gboolean gtk_icon_view_get_item_at_pos ()
void gtk_icon_view_convert_widget_to_bin_window_coords ()
void gtk_icon_view_set_cursor ()
gboolean gtk_icon_view_get_cursor ()
void gtk_icon_view_selected_foreach ()
void gtk_icon_view_set_selection_mode ()
GtkSelectionMode gtk_icon_view_get_selection_mode ()
void gtk_icon_view_set_item_orientation ()
GtkOrientation gtk_icon_view_get_item_orientation ()
void gtk_icon_view_set_columns ()
gint gtk_icon_view_get_columns ()
void gtk_icon_view_set_item_width ()
gint gtk_icon_view_get_item_width ()
void gtk_icon_view_set_spacing ()
gint gtk_icon_view_get_spacing ()
void gtk_icon_view_set_row_spacing ()
gint gtk_icon_view_get_row_spacing ()
void gtk_icon_view_set_column_spacing ()
gint gtk_icon_view_get_column_spacing ()
void gtk_icon_view_set_margin ()
gint gtk_icon_view_get_margin ()
void gtk_icon_view_set_item_padding ()
gint gtk_icon_view_get_item_padding ()
void gtk_icon_view_set_activate_on_single_click ()
gboolean gtk_icon_view_get_activate_on_single_click ()
gboolean gtk_icon_view_get_cell_rect ()
void gtk_icon_view_select_path ()
void gtk_icon_view_unselect_path ()
gboolean gtk_icon_view_path_is_selected ()
GList * gtk_icon_view_get_selected_items ()
void gtk_icon_view_select_all ()
void gtk_icon_view_unselect_all ()
void gtk_icon_view_item_activated ()
void gtk_icon_view_scroll_to_path ()
gboolean gtk_icon_view_get_visible_range ()
void gtk_icon_view_set_tooltip_item ()
void gtk_icon_view_set_tooltip_cell ()
gboolean gtk_icon_view_get_tooltip_context ()
void gtk_icon_view_set_tooltip_column ()
gint gtk_icon_view_get_tooltip_column ()
gint gtk_icon_view_get_item_row ()
gint gtk_icon_view_get_item_column ()
void gtk_icon_view_enable_model_drag_source ()
void gtk_icon_view_enable_model_drag_dest ()
void gtk_icon_view_unset_model_drag_source ()
void gtk_icon_view_unset_model_drag_dest ()
void gtk_icon_view_set_reorderable ()
gboolean gtk_icon_view_get_reorderable ()
void gtk_icon_view_set_drag_dest_item ()
void gtk_icon_view_get_drag_dest_item ()
gboolean gtk_icon_view_get_dest_item_at_pos ()
cairo_surface_t * gtk_icon_view_create_drag_icon ()

Свойства

gboolean activate-on-single-click Чтение / Запись
GtkCellArea * cell-area Чтение / Запись / Только для создания
int column-spacing Чтение / Запись
int columns Чтение / Запись
GtkOrientation item-orientation Чтение / Запись
int item-padding Чтение / Запись
int item-width Чтение / Запись
int margin Чтение / Запись
int markup-column Чтение / Запись
GtkTreeModel * model Чтение / Запись
int pixbuf-column Чтение / Запись
gboolean reorderable Чтение / Запись
int row-spacing Чтение / Запись
GtkSelectionMode selection-mode Чтение / Запись
int spacing Чтение / Запись
int text-column Чтение / Запись
int tooltip-column Чтение / Запись

Стилизованные свойства

guchar selection-box-alpha Чтение
GdkColor * selection-box-color Чтение

Сигналы

gboolean activate-cursor-item Действие
void item-activated Выполняется последним
gboolean move-cursor Действие
void select-all Действие
void select-cursor-item Действие
void selection-changed Выполняется первым
void toggle-cursor-item Действие
void unselect-all Действие

Типы и значения

struct GtkIconView
enum GtkIconViewDropPosition

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

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkIconView

Реализованные интерфейсы

GtkIconView реализует AtkImplementorIface, GtkBuildable, GtkCellLayout и GtkScrollable.

Включенные файлы

#include <gtk/gtk.h>

Описание

GtkIconView предоставляет альтернативный вид на GtkTreeModel. Он отображает модель в виде сетки значков с метками. Как и GtkTreeView, он позволяет выбирать один или несколько элементов (в зависимости от режима выбора, см. gtk_icon_view_set_selection_mode()). В дополнение к выбору с помощью клавиш со стрелками, GtkIconView поддерживает резиновое выделение, которое управляется перетаскиванием указателя.

Обратите внимание, что если модель дерева основана на реальном хранилище дерева (а не на плоском списке, где сопоставление с значками очевидно), GtkIconView будет отображать только первый уровень дерева и игнорировать ветви дерева.

Узлы CSS

GtkIconView имеет один узел CSS с именем iconview и стилем .view. Для резинового выделения используется под-узел с именем rubberband.

Функции

GtkIconViewForeachFunc ()

void
(*GtkIconViewForeachFunc) (GtkIconView *icon_view,
                           GtkTreePath *path,
                           gpointer data);

Функция, используемая gtk_icon_view_selected_foreach() для отображения всех выделенных строк. Она будет вызываться для каждой выделенной строки в представлении.

Параметры

icon_view

a GtkIconView

path

The GtkTreePath выделенной строки

data

пользовательские данные.

[closure]

gtk_icon_view_new ()

GtkWidget *
gtk_icon_view_new (void);

Создаёт новый виджет GtkIconView

Возвращает

Новый созданный виджет GtkIconView

С: 2.6

gtk_icon_view_new_with_area ()

GtkWidget *
gtk_icon_view_new_with_area (GtkCellArea *area);

Создаёт новый виджет GtkIconView используя указанный area для выравнивания ячеек внутри значков.

Параметры

area

the GtkCellArea для выравнивания ячеек

Возвращает

Новый созданный виджет GtkIconView

С: 3.0

gtk_icon_view_new_with_model ()

GtkWidget *
gtk_icon_view_new_with_model (GtkTreeModel *model);

Создаёт новый виджет GtkIconView с моделью model .

Параметры

model

Модель.

Возвращает

Новый созданный виджет GtkIconView.

С: 2.6

gtk_icon_view_set_model ()

void
gtk_icon_view_set_model (GtkIconView *icon_view,
                         GtkTreeModel *model);

Устанавливает модель для GtkIconView. Если у icon_view уже установлена модель, она будет удалена перед установкой новой. Если model равняется NULL, то старая модель будет удалена.

Параметры

icon_view

A GtkIconView.

model

Модель.

[allow-none]

С: 2.6

gtk_icon_view_get_model ()

GtkTreeModel *
gtk_icon_view_get_model (GtkIconView *icon_view);

Возвращает модель, на которой основан GtkIconView. Возвращает NULL если модель не установлена.

Параметры

icon_view

a GtkIconView

Возвращает

A GtkTreeModel, или NULL если модель не используется.

[nullable][transfer none]

С: 2.6

gtk_icon_view_set_text_column ()

void
gtk_icon_view_set_text_column (GtkIconView *icon_view,
                               gint column);

Устанавливает столбец с текстом для icon_view в column . Столбец текста должен быть типа G_TYPE_STRING.

Параметры

icon_view

A GtkIconView.

column

Столбец в текущей модели, или -1 для отображения без текста

С: 2.6

gtk_icon_view_get_text_column ()

gint
gtk_icon_view_get_text_column (GtkIconView *icon_view);

Возвращает столбец с текстом для icon_view .

Параметры

icon_view

A GtkIconView.

Возвращает

столбец с текстом, или -1 если он не установлен.

С: 2.6

gtk_icon_view_set_markup_column ()

void
gtk_icon_view_set_markup_column (GtkIconView *icon_view,
                                 gint column);

Устанавливает столбец с разметкой для icon_view в column . Столбец разметки должен быть типа G_TYPE_STRING. Если столбец разметки установлен, он переопределяет столбец текста, установленный gtk_icon_view_set_text_column().

Параметры

icon_view

A GtkIconView.

column

Столбец в текущей модели, или -1 для отображения без текста

С: 2.6

gtk_icon_view_get_markup_column ()

gint
gtk_icon_view_get_markup_column (GtkIconView *icon_view);

Возвращает столбец с разметкой для icon_view .

Параметры

icon_view

A GtkIconView.

Возвращает

столбец разметки, или -1 если он не установлен.

С: 2.6

gtk_icon_view_set_pixbuf_column ()

void
gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
                                 gint column);

Устанавливает столбец с pixbuf для icon_view в column . Столбец pixbuf должен быть типа GDK_TYPE_PIXBUF

Параметры

icon_view

A GtkIconView.

column

Столбец в текущей модели, или -1 для отключения

С: 2.6

gtk_icon_view_get_pixbuf_column ()

gint
gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);

Возвращает столбец с pixbufs для icon_view .

Параметры

icon_view

A GtkIconView.

Возвращает

столбец pixbuf, или -1 если он не установлен.

С: 2.6

gtk_icon_view_get_path_at_pos ()

GtkTreePath *
gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
                               gint x,
                               gint y);

Находит путь в точке (x , y ), относительно координат окна bin_window. См. gtk_icon_view_get_item_at_pos(), если вам также интересен элемент в указанной позиции. См. gtk_icon_view_convert_widget_to_bin_window_coords() для преобразования координат виджета в координаты окна bin_window.

Параметры

icon_view

A GtkIconView.

x

Позиция x для идентификации

y

Позиция y для идентификации

Возвращает

The GtkTreePath соответствующий значку или NULL если значка в этой позиции нет.

[nullable][transfer full]

С: 2.6

gtk_icon_view_get_item_at_pos ()

gboolean
gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
                               gint x,
                               gint y,
                               GtkTreePath **path,
                               GtkCellRenderer **cell);

Находит путь в точке (x , y ), относительно координат окна bin_window. В отличие от gtk_icon_view_get_path_at_pos(), эта функция также получает ячейку в указанной позиции. Возвращаемый путь должен быть освобождён с помощью gtk_tree_path_free(). См. gtk_icon_view_convert_widget_to_bin_window_coords() для преобразования координат виджета в координаты окна bin_window.

Параметры

icon_view

A GtkIconView.

x

Позиция x для идентификации

y

Позиция y для идентификации

path

Место для возвращения пути или NULL.

[out][allow-none]

cell

Место для возвращения рендерера, ответственного за ячейку в точке (x , y ), или NULL.

[out][allow-none][transfer none]

Возвращает

TRUE если в указанной позиции есть элемент

С: 2.8

gtk_icon_view_convert_widget-to-bin-window-coords ()

void
gtk_icon_view_convert_widget_to_bin_window_coords
                               (GtkIconView *icon_view,
                                gint wx,
                                gint wy,
                                gint *bx,
                                gint *by);

Преобразует координаты виджета в координаты окна bin_window, как ожидается, например, gtk_icon_view_get_path_at_pos().

Параметры

icon_view

a GtkIconView

wx

Координата x, относительная к виджету

wy

Координата y, относительная к виджету

bx

Место для возвращения координаты x окна bin_window.

[out]

by

Место для возвращения координаты y окна bin_window.

[out]

С: 2.12

gtk_icon_view_set_cursor ()

void
gtk_icon_view_set_cursor (GtkIconView *icon_view,
                          GtkTreePath *path,
                          GtkCellRenderer *cell,
                          gboolean start_editing);

Устанавливает текущий фокус клавиатуры в path и выбирает его. Это полезно, когда вы хотите привлечь внимание пользователя к определенному элементу. Если cell не NULL, то фокус даётся ячейке, указанной им. Кроме того, если start_editing TRUE, то редактирование должно начаться в указанной ячейке.

Эта функция часто сопровождается gtk_widget_grab_focus (icon_view) для присвоения фокуса клавиатуры виджету. Обратите внимание, что редактирование может происходить только при реализованном виджете.

Параметры

icon_view

A GtkIconView

path

A GtkTreePath

cell

Один из рендереров ячеек icon_view , или NULL.

[allow-none]

start_editing

TRUE если указанная ячейка должна быть открыта для редактирования.

С: 2.8

gtk_icon_view_get_cursor ()

gboolean
gtk_icon_view_get_cursor (GtkIconView *icon_view,
                          GtkTreePath **path,
                          GtkCellRenderer **cell);

Заполняет path и cell текущим путем курсора и ячейкой. Если курсор не установлен, то *path будет NULL. Если ячейка не имеет фокуса, то *cell будет NULL.

Возвращаемый GtkTreePath должен быть освобождён с помощью gtk_tree_path_free().

Параметры

icon_view

A GtkIconView

path

Место для возвращения текущего пути курсора, или NULL.

[out][allow-none][transfer full]

cell

Место для возвращения текущей ячейки фокуса, или NULL.

[out][allow-none][transfer none]

Возвращает

TRUE если курсор установлен.

С: 2.8

gtk_icon_view_selected_foreach ()

void
gtk_icon_view_selected_foreach (GtkIconView *icon_view,
                                GtkIconViewForeachFunc func,
                                gpointer data);

Вызывает функцию для каждого выделенного значка. Обратите внимание, что модель или выбор нельзя изменять внутри этой функции.

Параметры

icon_view

A GtkIconView.

func

Функция, которая вызывается для каждого выделенного значка.

[scope call]

data

Данные пользователя, которые передаются в функцию.

С: 2.6

gtk_icon_view_set_selection_mode ()

void
gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
                                  GtkSelectionMode mode);

Устанавливает режим выбора icon_view.

Параметры

icon_view

A GtkIconView.

mode

Режим выбора

С: 2.6

gtk_icon_view_get_selection_mode ()

GtkSelectionMode
gtk_icon_view_get_selection_mode (GtkIconView *icon_view);

Получает режим выбора icon_view.

Параметры

icon_view

A GtkIconView.

Возвращаемое значение

текущий режим выбора

С: 2.6

gtk_icon_view_set_item_orientation ()

void
gtk_icon_view_set_item_orientation (GtkIconView *icon_view,
                                    GtkOrientation orientation);

Устанавливает свойство ::item-orientation, которое определяет, выводятся ли метки рядом со значками, а не под ними.

Параметры

icon_view

a GtkIconView

orientation

относительное положение текста и значков

С: 2.6

gtk_icon_view_get_item_orientation ()

GtkOrientation
gtk_icon_view_get_item_orientation (GtkIconView *icon_view);

Возвращает значение свойства ::item-orientation, которое определяет, выводятся ли метки рядом со значками, а не под ними.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

относительное положение текста и значков

С: 2.6

gtk_icon_view_set_columns ()

void
gtk_icon_view_set_columns (GtkIconView *icon_view,
                           gint columns);

Устанавливает свойство ::columns, которое определяет, в скольких колонках организованы значки. Если columns равно -1, количество колонок будет выбрано автоматически, чтобы заполнить доступную область.

Параметры

icon_view

a GtkIconView

columns

количество колонок

С: 2.6

gtk_icon_view_get_columns ()

gint
gtk_icon_view_get_columns (GtkIconView *icon_view);

Возвращает значение свойства ::columns.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

количество колонок, или -1

С: 2.6

gtk_icon_view_set_item_width ()

void
gtk_icon_view_set_item_width (GtkIconView *icon_view,
                              gint item_width);

Устанавливает свойство ::item-width, которое задаёт ширину каждого элемента. Если оно установлено в -1, виджет автоматически определит подходящий размер элемента.

Параметры

icon_view

a GtkIconView

item_width

ширина каждого элемента

С: 2.6

gtk_icon_view_get_item_width ()

gint
gtk_icon_view_get_item_width (GtkIconView *icon_view);

Возвращает значение свойства ::item-width.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

ширина одного элемента, или -1

С: 2.6

gtk_icon_view_set_spacing ()

void
gtk_icon_view_set_spacing (GtkIconView *icon_view,
                           gint spacing);

Устанавливает свойство ::spacing, которое задаёт отступ между ячейками (т.е. между значком и текстом) элемента.

Параметры

icon_view

a GtkIconView

spacing

отступ

С: 2.6

gtk_icon_view_get_spacing ()

gint
gtk_icon_view_get_spacing (GtkIconView *icon_view);

Возвращает значение свойства ::spacing.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

отступ между ячейками

С: 2.6

gtk_icon_view_set_row_spacing ()

void
gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
                               gint row_spacing);

Устанавливает свойство ::row-spacing, которое задаёт отступ между строками в виджете.

Параметры

icon_view

a GtkIconView

row_spacing

отступ между строками

С: 2.6

gtk_icon_view_get_row_spacing ()

gint
gtk_icon_view_get_row_spacing (GtkIconView *icon_view);

Возвращает значение свойства ::row-spacing.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

отступ между строками

С: 2.6

gtk_icon_view_set_column-spacing ()

void
gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
                                  gint column_spacing);

Устанавливает свойство ::column-spacing, которое задаёт отступ между столбцами в виджете.

Параметры

icon_view

a GtkIconView

column_spacing

отступ между столбцами

С: 2.6

gtk_icon_view_get_column_spacing ()

gint
gtk_icon_view_get_column_spacing (GtkIconView *icon_view);

Возвращает значение свойства ::column-spacing.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

расстояние между столбцами

С версии: 2.6

gtk_icon_view_set_margin ()

void
gtk_icon_view_set_margin (GtkIconView *icon_view,
                          gint margin);

Устанавливает свойство ::margin, которое определяет отступы сверху, снизу, слева и справа от области отображения значков.

Параметры

icon_view

a GtkIconView

margin

отступ

С версии: 2.6

gtk_icon_view_get_margin ()

gint
gtk_icon_view_get_margin (GtkIconView *icon_view);

Возвращает значение свойства ::margin.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

отступ по краям

С версии: 2.6

gtk_icon_view_set_item_padding ()

void
gtk_icon_view_set_item_padding (GtkIconView *icon_view,
                                gint item_padding);

Устанавливает свойство “item-padding”, которое определяет отступ вокруг каждого элемента списка значков.

Параметры

icon_view

a GtkIconView

item_padding

отступ элемента

С версии: 2.18

gtk_icon_view_get_item_padding ()

gint
gtk_icon_view_get_item_padding (GtkIconView *icon_view);

Возвращает значение свойства ::item-padding.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

отступ вокруг элементов

С версии: 2.18

gtk_icon_view_set_activate_on_single_click ()

void
gtk_icon_view_set_activate_on_single_click
                               (GtkIconView *icon_view,
                                gboolean single);

Вызывает срабатывание сигнала “item-activated” при однократном щелчке мышью вместо двойного.

Параметры

icon_view

a GtkIconView

single

TRUE для срабатывания item-activated при однократном клике

С версии: 3.8

gtk_icon_view_get_activate_on_single_click ()

gboolean
gtk_icon_view_get_activate_on_single_click
                               (GtkIconView *icon_view);

Получает значение, установленное функцией gtk_icon_view_set_activate_on_single_click().

Параметры

icon_view

a GtkIconView

Возвращаемое значение

TRUE если item-activated будет срабатывать при однократном клике

С версии: 3.8

gtk_icon_view_get_cell_rect ()

gboolean
gtk_icon_view_get_cell_rect (GtkIconView *icon_view,
                             GtkTreePath *path,
                             GtkCellRenderer *cell,
                             GdkRectangle *rect);

Заполняет прямоугольник, определяющий границы ячейки в координатах виджета, по указанным path и cell. Если cell равно NULL, используется основная область ячейки.

Эта функция допустима только если icon_view реализован.

Параметры

icon_view

a GtkIconView

path

a GtkTreePath

cell

a GtkCellRenderer или NULL.

[allow-none]

rect

прямоугольник для заполнения прямоугольником ячейки.

[out]

Возвращаемое значение

FALSE если такого элемента нет, TRUE в противном случае

С версии: 3.6

gtk_icon_view_select_path ()

void
gtk_icon_view_select_path (GtkIconView *icon_view,
                           GtkTreePath *path);

Выделяет строку по path.

Параметры

icon_view

A GtkIconView.

path

Выделяемый GtkTreePath.

С версии: 2.6

gtk_icon_view_unselect_path ()

void
gtk_icon_view_unselect_path (GtkIconView *icon_view,
                             GtkTreePath *path);

Снимает выделение со строки по path.

Параметры

icon_view

A GtkIconView.

path

Удаляемый GtkTreePath.

С версии: 2.6

gtk_icon_view_path_is_selected ()

gboolean
gtk_icon_view_path_is_selected (GtkIconView *icon_view,
                                GtkTreePath *path);

Возвращает TRUE, если значок, на который указывает path, в данный момент выделен. Если path не указывает на корректное местоположение, возвращается FALSE.

Параметры

icon_view

A GtkIconView.

path

A GtkTreePath для проверки выделения.

Возвращаемое значение

TRUE если path выделен.

С версии: 2.6

gtk_icon_view_get_selected_items ()

GList *
gtk_icon_view_get_selected_items (GtkIconView *icon_view);

Создаёт список путей всех выделенных элементов. Кроме того, если вы планируете изменять модель после вызова этой функции, вам может потребоваться преобразовать возвращённый список в список GtkTreeRowReferences. Для этого вы можете использовать gtk_tree_row_reference_new().

Для освобождения возвращаемого значения используйте:

iconview.view
╰── [rubberband]

Параметры

icon_view

A GtkIconView.

Возвращаемое значение

A GList содержащий GtkTreePath для каждой выделенной строки.

[element-type GtkTreePath][transfer full]

С: 2.6

gtk_icon_view_select_all ()

void
gtk_icon_view_select_all (GtkIconView *icon_view);

Выделяет все значки. icon_view должен иметь режим выбора, установленный в GTK_SELECTION_MULTIPLE.

Параметры

icon_view

A GtkIconView.

С: 2.6

gtk_icon_view_unselect_all ()

void
gtk_icon_view_unselect_all (GtkIconView *icon_view);

Снимает выделение со всех значков.

Параметры

icon_view

A GtkIconView.

С: 2.6

gtk_icon_view_item_activated ()

void
gtk_icon_view_item_activated (GtkIconView *icon_view,
                              GtkTreePath *path);

Активирует элемент, определяемый path.

Параметры

icon_view

A GtkIconView

path

The GtkTreePath to be activated

С: 2.6

gtk_icon_view_scroll-to-path ()

void
gtk_icon_view_scroll_to_path (GtkIconView *icon_view,
                              GtkTreePath *path,
                              gboolean use_align,
                              gfloat row_align,
                              gfloat col_align);

Перемещает выравнивание icon_view в позицию, указанную path. row_align определяет, где размещается строка, а col_align определяет, где размещается column. Оба значения должны быть в диапазоне от 0,0 до 1,0. 0,0 соответствует выравниванию слева/сверху, 1,0 — справа/снизу, 0,5 — центрированию.

Если use_align равно FALSE, то параметры выравнивания игнорируются, и дерево выполняет минимальную работу по прокрутке элемента на экран. Это означает, что элемент будет прокручен к краю, ближайшему к его текущему положению. Если элемент уже виден на экране, ничего не делается.

Эта функция работает только в том случае, если модель установлена, и path — это действительная строка в модели. Если модель изменяется до того, как icon_view реализуется, центрированный путь будет изменён, чтобы отразить это изменение.

Параметры

icon_view

A GtkIconView.

path

Путь элемента, к которому нужно переместиться.

use_align

использовать ли параметры выравнивания, или FALSE.

row_align

Вертикальное выравнивание элемента, указанного в path.

col_align

Горизонтальное выравнивание элемента, указанного в path.

С: 2.8

gtk_icon_view_get_visible-range ()

gboolean
gtk_icon_view_get_visible_range (GtkIconView *icon_view,
                                 GtkTreePath **start_path,
                                 GtkTreePath **end_path);

Устанавливает start_path и end_path в качестве первого и последнего видимого пути. Обратите внимание, что между ними могут быть невидимые пути.

Оба пути следует освободить с помощью gtk_tree_path_free() после использования.

Параметры

icon_view

A GtkIconView

start_path

Место для возвращения начала области, или NULL.

[out][allow-none]

end_path

Место для возвращения конца области, или NULL.

[out][allow-none]

Возвращаемое значение

TRUE, если действительные пути были помещены в start_path и end_path

С: 2.8

gtk_icon_view_set_tooltip_item ()

void
gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
                                GtkTooltip *tooltip,
                                GtkTreePath *path);

Устанавливает область подсказки tooltip в область, покрываемую элементом по адресу path. См. также gtk_icon_view_set_tooltip_column() для более простого варианта. См. также gtk_tooltip_set_tip_area().

Параметры

icon_view

a GtkIconView

tooltip

a GtkTooltip

path

a GtkTreePath

С: 2.12

gtk_icon_view_set_tooltip_cell ()

void
gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
                                GtkTooltip *tooltip,
                                GtkTreePath *path,
                                GtkCellRenderer *cell);

Устанавливает область подсказки для tooltip в область, которую занимает cell в элементе, на который указывает path. См. также gtk_tooltip_set_tip_area().

См. также gtk_icon_view_set_tooltip_column() для более простого варианта.

Параметры

icon_view

a GtkIconView

tooltip

a GtkTooltip

path

a GtkTreePath

cell

a GtkCellRenderer или NULL.

[allow-none]

С: 2.12

gtk_icon_view_get_tooltip_context ()

gboolean
gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
                                   gint *x,
                                   gint *y,
                                   gboolean keyboard_tip,
                                   GtkTreeModel **model,
                                   GtkTreePath **path,
                                   GtkTreeIter *iter);

Эта функция предназначена для использования в обработчике сигнала “query-tooltip” для GtkIconView. Значения x, y и keyboard_tip, полученные в обработчике сигнала, должны быть переданы в эту функцию без изменений.

Возвращаемое значение указывает, есть ли элемент представления значка в заданных координатах (TRUE) или нет (FALSE) для подсказок при наведении курсора мыши. Для подсказок при нажатии клавиш возвращаемый элемент — это элемент курсора. При TRUE, любое из model, path и iter, которые были предоставлены, будет установлено на указание этой строки и соответствующей модели. x и y всегда будут преобразованы, чтобы быть относительными к icon_view ’s bin_window, если keyboard_tooltip равно FALSE.

Параметры

icon_view

an GtkIconView

x

координата x (относительно координат виджета).

[inout]

y

координата y (относительно координат виджета).

[inout]

keyboard_tip

указывает, является ли это подсказкой для нажатия клавиш или нет

model

указатель для получения GtkTreeModel или NULL.

[out][allow-none][transfer none]

path

указатель для получения GtkTreePath или NULL.

[out][allow-none]

iter

указатель для получения GtkTreeIter или NULL.

[out][allow-none]

Возвращаемое значение

указывает, соответствует ли контекст подсказки элементу

С: 2.12

gtk_icon_view_set_tooltip_column ()

void
gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
                                  gint column);

Если вы планируете использовать только простые (только текст) подсказки для полных элементов, вы можете использовать эту функцию, чтобы GtkIconView обрабатывал их автоматически. column должен быть установлен на столбец в модели icon_view, содержащий текст подсказки, или -1 для отключения этой функции.

При включении “has-tooltip” будет установлено в TRUE, и icon_view будет подключен к обработчику сигнала “query-tooltip”.

Обратите внимание, что обработчик сигнала устанавливает текст с помощью gtk_tooltip_set_markup(), поэтому &, < и т. д. должны быть экранированы в тексте.

Параметры

icon_view

a GtkIconView

column

целое число, которое является допустимым номером столбца для модели icon_view

С: 2.12

gtk_icon_view_get_tooltip_column ()

gint
gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);

Возвращает столбец в модели icon_view, который используется для отображения подсказок для строк в icon_view.

Параметры

icon_view

a GtkIconView

Возвращаемое значение

индекс столбца подсказки, который используется в настоящее время, или -1, если функция отключена.

С: 2.12

gtk_icon_view_get_item_row ()

gint
gtk_icon_view_get_item_row (GtkIconView *icon_view,
                            GtkTreePath *path);

Получает строку, в которой отображается элемент path. Номера строк начинаются с 0.

Параметры

icon_view

a GtkIconView

path

the GtkTreePath элемента

Возвращаемое значение

Строка, в которой отображается элемент

С: 2.22

gtk_icon_view_get_item_column ()

gint
gtk_icon_view_get_item_column (GtkIconView *icon_view,
                               GtkTreePath *path);

Получает столбец, в котором отображается элемент path. Номера столбцов начинаются с 0.

Параметры

icon_view

a GtkIconView

path

the GtkTreePath элемента

Возвращаемое значение

Столбец, в котором отображается элемент

С: 2.22

gtk_icon_view_enable_model_drag_source ()

void
gtk_icon_view_enable_model_drag_source
                               (GtkIconView *icon_view,
                                GdkModifierType start_button_mask,
                                const GtkTargetEntry *targets,
                                gint n_targets,
                                GdkDragAction actions);

Превращает icon_view в источник перетаскивания для автоматического DND. Вызов этого метода устанавливает “reorderable” в значение FALSE.

Параметры

icon_view

a GtkIconView

start_button_mask

Маска разрешённых кнопок для начала перетаскивания

targets

таблица целей, которые будет поддерживать перетаскивание.

[array length=n_targets]

n_targets

количество элементов в targets

actions

битовая маска возможных действий для перетаскивания из этого виджета

С версии: 2.8

gtk_icon_view_enable_model_drag_dest ()

void
gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view,
                                      const GtkTargetEntry *targets,
                                      gint n_targets,
                                      GdkDragAction actions);

Превращает icon_view в целевой объект для автоматического DND. Вызов этого метода устанавливает “reorderable” в значение FALSE.

Параметры

icon_view

a GtkIconView

targets

таблица целей, которые будет поддерживать перетаскивание.

[array length=n_targets]

n_targets

количество элементов в targets

actions

битовая маска возможных действий для перетаскивания в этот виджет

С версии: 2.8

gtk_icon_view_unset_model_drag_source ()

void
gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view);

Отменяет действие gtk_icon_view_enable_model_drag_source(). Вызов этого метода устанавливает “reorderable” в значение FALSE.

Параметры

icon_view

a GtkIconView

С версии: 2.8

gtk_icon_view_unset_model_drag_dest ()

void
gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);

Отменяет действие gtk_icon_view_enable_model_drag_dest(). Вызов этого метода устанавливает “reorderable” в значение FALSE.

Параметры

icon_view

a GtkIconView

С версии: 2.8

gtk_icon_view_set_reorderable ()

void
gtk_icon_view_set_reorderable (GtkIconView *icon_view,
                               gboolean reorderable);

Эта функция является вспомогательной функцией, позволяющей переупорядочивать модели, которые поддерживают GtkTreeDragSourceIface и GtkTreeDragDestIface. И GtkTreeStore, и GtkListStore поддерживают эти интерфейсы. Если reorderable равно TRUE, пользователь может переупорядочить модель, перетаскивая строки. Разработчик может отслеживать эти изменения, подключившись к сигналам row_inserted и row_deleted модели. Переупорядочение реализуется путём установки представления значков в качестве источника и назначения перетаскивания. Следовательно, перетаскивание не может быть использовано для других целей в переупорядочиваемом представлении.

Эта функция не даёт вам никакого контроля над порядком — любые перестановки разрешены. Если требуется более точный контроль, вам, вероятно, следует обработать перетаскивание вручную.

Параметры

icon_view

A GtkIconView.

reorderable

TRUE, если список элементов может быть переупорядочен.

С версии: 2.8

gtk_icon_view_get_reorderable ()

gboolean
gtk_icon_view_get_reorderable (GtkIconView *icon_view);

Возвращает, может ли пользователь переупорядочить список с помощью перетаскивания. См. gtk_icon_view_set_reorderable().

Параметры

icon_view

a GtkIconView

Возвращаемое значение

TRUE если список может быть переупорядочен.

С версии: 2.8

gtk_icon_view_set_drag-dest-item ()

void
gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view,
                                  GtkTreePath *path,
                                  GtkIconViewDropPosition pos);

Устанавливает элемент, который выделен для обратной связи.

Параметры

icon_view

a GtkIconView

path

Путь к элементу для выделения, или NULL.

[allow-none]

pos

Указывает, куда поместить, относительно элемента.

С версии: 2.8

gtk_icon_view_get_drag-dest-item ()

void
gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
                                  GtkTreePath **path,
                                  GtkIconViewDropPosition *pos);

Получает информацию об элементе, выделенном для обратной связи.

Параметры

icon_view

a GtkIconView

path

Место для возврата пути выделенного элемента, или NULL.

[out][allow-none]

pos

Место для возврата позиции вставки, или NULL.

[out][allow-none]

С версии: 2.8

gtk_icon_view_get_dest_item_at_pos ()

gboolean
gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view,
                                    gint drag_x,
                                    gint drag_y,
                                    GtkTreePath **path,
                                    GtkIconViewDropPosition *pos);

Определяет целевой элемент для заданной позиции.

Параметры

icon_view

a GtkIconView

drag_x

позиция для определения целевого элемента

drag_y

позиция для определения целевого элемента

path

Место возврата пути элемента или NULL.

[out][allow-none]

pos

Место возврата позиции опускания или NULL.

[out][allow-none]

Возвращаемое значение

указывает, существует ли элемент в данной позиции.

С: 2.8

gtk_icon_view_create_drag_icon ()

cairo_surface_t *
gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
                                GtkTreePath *path);

Создаёт представление элемента в позиции path в формате cairo_surface_t. Это изображение используется в качестве иконки перетаскивания.

Параметры

icon_view

a GtkIconView

path

a GtkTreePath в icon_view

Возвращаемое значение

новую выделенную поверхность иконки перетаскивания.

[transfer full]

С: 2.8

Типы и значения

struct GtkIconView

struct GtkIconView;

перечисление GtkIconViewDropPosition

Перечисление для определения места расположения опущенного элемента.

Члены

GTK_ICON_VIEW_NO_DROP

опускание невозможно

GTK_ICON_VIEW_DROP_INTO

опущенный элемент заменяет существующий

GTK_ICON_VIEW_DROP_LEFT

опущенный элемент вставляется слева

GTK_ICON_VIEW_DROP_RIGHT

опущенный элемент вставляется справа

GTK_ICON_VIEW_DROP_ABOVE

опущенный элемент вставляется сверху

GTK_ICON_VIEW_DROP_BELOW

опущенный элемент вставляется снизу

Подробное описание свойств

Свойство “activate-on-single-click”

  “activate-on-single-click” gboolean

Свойство activate-on-single-click определяет, будет ли сигнал «item-activated» испускаться после одиночного щелчка.

Владелец: GtkIconView

Флаги: Чтение / Запись

Значение по умолчанию: FALSE

С версии: 3.8

Свойство “cell-area”

  “cell-area”                GtkCellArea *

GtkCellArea, используемый для компоновки рендереров ячеек для этого представления.

Если при создании представления значков с помощью gtk_icon_view_new_with_area() область не указана, будет использован GtkCellAreaBox.

Владелец: GtkIconView

Флаги: Чтение / Запись / Только для конструирования

С версии: 3.0

Свойство “column-spacing”

  “column-spacing”           int

Свойство column-spacing задаёт расстояние между столбцами представления значков.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= 0

Значение по умолчанию: 6

С версии: 2.6

Свойство “columns”

  “columns”                  int

Свойство columns содержит количество столбцов, в которых должны отображаться элементы. Если оно равно -1, количество столбцов будет выбрано автоматически для заполнения доступной области.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

С версии: 2.6

Свойство “item-orientation”

  “item-orientation”         GtkOrientation

Свойство item-orientation определяет, как элементы (значок и текст) элемента размещаются относительно друг друга.

Владелец: GtkIconView

Флаги: Чтение / Запись

Значение по умолчанию: GTK_ORIENTATION_VERTICAL

С версии: 2.6

Свойство “item-padding”

  “item-padding”             int

Свойство item-padding определяет отступы вокруг каждого элемента представления значков.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= 0

Значение по умолчанию: 6

С версии: 2.18

Свойство “item-width”

  “item-width”               int

Свойство item-width задаёт ширину каждого элемента. Если оно установлено в -1, представление значков автоматически определит подходящий размер элемента.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

С версии: 2.6

Свойство “margin”

  “margin”                   int

Свойство margin задаёт отступы по краям представления значков.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= 0

Значение по умолчанию: 6

С версии: 2.6

Свойство “markup-column”

  “markup-column”            int

Свойство ::markup-column содержит номер столбца модели, содержащего информацию разметки, подлежащую отображению. Столбец разметки должен быть типа G_TYPE_STRING. Если это свойство и свойство :text-column установлены на номера столбцов, оно переопределяет столбец текста. Если оба установлены в -1, тексты не отображаются.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

С версии: 2.6

Свойство “model”

  “model”                    GtkTreeModel *

Модель представления значков.

Владелец: GtkIconView

Флаги: Чтение / Запись

Свойство “pixbuf-column”

  “pixbuf-column”            int

Свойство ::pixbuf-column содержит номер столбца модели, содержащего pixbuf, который отображается. Столбец pixbuf должен быть типа GDK_TYPE_PIXBUF. Установка этого свойства в -1 отключает отображение pixbuf.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

С версии: 2.6

Свойство “reorderable”

  “reorderable”              gboolean

Свойство reorderable указывает, можно ли переупорядочивать элементы с помощью DND.

Владелец: GtkIconView

Флаги: Чтение / Запись

Значение по умолчанию: FALSE

С версии: 2.8

Свойство “row-spacing”

  “row-spacing”              int

Свойство row-spacing определяет расстояние между строками представления значков.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= 0

Значение по умолчанию: 6

С версии: 2.6

Свойство “selection-mode”

  “selection-mode”           GtkSelectionMode

Свойство ::selection-mode определяет режим выбора представления значков. Если режим GTK_SELECTION_MULTIPLE, включена резиновая селекция, для других режимов возможен только выбор с клавиатуры.

Владелец: GtkIconView

Флаги: Чтение / Запись

Значение по умолчанию: GTK_SELECTION_SINGLE

С версии: 2.6

Свойство “spacing”

  “spacing”                  int

Свойство spacing определяет расстояние между ячейками (значком и текстом) элемента.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= 0

Значение по умолчанию: 0

С версии: 2.6

Свойство “text-column”

  “text-column”              int

Свойство ::text-column содержит номер столбца модели, содержащего тексты, которые отображаются. Столбец текста должен быть типа G_TYPE_STRING. Если это свойство и свойство :markup-column оба установлены в -1, тексты не отображаются.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

С версии: 2.6

Свойство “tooltip-column”

  “tooltip-column”           int

Столбец в модели, содержащий всплывающие подсказки для элементов.

Владелец: GtkIconView

Флаги: Чтение / Запись

Допустимые значения: >= -1

Значение по умолчанию: -1

Подробное описание свойств стиля

Свойство стиля “selection-box-alpha”

  “selection-box-alpha”      guchar

Непрозрачность рамки выделения.

GtkIconView:selection-box-alpha устарело с версии 3.20 и не должно использоваться в новом коде.

Непрозрачность рамки выделения определяется CSS; значение этого свойства стиля игнорируется.

Владелец: GtkIconView

Флаги: Чтение

Значение по умолчанию: 64

Свойство стиля “selection-box-color”

  “selection-box-color”      GdkColor *

Цвет рамки выделения.

GtkIconView:selection-box-color устарело с версии 3.20 и не должно использоваться в новом коде.

Цвет рамки выделения определяется CSS; значение этого свойства стиля игнорируется.

Владелец: GtkIconView

Флаги: Чтение

Подробности сигналов

Сигнал “activate-cursor-item”

gboolean
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал привязки клавиш, который генерируется при активации текущего выделенного элемента.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им необходимо программно управлять активацией.

По умолчанию для этого сигнала назначены клавиши Пробел, Возврат и Ввод.

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

Сигнал “item-activated”

void
user_function (GtkIconView *iconview,
               GtkTreePath *path,
               gpointer     user_data)

Сигнал ::item-activated генерируется, когда вызывается метод gtk_icon_view_item_activated(), когда пользователь дважды щелкает по элементу с установленным свойством "activate-on-single-click" в значение FALSE, или когда пользователь один раз щелкает по элементу, если свойство "activate-on-single-click" установлено в TRUE. Также он генерируется, когда нередактируемый элемент выбран и нажата одна из клавиш: Пробел, Возврат или Ввод.

Параметры

iconview

объект, на котором генерируется сигнал

path

GtkTreePath активированного элемента

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Выполнить последним

Сигнал “move-cursor”

gboolean
user_function (GtkIconView    *iconview,
               GtkMovementStep step,
               int             count,
               gpointer        user_data)

Сигнал ::move-cursor — это сигнал привязки клавиш, который генерируется, когда пользователь начинает перемещение курсора.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять курсором.

К стандартным привязкам для этого сигнала относятся:

  • Клавиши со стрелками, перемещающие курсор на один шаг

  • Клавиши Home/End, перемещающие курсор к первому/последнему элементу

  • Клавиши PageUp/PageDown, перемещающие курсор на «страницы». Все эти действия будут расширять выделение при одновременном нажатии клавиши Shift.

Параметры

iconview

объект, получивший сигнал

step

шаг перемещения, как GtkMovementStep

count

количество единиц step для перемещения

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

Сигнал “select-all”

void
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал привязки клавиш, который генерируется при выборе всех элементов.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять выделением.

По умолчанию для этого сигнала назначена клавиша Ctrl-a.

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

Сигнал “select-cursor-item”

void
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал привязки клавиш, который генерируется при выделении элемента, на котором сейчас находится фокус.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять выделением.

Для этого сигнала нет стандартной привязки.

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

Сигнал “selection-changed”

void
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал ::selection-changed генерируется при изменении выделения (т.е. набора выделенных элементов).

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Выполнить первым

Сигнал “toggle-cursor-item”

void
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал привязки клавиш, который генерируется при переключении выделения текущего элемента (выделено/не выделено). Точное действие зависит от режима выбора.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять выделением.

По умолчанию для этого сигнала нет привязки, но может быть Ctrl-Пробел.

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

Сигнал “unselect-all”

void
user_function (GtkIconView *iconview,
               gpointer     user_data)

Сигнал привязки клавиш, который генерируется при снятии выделения со всех элементов.

Приложения не должны подключаться к нему, но могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять выделением.

По умолчанию для этого сигнала назначена клавиша Ctrl-Shift-a.

Параметры

iconview

объект, на котором генерируется сигнал

user_data

пользовательские данные, заданные при подключении обработчика сигнала.

Флаги: Действие

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkIconView.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API