Spec-Zone.ru › GTK 3.22

GtkRecentChooser

GtkRecentChooser — Интерфейс, реализуемый виджетами, отображающими недавно использованные файлы

Функции

void gtk_recent_chooser_set_show_private ()
gboolean gtk_recent_chooser_get_show_private ()
void gtk_recent_chooser_set_show_not_found ()
gboolean gtk_recent_chooser_get_show_not_found ()
void gtk_recent_chooser_set_show_icons ()
gboolean gtk_recent_chooser_get_show_icons ()
void gtk_recent_chooser_set_select_multiple ()
gboolean gtk_recent_chooser_get_select_multiple ()
void gtk_recent_chooser_set_local_only ()
gboolean gtk_recent_chooser_get_local_only ()
void gtk_recent_chooser_set_limit ()
gint gtk_recent_chooser_get_limit ()
void gtk_recent_chooser_set_show_tips ()
gboolean gtk_recent_chooser_get_show_tips ()
void gtk_recent_chooser_set_sort_type ()
GtkRecentSortType gtk_recent_chooser_get_sort_type ()
gint (*GtkRecentSortFunc) ()
void gtk_recent_chooser_set_sort_func ()
gboolean gtk_recent_chooser_set_current_uri ()
gchar * gtk_recent_chooser_get_current_uri ()
GtkRecentInfo * gtk_recent_chooser_get_current_item ()
gboolean gtk_recent_chooser_select_uri ()
void gtk_recent_chooser_unselect_uri ()
void gtk_recent_chooser_select_all ()
void gtk_recent_chooser_unselect_all ()
GList * gtk_recent_chooser_get_items ()
gchar ** gtk_recent_chooser_get_uris ()
void gtk_recent_chooser_add_filter ()
void gtk_recent_chooser_remove_filter ()
GSList * gtk_recent_chooser_list_filters ()
void gtk_recent_chooser_set_filter ()
GtkRecentFilter * gtk_recent_chooser_get_filter ()

Свойства

GtkRecentFilter * filter Чтение / Запись
gint limit Чтение / Запись
gboolean только локальные Чтение / Запись
GtkRecentManager * recent-manager Только запись / только создание
gboolean выбор нескольких Чтение / Запись
gboolean отображать значки Чтение / Запись
gboolean показывать не найденные Чтение / Запись
gboolean показывать частные Чтение / Запись
gboolean показывать подсказки Чтение / Запись
GtkRecentSortType тип сортировки Чтение / Запись

Сигналы

void выбран элемент Выполнить в последнюю очередь
void изменен выбор Выполнить в последнюю очередь

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

GtkRecentChooser
struct GtkRecentChooserIface
#define GTK_RECENT_CHOOSER_ERROR
перечисление GtkRecentChooserError
перечисление 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

a GtkRecentChooser

show_private

TRUE для отображения частных элементов, FALSE в противном случае

С: 2.10

gtk_recent_chooser_get_show_private ()

gboolean
gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser);

Возвращает значение, определяющее, должен ли chooser отображать недавно использовавшиеся ресурсы, помеченные как частные.

Параметры

chooser

a 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

a 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

a 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

a GtkRecentChooser

show_icons

отображать ли значок рядом с ресурсом

С: 2.10

gtk_recent_chooser_get_show_icons ()

gboolean
gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser);

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

Параметры

chooser

a 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

a GtkRecentChooser

select_multiple

TRUE, если chooser можно выбрать более одного элемента

С: 2.10

gtk_recent_chooser_get_select-multiple ()

gboolean
gtk_recent_chooser_get_select_multiple
                               (GtkRecentChooser *chooser);

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

Параметры

chooser

a GtkRecentChooser

Возвращает

TRUE, если chooser можно выбрать более одного элемента.

С: 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

a GtkRecentChooser

local_only

TRUE, если должны отображаться только локальные файлы

С: 2.10

gtk_recent_chooser_get-local-only ()

gboolean
gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser);

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

Параметры

chooser

a 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

a 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

a GtkRecentChooser

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

Положительное целое число или -1, означающее, что возвращаются все элементы.

С версии: 2.10

gtk_recent_chooser_set_show_tips ()

void
gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser,
                                  gboolean show_tips);

Устанавливает отображение всплывающих подсказок, содержащих полный путь к каждому недавно используемому ресурсу в виджете GtkRecentChooser.

Параметры

chooser

a GtkRecentChooser

show_tips

TRUE, если всплывающие подсказки должны быть отображены

С версии: 2.10

gtk_recent_chooser_get_show_tips ()

gboolean
gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser);

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

Параметры

chooser

a 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

a 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

a 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

a GtkRecentChooser

sort_func

функция сравнения

sort_data

данные пользователя, передаваемые в sort_func, или NULL.

[allow-none]

data_destroy

указатель на функцию удаления sort_data, или NULL.

[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

a GtkRecentChooser

uri

URI

error

место возврата GError, или NULL.

[allow-none]

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

TRUE, если URI был найден.

С версии: 2.10

gtk_recent_chooser_get_current_uri ()

gchar *
gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser);

Получает URI, текущий выбранный chooser .

Параметры

chooser

a GtkRecentChooser

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

новый выделенный строковый URI.

С версии: 2.10

