Prev

Up

Home

GTK+ Reference Manual

Next

Top  |  Description  |  Object Hierarchy  |   |  Known Implementations  |  Properties  |  Signals

GtkRecentChooser

GtkRecentChooser Интерфейс реализуемый GtkRecentChooserWidget, GtkRecentChooserMenu и GtkRecentChooserDialog

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

#include <gtk/gtk.h> GtkRecentChooser; GtkRecentChooserIface; #define GTK_RECENT_CHOOSER_ERROR enum GtkRecentChooserError; void gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser, gboolean show_private); gboolean gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser); void gtk_recent_chooser_set_show_not_found (GtkRecentChooser *chooser, gboolean show_not_found); gboolean gtk_recent_chooser_get_show_not_found (GtkRecentChooser *chooser); void gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser, gboolean show_icons); gboolean gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser); void gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser, gboolean select_multiple); gboolean gtk_recent_chooser_get_select_multiple (GtkRecentChooser *chooser); void gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser, gboolean local_only); gboolean gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser); void gtk_recent_chooser_set_limit (GtkRecentChooser *chooser, gint limit); gint gtk_recent_chooser_get_limit (GtkRecentChooser *chooser); void gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser, gboolean show_tips); gboolean gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser); void gtk_recent_chooser_set_show_numbers (GtkRecentChooser *chooser, gboolean show_numbers); gboolean gtk_recent_chooser_get_show_numbers (GtkRecentChooser *chooser); enum GtkRecentSortType; void gtk_recent_chooser_set_sort_type (GtkRecentChooser *chooser, GtkRecentSortType sort_type); GtkRecentSortType gtk_recent_chooser_get_sort_type (GtkRecentChooser *chooser); gint (*GtkRecentSortFunc) (GtkRecentInfo *a, GtkRecentInfo *b, gpointer user_data); void gtk_recent_chooser_set_sort_func (GtkRecentChooser *chooser, GtkRecentSortFunc sort_func, gpointer sort_data, GDestroyNotify data_destroy); gboolean gtk_recent_chooser_set_current_uri (GtkRecentChooser *chooser, const gchar *uri, GError **error); gchar* gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser); GtkRecentInfo* gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser); gboolean gtk_recent_chooser_select_uri (GtkRecentChooser *chooser, const gchar *uri, GError **error); void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser, const gchar *uri); void gtk_recent_chooser_select_all (GtkRecentChooser *chooser); void gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser); GList* gtk_recent_chooser_get_items (GtkRecentChooser *chooser); gchar** gtk_recent_chooser_get_uris (GtkRecentChooser *chooser, gsize *length); void gtk_recent_chooser_add_filter (GtkRecentChooser *chooser, GtkRecentFilter *filter); void gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser, GtkRecentFilter *filter); GSList* gtk_recent_chooser_list_filters (GtkRecentChooser *chooser); void gtk_recent_chooser_set_filter (GtkRecentChooser *chooser, GtkRecentFilter *filter); GtkRecentFilter* gtk_recent_chooser_get_filter (GtkRecentChooser *chooser);

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

GInterface +----GtkRecentChooser

Предварительные условия

GtkRecentChooser требует GtkObject.

Известные реализации

GtkRecentChooser реализован в GtkRecentChooserDialog, GtkRecentChooserWidget и GtkRecentChooserMenu.

Свойства

"filter" GtkRecentFilter : Read / Write "limit" gint : Read / Write "local-only" gboolean : Read / Write "recent-manager" GtkRecentManager : Write / Construct Only "select-multiple" gboolean : Read / Write "show-icons" gboolean : Read / Write "show-not-found" gboolean : Read / Write "show-private" gboolean : Read / Write "show-tips" gboolean : Read / Write "sort-type" GtkRecentSortType : Read / Write

Сигналы

"item-activated" void user_function (GtkRecentChooser *chooser, gpointer user_data) : Run last "selection-changed" void user_function (GtkRecentChooser *chooser, gpointer user_data) : Run last

Описание

GtkRecentChooser это интерфейс который может быть реализован виджетами отображающими списки недавно использованных файлов. В GTK+, основными объектами реализующими этот интерфейс являются GtkRecentChooserWidget, GtkRecentChooserDialog и GtkRecentChooserMenu.

Недавно использованные файлы поддерживаются начиная с версии GTK+ 2.10.

Детали

GtkRecentChooser

typedef struct _GtkRecentChooser GtkRecentChooser;

GtkRecentChooserIface

typedef struct { GTypeInterface base_iface; /* * Методы */ 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 data, GDestroyNotify destroy); /* * Сигналы */ void (* item_activated) (GtkRecentChooser *chooser); void (* selection_changed) (GtkRecentChooser *chooser); } GtkRecentChooserIface;

GTK_RECENT_CHOOSER_ERROR

#define GTK_RECENT_CHOOSER_ERROR        (gtk_recent_chooser_error_quark ())

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


enum GtkRecentChooserError

typedef enum { GTK_RECENT_CHOOSER_ERROR_NOT_FOUND, GTK_RECENT_CHOOSER_ERROR_INVALID_URI } GtkRecentChooserError;

Идентифицирует вариант ошибки которая может произойти во время выполнения функций GtkRecentChooser.

GTK_RECENT_CHOOSER_ERROR_NOT_FOUND

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

GTK_RECENT_CHOOSER_ERROR_INVALID_URI

Указывает на неправильный URI


gtk_recent_chooser_set_show_private ()

void gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser, gboolean show_private);

Показывается ли недавно использованный ресурс зарегистрированный как закрытый.

chooser :

GtkRecentChooser

show_private :

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

Начиная с версии 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 :

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

Начиная с версии 2.10


gtk_recent_chooser_get_select_multiple ()

