GtkRecentChooser
GtkRecentChooser — Интерфейс, реализуемый виджетами, отображающими недавно использованные файлы
Функции
Свойства
| GtkRecentFilter * | filter | Чтение / Запись |
| int | limit | Чтение / Запись |
| gboolean | только_локальные | Чтение / Запись |
| GtkRecentManager * | менеджер_последних | Запись / Только для создания |
| gboolean | выбор_нескольких | Чтение / Запись |
| gboolean | показывать_иконки | Чтение / Запись |
| gboolean | показывать_ненайденные | Чтение / Запись |
| gboolean | показывать_личные | Чтение / Запись |
| gboolean | показывать_подсказки | Чтение / Запись |
| GtkRecentSortType | тип_сортировки | Чтение / Запись |
Сигналы
| void | активирован_элемент | Последний запуск |
| void | изменён_выбор | Последний запуск |
Типы и значения
| 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);
Определяет, следует ли отображать ресурсы, помеченные как частные.
Параметры
chooser | объект GtkRecentChooser | |
show_private |
|
С: 2.10
gtk_recent_chooser_get_show_private ()
gboolean
gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser); Возвращает, следует ли chooser отображать ресурсы, помеченные как частные.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
TRUE если отображать частные элементы, FALSE в противном случае.
С: 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 | объект GtkRecentChooser | |
show_not_found | отображать ли локальные элементы, которые не были найдены |
С: 2.10
gtk_recent_chooser_get_show_not_found ()
gboolean
gtk_recent_chooser_get_show_not_found (GtkRecentChooser *chooser); Возвращает, следует ли chooser отображать ресурсы, которые не были найдены.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
TRUE если отображать ресурсы, которые не были найдены, и FALSE в противном случае.
С: 2.10
gtk_recent_chooser_set_show_icons ()
void gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser,gboolean show_icons);
Устанавливает, следует ли chooser отображать значок рядом с ресурсом при отображении.
Параметры
chooser | объект GtkRecentChooser | |
show_icons | отображать ли значок рядом с ресурсом |
С: 2.10
gtk_recent_chooser_get_show_icons ()
gboolean
gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser); Возвращает, следует ли chooser отображать значок рядом с ресурсом.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
TRUE если значки должны отображаться, FALSE в противном случае.
С: 2.10
gtk_recent_chooser_set_select_multiple ()
void gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser,gboolean select_multiple);
Устанавливает, можно ли chooser выбрать несколько элементов.
Параметры
chooser | объект GtkRecentChooser | |
select_multiple |
|
С: 2.10
gtk_recent_chooser_get_select_multiple ()
gboolean
gtk_recent_chooser_get_select_multiple
(GtkRecentChooser *chooser); Получает, можно ли chooser выбрать несколько элементов.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
TRUE если можно выбрать более одного элемента.
С: 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 | объект GtkRecentChooser | |
local_only |
|
С: 2.10
gtk_recent_chooser_get_local_only ()
gboolean
gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser); Получает, должны ли отображаться только локальные ресурсы в селекторе недавно использованных ресурсов. См. gtk_recent_chooser_set_local_only()
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
TRUE если отображаются только локальные ресурсы.
С: 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 | объект GtkRecentChooser | |
limit | положительное целое число или -1 для всех элементов |
С: 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 |
|
Since: 2.10
gtk_recent_chooser_get_show_tips ()
gboolean
gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser); Получает, отображаются ли всплывающие подсказки, содержащие полный путь недавно использованного ресурса.
Параметры
chooser | виджет GtkRecentChooser |
Возвращаемое значение
TRUE если виджет должен отображать всплывающие подсказки, FALSE в противном случае.
Since: 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 | порядок сортировки, который должен использовать виджет |
Since: 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 .
Since: 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] |
Since: 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 | место для возврата GError, или | [allow-none] |
Возвращаемое значение
TRUE если URI был найден.
Since: 2.10
gtk_recent_chooser_get_current_uri ()
gchar *
gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser); Получает URI, текущий выбранный chooser .
Параметры
chooser | виджет GtkRecentChooser |
Возвращаемое значение
новая строка, содержащая URI.
Since: 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(), когда закончите использование.
Since: 2.10
gtk_recent_chooser_select-uri ()
gboolean gtk_recent_chooser_select_uri (GtkRecentChooser *chooser,const gchar *uri,GError **error);
Выбирает uri внутри chooser .
Параметры
chooser | виджет GtkRecentChooser | |
uri | URI | |
error | место для возврата GError, или | [allow-none] |
Возвращаемое значение
TRUE если uri был найден.
Since: 2.10
gtk_recent_chooser_unselect-uri ()
void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser,const gchar *uri);
Снимает выделение с uri внутри chooser .
Параметры
chooser | виджет GtkRecentChooser | |
uri | URI |
Since: 2.10
gtk_recent_chooser_select_all ()
void
gtk_recent_chooser_select_all (GtkRecentChooser *chooser); Выбирает все элементы внутри chooser, если chooser поддерживает множественный выбор.
Параметры
chooser | объект GtkRecentChooser |
С версии: 2.10
gtk_recent_chooser_unselect_all ()
void
gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser); Снимает выбор со всех элементов внутри chooser.
Параметры
chooser | объект GtkRecentChooser |
С версии: 2.10
gtk_recent_chooser_get_items ()
GList *
gtk_recent_chooser_get_items (GtkRecentChooser *chooser); Возвращает список недавно использованных ресурсов в виде объектов GtkRecentInfo.
Результат работы этой функции зависит от свойств «тип-сортировки» и «лимит» объекта chooser.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
Список объектов GtkRecentInfo, выделенный с помощью оператора new. Вы должны вызвать 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.
Так как возвращаемый массив завершается нулевым указателем, length может быть NULL.
Параметры
chooser | объект GtkRecentChooser | |
length | место для хранения длины списка URI, или | [out][allow-none] |
Возвращаемое значение
Новый выделенный массив строк, завершённый нулевым указателем. Используйте 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 | объект GtkRecentChooser | |
filter | объект GtkRecentFilter |
С версии: 2.10
gtk_recent_chooser_remove_filter ()
void gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Удаляет filter из списка объектов GtkRecentFilter, хранимых в chooser.
Параметры
chooser | объект GtkRecentChooser | |
filter | объект GtkRecentFilter |
С версии: 2.10
gtk_recent_chooser_list_filters ()
GSList *
gtk_recent_chooser_list_filters (GtkRecentChooser *chooser); Возвращает список объектов GtkRecentFilter, хранимых в chooser.
Параметры
chooser | объект GtkRecentChooser |
Возвращаемое значение
Список объектов 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 для выбора. | |
| Получает URI, текущий выбранный выбором. | |
| Выбирает uri внутри выбора. | |
| Снимает выделение с uri внутри выбора. | |
| Выделяет все элементы внутри выбора, если выбор поддерживает множественный выбор. | |
| Снимает выделение со всех элементов внутри выбора. | |
| Получает список недавно использованных ресурсов в виде объектов GtkRecentInfo. | |
| Получает GtkRecentManager, используемый выбором. | |
| Добавляет фильтр в список объектов GtkRecentFilter, хранящихся выбором. | |
| Удаляет фильтр из списка объектов GtkRecentFilter, хранящихся выбором. | |
| Получает объекты GtkRecentFilter, хранящиеся выбором. | |
| Устанавливает функцию сравнения, используемую при сортировке, в 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, используемый при отображении недавно использованных ресурсов.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
С версии: 2.10
Свойство “limit”
“limit” int
Максимальное количество недавно использованных ресурсов для отображения, или -1 для отображения всех элементов.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Допустимые значения: >= -1
Значение по умолчанию: 50
С версии: 2.10
Свойство “local-only”
“local-only” gboolean
Определяет, должен ли этот GtkRecentChooser отображать только локальные ресурсы (с префиксом file:).
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ИСТИНА
С версии: 2.10
Свойство “recent-manager”
“recent-manager” GtkRecentManager *
Экземпляр GtkRecentManager, используемый GtkRecentChooser для отображения списка недавно использованных ресурсов.
Владелец: GtkRecentChooser
Флаги: Запись / Только для создания
С версии: 2.10
Свойство “select-multiple”
“select-multiple” gboolean
Разрешить пользователю выбирать несколько ресурсов.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ЛОЖЬ
С версии: 2.10
Свойство “show-icons”
“show-icons” gboolean
Определяет, должен ли GtkRecentChooser отображать значок рядом с элементом.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ИСТИНА
С версии: 2.10
Свойство “show-not-found”
“show-not-found” gboolean
Определяет, должен ли GtkRecentChooser отображать недавно использованные ресурсы, даже если они больше не существуют. Установка в FALSE выполнит потенциально ресурсоёмкую проверку каждого локального ресурса (каждый удалённый ресурс всегда будет отображаться).
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ИСТИНА
С версии: 2.10
Свойство “show-private”
“show-private” gboolean
Определяет, должны ли отображаться личные элементы.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ЛОЖЬ
Свойство “show-tips”
“show-tips” gboolean
Определяет, должен ли GtkRecentChooser отображать всплывающую подсказку с полным путем недавно использованных ресурсов.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: ЛОЖЬ
С версии: 2.10
Свойство “sort-type”
“sort-type” GtkRecentSortType
Порядок сортировки, используемый при отображении недавно использованных ресурсов.
Владелец: GtkRecentChooser
Флаги: Чтение / Запись
Значение по умолчанию: GTK_RECENT_SORT_NONE
С версии: 2.10
Подробное описание сигналов
Сигнал “item-activated”
void user_function (GtkRecentChooser *chooser, gpointer user_data)
Этот сигнал генерируется, когда пользователь "активирует" недавний элемент в диалоге выбора недавних файлов. Это может произойти при двойном щелчке по элементу в списке недавно использованных ресурсов или при нажатии Enter.
Параметры
chooser | объект, получивший сигнал | |
user_data | данные пользователя, установленные при подключении обработчика сигнала. |
Флаги: Run Last
С версии: 2.10
Сигнал “selection-changed”
void user_function (GtkRecentChooser *chooser, gpointer user_data)
Этот сигнал генерируется, когда происходит изменение набора выбранных недавно использованных ресурсов. Это может произойти, когда пользователь изменяет выбор с помощью мыши или клавиатуры, или при явном вызове функций для изменения выбора.
Параметры
chooser | объект, получивший сигнал | |
user_data | данные пользователя, установленные при подключении обработчика сигнала. |
Флаги: Run Last
С версии: 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.24/GtkRecentChooser.html