gtk_recent_chooser_get_current_item ()

GtkRecentInfo *
gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser);

Получает GtkRecentInfo, который в данный момент выбран chooser .

Параметры

chooser

a GtkRecentChooser

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

a 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

a GtkRecentChooser

uri

a URI

error

место для возвращаемой ошибки GError, или NULL.

[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

a GtkRecentChooser

uri

a URI

С: 2.10

gtk_recent_chooser_select_all ()

void
gtk_recent_chooser_select_all (GtkRecentChooser *chooser);

Выбирает все элементы внутри chooser, если chooser поддерживает множественный выбор.

Параметры

chooser

a GtkRecentChooser

С: 2.10

gtk_recent_chooser_unselect_all ()

void
gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser);

Снимает выделение со всех элементов внутри chooser.

Параметры

chooser

a GtkRecentChooser

С: 2.10

gtk_recent_chooser_get_items ()

GList *
gtk_recent_chooser_get_items (GtkRecentChooser *chooser);

Получает список недавно использованных ресурсов в виде объектов GtkRecentInfo.

Результат этой функции зависит от свойств «sort-type» и «limit» chooser.

Параметры

chooser

a GtkRecentChooser

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

Новый выделенный список объектов 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 недавно использованных ресурсов.

Результат этой функции зависит от свойств «sort-type» и «limit» chooser.

Так как возвращаемый массив завершается NULL, length может быть NULL.

Параметры

chooser

a GtkRecentChooser

length

место для возвращаемой длины списка URI, или NULL.

[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

a GtkRecentChooser

filter

a GtkRecentFilter

С: 2.10

gtk_recent_chooser_remove_filter ()

void
gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,
                                  GtkRecentFilter *filter);

Удаляет filter из списка объектов GtkRecentFilter, хранящихся в chooser.

Параметры

chooser

a GtkRecentChooser

filter

a GtkRecentFilter

С: 2.10

gtk_recent_chooser_list_filters ()

GSList *
gtk_recent_chooser_list_filters (GtkRecentChooser *chooser);

Получает объекты GtkRecentFilter, хранящиеся в chooser.

Параметры

chooser

a 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

a GtkRecentChooser

filter

a GtkRecentFilter.

[allow-none]

С: 2.10

gtk_recent_chooser_get_filter ()

GtkRecentFilter *
gtk_recent_chooser_get_filter (GtkRecentChooser *chooser);

Получает объект GtkRecentFilter, текущий используемый chooser для влияния на отображение недавно использованных ресурсов.

Параметры

chooser

a GtkRecentChooser

Возвращает

a GtkRecentFilter object.

[transfer none]

С: 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);
};

Члены

set_current_uri ()

Устанавливает uri в качестве текущего URI для chooser.

get_current_uri ()

Получает URI, текущий выбранный chooser.

select_uri ()

Выбирает uri внутри chooser.

unselect_uri ()

Снимает выделение с uri внутри chooser.

select_all ()

Выделяет все элементы внутри chooser, если chooser поддерживает множественный выбор.

unselect_all ()

Снимает выделение со всех элементов внутри chooser.

get_items ()

Получает список недавно использованных ресурсов в виде объектов GtkRecentInfo.

get_recent_manager ()

Получает GtkRecentManager, используемый chooser.

add_filter ()

Добавляет фильтр в список объектов GtkRecentFilter, хранящихся в chooser.

remove_filter ()

Удаляет фильтр из списка объектов GtkRecentFilter, хранящихся в chooser.

list_filters ()

Получает объекты GtkRecentFilter, хранящиеся в chooser.

set_sort_func ()

Устанавливает функцию сравнения, используемую при сортировке, на sort_func.

item_activated ()

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

selection_changed ()

Сигнал, испускаемый при изменении набора выбранных недавно использованных ресурсов.

GTK_RECENT_CHOOSER_ERROR

#define GTK_RECENT_CHOOSER_ERROR (gtk_recent_chooser_error_quark ())

Используется для получения кварки GError для ошибок GtkRecentChooser.

С: 2.10

enum GtkRecentChooserError

Эти идентификаторы различных ошибок, которые могут возникнуть при вызове функций GtkRecentChooser.

Члены

GTK_RECENT_CHOOSER_ERROR_NOT_FOUND

Указывает, что файл не существует

GTK_RECENT_CHOOSER_ERROR_INVALID_URI

Указывает некорректный URI

С: 2.10

enum GtkRecentSortType

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

Члены

GTK_RECENT_SORT_NONE

Не сортировать возвращаемый список недавно использованных ресурсов.

GTK_RECENT_SORT_MRU

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

GTK_RECENT_SORT_LRU

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

GTK_RECENT_SORT_CUSTOM

Сортировать возвращаемый список, используя пользовательскую функцию сортировки, переданную с помощью gtk_recent_chooser_set_sort_func().

С: 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

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

Флаги: Run Last

С версии: 2.10

Сигнал “selection-changed”

void
user_function (GtkRecentChooser *chooser,
               gpointer          user_data)

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

Параметры

chooser

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

user_data

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

Флаги: Run Last

С версии: 2.10

См. также

GtkRecentManager, GtkRecentChooserDialog, GtkRecentChooserWidget, GtkRecentChooserMenu

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

Spec-Zone.ru

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