gboolean gtk_recent_chooser_get_select_multiple (GtkRecentChooser *chooser);

Определяет может ли chooser выделять множество элементов.

chooser :

GtkRecentChooser

Возвращает :

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

Начиная с версии 2.10


gtk_recent_chooser_set_local_only ()

void gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser, gboolean local_only);

Устанавливает должны ли показываться только локальные ресурсы, которые являются ресурсами использующими схему file://URI, в селекторе недавно использованных ресурсов. Если local_only это TRUE (по умолчанию) то когда отображаемые ресурсы гарантировано будут доступны через родную файловую систему.

chooser :

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 :

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);

Устанавливает показываются ли подсказки в виджете.

chooser :

GtkRecentChooser

show_tips :

TRUE если подсказки должны показываться

Начиная с версии 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_show_numbers ()

void gtk_recent_chooser_set_show_numbers (GtkRecentChooser *chooser, gboolean show_numbers);

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

Не используйте эту функцию: используйте gtk_recent_chooser_menu_set_show_numbers() вместо неё.

chooser :

GtkRecentChooser

show_numbers :

TRUE для отображения номера, иначе FALSE

Начиная с версии 2.10


gtk_recent_chooser_get_show_numbers ()

gboolean gtk_recent_chooser_get_show_numbers (GtkRecentChooser *chooser);

Определяет показывается ли номер ресурса в chooser.

Не используйте эту функцию: используйте вместо неё gtk_recent_chooser_menu_get_show_numbers().

chooser :

GtkRecentChooser

Возвращает :

TRUE если селектор должен показывать номер, иначе FALSE.

Начиная с версии 2.10


enum GtkRecentSortType

typedef enum { GTK_RECENT_SORT_NONE = 0, GTK_RECENT_SORT_MRU, GTK_RECENT_SORT_LRU, GTK_RECENT_SORT_CUSTOM } GtkRecentSortType;

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

GTK_RECENT_SORT_NONE

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

GTK_RECENT_SORT_MRU

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

GTK_RECENT_SORT_LRU

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

GTK_RECENT_SORT_CUSTOM

Сортировать список используя функцию выборочной сортировки переданную в gtk_recent_manager_set_sort_func().


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);

a :

b :

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 :

Пользовательские данные помещаемые в sort_func, или NULL

data_destroy :

Разрушающее уведомление для sort_data, или NULL

Начиная с версии 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, или NULL

Возвращает :

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 :

GtkRecentChooser

uri :

URI

error :

Место для хранения возвращаемого GError, или NULL

Возвращает :

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

Начиная с версии 2.10


gtk_recent_chooser_unselect_uri ()

void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser, const gchar *uri);

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

chooser :

GtkRecentChooser

uri :

URI

Начиная с версии 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 объектов.

На возвращаемое значение этой функции влияют свойства "sort-type" и "limit" chooser.

chooser :

GtkRecentChooser

Возвращает :

Список объектов GtkRecentInfo. Вы должны использовать gtk_recent_info_unref() для всех элементов списка, а после этого освободить сам список с помощью g_list_free().

Начиная с версии 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 :

GtkRecentChooser

length :

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

Возвращает :

NULL завершённый массив строк. Используйте g_strfreev() для его освобождения.

Начиная с версии 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().

Начиная с версии 2.10


gtk_recent_chooser_set_filter ()

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

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

chooser :

GtkRecentChooser

filter :

GtkRecentFilter

Начиная с версии 2.10


gtk_recent_chooser_get_filter ()

GtkRecentFilter* gtk_recent_chooser_get_filter (GtkRecentChooser *chooser);

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

chooser :

GtkRecentChooser

Возвращает :

GtkRecentFilter объект.

Начиная с версии 2.10

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

Свойство "filter"

  "filter"               GtkRecentFilter       : Read / Write

Текущий фильтр выделения отображаемых ресурсов.


Свойство "limit"

  "limit"                gint                  : Read / Write

Максимальное количество элементов для отображения.

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

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


Свойство "local-only"

  "local-only"           gboolean              : Read / Write

Лимитировано ли выделение только локальными ресурсами file://URIs.

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


Свойство "recent-manager"

  "recent-manager"       GtkRecentManager      : Write / Construct Only

Используемый объект RecentManager.


Свойство "select-multiple"

  "select-multiple"      gboolean              : Read / Write

Разрешено ли множественное выделение.

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


Свойство "show-icons"

  "show-icons"           gboolean              : Read / Write

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

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


Свойство "show-not-found"

  "show-not-found"       gboolean              : Read / Write

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

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


Свойство "show-private"

  "show-private"         gboolean              : Read / Write

Должны ли отображаться закрытые ресурсы.

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


Свойство "show-tips"

  "show-tips"            gboolean              : Read / Write

Должны ли элементы иметь подсказки.

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


Свойство "sort-type"

  "sort-type"            GtkRecentSortType     : Read / Write

Порядок сортировки отображаемых элементов.

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

Детали сигналов

Сигнал "item-activated"

void user_function (GtkRecentChooser *chooser, gpointer user_data) : Run last

Этот сигнал издаётся когда пользователь активизирует элемент в селекторе недавно использованных ресурсов. Это может произойти при двойном нажатии (double-clicking) на элементе в списке недавно использованных ресурсов, или нажатием клавиши Enter.

chooser :

Объект получающий сигнал

user_data :

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

Начиная с версии 2.10


Сигнал "selection-changed"

void user_function (GtkRecentChooser *chooser, gpointer user_data) : Run last

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

chooser :

Объект получающий сигнал

user_data :

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

Начиная с версии 2.10

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

GtkRecentManager, GtkRecentChooserDialog, GtkRecentChooserWidget, GtkRecentChooserMenu