GtkRecentChooser
GtkRecentChooser — Интерфейс, реализуемый виджетами, отображающими недавно использовавшиеся файлы
Функции
Свойства
| GtkRecentFilter * | filter | Чтение / Запись |
| gint | limit | Чтение / Запись |
| gboolean | local-only | Чтение / Запись |
| GtkRecentManager * | recent-manager | Запись / Только для создания |
| gboolean | select-multiple | Чтение / Запись |
| gboolean | show-icons | Чтение / Запись |
| gboolean | show-not-found | Чтение / Запись |
| gboolean | show-private | Чтение / Запись |
| gboolean | show-tips | Чтение / Запись |
| GtkRecentSortType | sort-type | Чтение / Запись |
Сигналы
Типы и значения
| GtkRecentChooser | |
| struct | GtkRecentChooserIface |
| #define | GTK_RECENT_CHOOSER_ERROR |
| enum | GtkRecentChooserError |
| enum | GtkRecentSortType |
Иерархия объектов
GInterface ╰── GtkRecentChooser
Предварительные условия
GtkRecentChooser требует GObject.
Известные реализации
GtkRecentChooser реализуется с помощью GtkRecentAction, GtkRecentChooserDialog, GtkRecentChooserMenu и GtkRecentChooserWidget.
Включения
#include <gtk/gtk.h>
Описание
GtkRecentChooser — это интерфейс, который могут реализовывать виджеты, отображающие список недавно используемых файлов. В GTK+, основные объекты, реализующие этот интерфейс, — это GtkRecentChooserWidget, GtkRecentChooserDialog и GtkRecentChooserMenu.
Поддержка недавно используемых файлов доступна начиная с GTK+ 2.10.
Функции
gtk_recent_chooser_set_show_private ()
void gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser,gboolean show_private);
Определяет, следует ли отображать недавно использованные ресурсы, помеченные как приватные.
Since: 2.10
gtk_recent_chooser_get_show_private ()
gboolean
gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser); Возвращает значение, определяющее, следует ли chooser отображать недавно использованные ресурсы, помеченные как приватные.
Параметры
chooser |
Возвращает
TRUE, если список недавно использованных ресурсов должен отображать приватные элементы, FALSE в противном случае.
Since: 2.10
gtk_recent_chooser_set_show_not_found ()
void gtk_recent_chooser_set_show_not_found (GtkRecentChooser *chooser,gboolean show_not_found);
Устанавливает, следует ли chooser отображать недавно использованные ресурсы, которые не были найдены. Это относится только к локальным ресурсам.
Параметры
chooser | ||
show_not_found | отображать ли локальные элементы, которые мы не нашли |
Since: 2.10
gtk_recent_chooser_get_show_not_found ()
gboolean
gtk_recent_chooser_get_show_not_found (GtkRecentChooser *chooser); Возвращает значение, определяющее, следует ли chooser отображать недавно использованные ресурсы, которые не были найдены.
Параметры
chooser |
Since: 2.10
gtk_recent_chooser_set_show_icons ()
void gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser,gboolean show_icons);
Устанавливает, следует ли chooser отображать значок рядом с ресурсом при его отображении.
Параметры
chooser | ||
show_icons | отображать ли значок рядом с ресурсом |
Since: 2.10
gtk_recent_chooser_get_show_icons ()
gboolean
gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser); Возвращает значение, определяющее, следует ли chooser отображать значок рядом с ресурсом.
Параметры
chooser |
Since: 2.10
gtk_recent_chooser_set_select-multiple ()
void gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser,gboolean select_multiple);
Устанавливает, можно ли chooser выбрать несколько элементов.
Параметры
chooser | ||
select_multiple |
|
Since: 2.10
gtk_recent_chooser_get_select-multiple ()
gboolean
gtk_recent_chooser_get_select_multiple
(GtkRecentChooser *chooser); Получает, можно ли chooser выбрать несколько элементов.
Параметры
chooser |
Возвращает
TRUE, если chooser можно выбрать более одного элемента.
Since: 2.10
gtk_recent_chooser_set_local_only ()
void gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser,gboolean local_only);
Устанавливает, следует ли отображать только локальные ресурсы (ресурсы, использующие схему URI file://) в списке недавно использованных ресурсов. Если local_only равно TRUE (по умолчанию), то отображаемые ресурсы гарантированно доступны через стандартную файловую систему операционной системы.
Параметры
chooser | ||
local_only |
|
Since: 2.10
gtk_recent_chooser_get_local_only ()
gboolean
gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser); Получает значение, определяющее, следует ли отображать только локальные ресурсы в списке недавно использованных ресурсов. См. gtk_recent_chooser_set_local_only()
Параметры
chooser |
Возвращает
TRUE, если следует отображать только локальные ресурсы.
Since: 2.10
gtk_recent_chooser_set_limit ()
void gtk_recent_chooser_set_limit (GtkRecentChooser *chooser,gint limit);
Устанавливает количество элементов, которые должны быть возвращены функциями gtk_recent_chooser_get_items() и gtk_recent_chooser_get_uris().
Параметры
chooser | ||
limit | положительное целое число или -1 для всех элементов |
Since: 2.10
gtk_recent_chooser_get_limit ()
gint
gtk_recent_chooser_get_limit (GtkRecentChooser *chooser); Возвращает количество элементов, возвращаемых функциями gtk_recent_chooser_get_items() и gtk_recent_chooser_get_uris().
Параметры
chooser | объект GtkRecentChooser |
Возвращает
Положительное целое число или -1, означающее, что возвращаются все элементы.
С версии: 2.10
gtk_recent_chooser_set_show_tips ()
void gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser,gboolean show_tips);
Устанавливает, следует ли отображать всплывающие подсказки, содержащие полный путь каждого недавно используемого ресурса в виджете GtkRecentChooser.
Параметры
chooser | объект GtkRecentChooser | |
show_tips |
|
С версии: 2.10
gtk_recent_chooser_get_show_tips ()
gboolean
gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser); Возвращает значение, определяющее, должен ли chooser отображать всплывающие подсказки, содержащие полный путь недавно использованного ресурса.
Параметры
chooser | объект GtkRecentChooser |
Возвращает
TRUE, если виджет выбора последних файлов должен отображать всплывающие подсказки, FALSE в противном случае.
С версии: 2.10
gtk_recent_chooser_set_sort_type ()
void gtk_recent_chooser_set_sort_type (GtkRecentChooser *chooser,GtkRecentSortType sort_type);
Изменяет порядок сортировки списка недавно использованных ресурсов, отображаемых chooser.
Параметры
chooser | объект GtkRecentChooser | |
sort_type | Порядок сортировки, который должен использовать виджет. |
С версии: 2.10
gtk_recent_chooser_get_sort_type ()
GtkRecentSortType
gtk_recent_chooser_get_sort_type (GtkRecentChooser *chooser); Возвращает значение, установленное функцией gtk_recent_chooser_set_sort_type().
Параметры
chooser | объект GtkRecentChooser |
Возвращает
Порядок сортировки chooser.
С версии: 2.10
GtkRecentSortFunc ()
gint (*GtkRecentSortFunc) (GtkRecentInfo *a,GtkRecentInfo *b,gpointer user_data);
gtk_recent_chooser_set_sort_func ()
void gtk_recent_chooser_set_sort_func (GtkRecentChooser *chooser,GtkRecentSortFunc sort_func,gpointer sort_data,GDestroyNotify data_destroy);
Устанавливает функцию сравнения, используемую при сортировке, равной sort_func. Если тип сортировки в chooser установлен в GTK_RECENT_SORT_CUSTOM, то виджет будет сортировать с использованием этой функции.
Функции сравнения будут переданы две структуры GtkRecentInfo и sort_data; sort_func должна вернуть положительное целое число, если первый элемент предшествует второму, ноль, если два элемента равны, и отрицательное целое число, если первый элемент следует за вторым.
Параметры
chooser | объект GtkRecentChooser | |
sort_func | функция сравнения | |
sort_data | пользовательские данные, передаваемые функции | [allow-none] |
data_destroy | указатель на функцию уничтожения данных | [allow-none] |
С версии: 2.10
gtk_recent_chooser_set_current_uri ()
gboolean gtk_recent_chooser_set_current_uri (GtkRecentChooser *chooser,const gchar *uri,GError **error);
Устанавливает uri в качестве текущего URI для chooser.
Параметры
chooser | объект GtkRecentChooser | |
uri | URI | |
error | [allow-none] |
Возвращает
TRUE, если URI был найден.
С версии: 2.10
gtk_recent_chooser_get_current_uri ()
gchar *
gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser); Возвращает URI, текущий выбранный chooser.
Параметры
chooser | объект GtkRecentChooser |
Возвращает
новая строка, содержащая URI.
С версии: 2.10
gtk_recent_chooser_get_current_item ()
GtkRecentInfo *
gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser); Возвращает GtkRecentInfo, текущий выбранный chooser.
Параметры
chooser | объект GtkRecentChooser |
Возвращает
объект GtkRecentInfo. Используйте gtk_recent_info_unref(), когда закончите его использование.
С версии: 2.10
gtk_recent_chooser_select_uri ()
gboolean gtk_recent_chooser_select_uri (GtkRecentChooser *chooser,const gchar *uri,GError **error);
Выбирает uri внутри chooser.
Параметры
chooser | ||
uri | URI | |
error | [allow-none] |
Возвращаемое значение
TRUE, если uri был найден.
С: 2.10
gtk_recent_chooser_unselect_uri ()
void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser,const gchar *uri);
Отменяет выбор uri внутри chooser.
Параметры
chooser | ||
uri | URI |
С: 2.10
gtk_recent_chooser_select_all ()
void
gtk_recent_chooser_select_all (GtkRecentChooser *chooser); Выбирает все элементы внутри chooser, если chooser поддерживает множественный выбор.
Параметры
chooser |
С: 2.10
gtk_recent_chooser_unselect_all ()
void
gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser); Отменяет выбор всех элементов внутри chooser.
Параметры
chooser |
С: 2.10
gtk_recent_chooser_get_items ()
GList *
gtk_recent_chooser_get_items (GtkRecentChooser *chooser); Возвращает список недавно использованных ресурсов в виде объектов GtkRecentInfo.
Результат работы этой функции зависит от свойств «тип-сортировки» и «предел» chooser.
Параметры
chooser |
Возвращаемое значение
Новый список объектов GtkRecentInfo. Вы должны вызвать gtk_recent_info_unref() для каждого элемента списка, а затем освободить сам список с помощью g_list_free().
[element-type GtkRecentInfo][transfer full]
С: 2.10
gtk_recent_chooser_get_uris ()
gchar ** gtk_recent_chooser_get_uris (GtkRecentChooser *chooser,gsize *length);
Возвращает URI недавно использованных ресурсов.
Результат работы этой функции зависит от свойств «тип-сортировки» и «предел» chooser.
Возвращаемый массив завершается NULL, поэтому length может быть NULL.
Параметры
chooser | ||
length | место для возвращаемой длины списка URI, или | [out][allow-none] |
Возвращаемое значение
Новый, завершающийся NULL массив строк. Используйте g_strfreev() для его освобождения.
[array length=length zero-terminated=1][transfer full]
С: 2.10
gtk_recent_chooser_add_filter ()
void gtk_recent_chooser_add_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Добавляет filter в список объектов GtkRecentFilter, содержащихся в chooser.
Если ранее не было определено никаких фильтров, эта функция вызовет gtk_recent_chooser_set_filter().
Параметры
chooser | ||
filter |
С: 2.10
gtk_recent_chooser_remove_filter ()
void gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Удаляет filter из списка объектов GtkRecentFilter, хранящихся в chooser.
Параметры
chooser | ||
filter |
С: 2.10
gtk_recent_chooser_list_filters ()
GSList *
gtk_recent_chooser_list_filters (GtkRecentChooser *chooser); Возвращает объекты GtkRecentFilter, хранящиеся в chooser.
Параметры
chooser |
Возвращаемое значение
Список объектов GtkRecentFilter. Вы должны освободить полученный список с помощью g_slist_free().
[element-type GtkRecentFilter][transfer container]
С: 2.10
gtk_recent_chooser_set_filter ()
void gtk_recent_chooser_set_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Устанавливает filter в качестве текущего объекта GtkRecentFilter, используемого chooser для управления отображением недавно использованных ресурсов.
Параметры
chooser | объект GtkRecentChooser | |
filter | объект GtkRecentFilter. | [allow-none] |
С: 2.10
gtk_recent_chooser_get_filter ()
GtkRecentFilter *
gtk_recent_chooser_get_filter (GtkRecentChooser *chooser); Получает объект GtkRecentFilter, используемый chooser для управления отображением недавно использованных ресурсов.
Параметры
chooser | объект GtkRecentChooser |
С: 2.10
Типы и значения
GtkRecentChooser
typedef struct _GtkRecentChooser GtkRecentChooser;
struct GtkRecentChooserIface
struct GtkRecentChooserIface {
/*
* Methods
*/
gboolean (* set_current_uri) (GtkRecentChooser *chooser,
const gchar *uri,
GError **error);
gchar * (* get_current_uri) (GtkRecentChooser *chooser);
gboolean (* select_uri) (GtkRecentChooser *chooser,
const gchar *uri,
GError **error);
void (* unselect_uri) (GtkRecentChooser *chooser,
const gchar *uri);
void (* select_all) (GtkRecentChooser *chooser);
void (* unselect_all) (GtkRecentChooser *chooser);
GList * (* get_items) (GtkRecentChooser *chooser);
GtkRecentManager *(* get_recent_manager) (GtkRecentChooser *chooser);
void (* add_filter) (GtkRecentChooser *chooser,
GtkRecentFilter *filter);
void (* remove_filter) (GtkRecentChooser *chooser,
GtkRecentFilter *filter);
GSList * (* list_filters) (GtkRecentChooser *chooser);
void (* set_sort_func) (GtkRecentChooser *chooser,
GtkRecentSortFunc sort_func,
gpointer sort_data,
GDestroyNotify data_destroy);
/*
* Signals
*/
void (* item_activated) (GtkRecentChooser *chooser);
void (* selection_changed) (GtkRecentChooser *chooser);
};
Члены
| Устанавливает uri в качестве текущего URI для chooser. | |
| Возвращает URI, текущий выбранный в chooser. | |
| Выделяет uri внутри chooser. | |
| Снимает выделение с uri внутри chooser. | |
| Выделяет все элементы внутри chooser, если chooser поддерживает множественный выбор. | |
| Снимает выделение со всех элементов внутри chooser. | |
| Возвращает список недавно использованных ресурсов в виде объектов GtkRecentInfo. | |
| Возвращает GtkRecentManager, используемый chooser. | |
| Добавляет filter в список объектов GtkRecentFilter, хранимых в chooser. | |
| Удаляет filter из списка объектов GtkRecentFilter, хранимых в chooser. | |
| Получает список объектов GtkRecentFilter, хранимых в chooser. | |
| Устанавливает функцию сравнения для сортировки, которая будет использоваться sort_func. | |
| Сигнал, генерируемый, когда пользователь активирует элемент из списка недавно использованных ресурсов. | |
| Сигнал, генерируемый при изменении набора выбранных недавно использованных ресурсов. |
GTK_RECENT_CHOOSER_ERROR
#define GTK_RECENT_CHOOSER_ERROR (gtk_recent_chooser_error_quark ())
Используется для получения кворка GError для ошибок функции GtkRecentChooser.
С: 2.10
Перечисление GtkRecentChooserError
Эти значения идентифицируют различные ошибки, которые могут возникнуть при вызове функций GtkRecentChooser.
Члены
GTK_RECENT_CHOOSER_ERROR_NOT_FOUND | Указывает, что файла не существует. | |
GTK_RECENT_CHOOSER_ERROR_INVALID_URI | Указывает некорректный URI. |
С: 2.10
Перечисление GtkRecentSortType
Используется для указания метода сортировки списка недавно использованных ресурсов.
Члены
GTK_RECENT_SORT_NONE | Список недавно использованных ресурсов не сортируется. | |
GTK_RECENT_SORT_MRU | Список сортируется по принципу «последний использован — сверху». | |
GTK_RECENT_SORT_LRU | Список сортируется по принципу «менее недавно использован — сверху». | |
GTK_RECENT_SORT_CUSTOM | Список сортируется с помощью пользовательской функции сортировки, переданной через |
С: 2.10
Подробное описание свойств
Свойство “filter”
“filter” GtkRecentFilter *
Объект GtkRecentFilter, используемый при отображении недавно используемых ресурсов.
Флаги: Чтение / Запись
С версии: 2.10
Свойство “limit”
“limit” gint
Максимальное количество недавно используемых ресурсов для отображения, или -1 для отображения всех элементов.
Флаги: Чтение / Запись
Допустимые значения: >= -1
Значение по умолчанию: 50
С версии: 2.10
Свойство “local-only”
“local-only” gboolean
Определяет, должен ли этот GtkRecentChooser отображать только локальные ресурсы (типа file:).
Флаги: Чтение / Запись
Значение по умолчанию: TRUE
С версии: 2.10
Свойство “recent-manager”
“recent-manager” GtkRecentManager *
Экземпляр GtkRecentManager, используемый GtkRecentChooser для отображения списка недавно используемых ресурсов.
Флаги: Запись / Только для создания
С версии: 2.10
Свойство “select-multiple”
“select-multiple” gboolean
Разрешить пользователю выбирать несколько ресурсов.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
С версии: 2.10
Свойство “show-icons”
“show-icons” gboolean
Определяет, должен ли этот GtkRecentChooser отображать значок рядом с элементом.
Флаги: Чтение / Запись
Значение по умолчанию: TRUE
С версии: 2.10
Свойство “show-not-found”
“show-not-found” gboolean
Определяет, должен ли этот GtkRecentChooser отображать недавно используемые ресурсы, даже если они больше не доступны. Установка этого значения в FALSE выполнит потенциально дорогостоящую проверку каждого локального ресурса (каждый удалённый ресурс всегда будет отображаться).
Флаги: Чтение / Запись
Значение по умолчанию: TRUE
С версии: 2.10
Свойство “show-private”
“show-private” gboolean
Отображать ли приватные элементы.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
Свойство “show-tips”
“show-tips” gboolean
Определяет, должен ли этот GtkRecentChooser отображать всплывающую подсказку, содержащую полный путь к недавно используемым ресурсам.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
С версии: 2.10
Свойство “sort-type”
“sort-type” GtkRecentSortType
Порядок сортировки, используемый при отображении недавно используемых ресурсов.
Флаги: Чтение / Запись
Значение по умолчанию: GTK_RECENT_SORT_NONE
С версии: 2.10
Подробное описание сигналов
Сигнал “item-activated”
void user_function (GtkRecentChooser *chooser, gpointer user_data)
Этот сигнал генерируется, когда пользователь "активирует" недавний элемент в окне выбора. Это может произойти при двойном щелчке по элементу в списке недавно используемых ресурсов или нажатии Enter.
Параметры
chooser | объект, получивший сигнал | |
user_data | пользовательские данные, заданные при подключении обработчика сигнала. |
Флаги: Запускать последним
С версии: 2.10
Сигнал “selection-changed”
void user_function (GtkRecentChooser *chooser, gpointer user_data)
Этот сигнал генерируется, когда изменяется набор выбранных недавно используемых ресурсов. Это может произойти, когда пользователь изменяет выбор мышкой или клавиатурой, или при явном вызове функций для изменения выбора.
Параметры
chooser | объект, получивший сигнал | |
user_data | пользовательские данные, заданные при подключении обработчика сигнала. |
Флаги: Запускать последним
С версии: 2.10
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.20/GtkRecentChooser.html