Spec-Zone.ru › GTK 3.20

GtkEntryCompletion

GtkEntryCompletion — Функциональность автозаполнения для GtkEntry

Функции

gboolean (*GtkEntryCompletionMatchFunc) ()
GtkEntryCompletion * gtk_entry_completion_new ()
GtkEntryCompletion * gtk_entry_completion_new_with_area ()
GtkWidget * gtk_entry_completion_get_entry ()
void gtk_entry_completion_set_model ()
GtkTreeModel * gtk_entry_completion_get_model ()
void gtk_entry_completion_set_match_func ()
void gtk_entry_completion_set_minimum_key_length ()
gint gtk_entry_completion_get_minimum_key_length ()
gchar * gtk_entry_completion_compute_prefix ()
void gtk_entry_completion_complete ()
const gchar * gtk_entry_completion_get_completion_prefix ()
void gtk_entry_completion_insert_prefix ()
void gtk_entry_completion_insert_action_text ()
void gtk_entry_completion_insert_action_markup ()
void gtk_entry_completion_delete_action ()
void gtk_entry_completion_set_text_column ()
gint gtk_entry_completion_get_text_column ()
void gtk_entry_completion_set_inline_completion ()
gboolean gtk_entry_completion_get_inline_completion ()
void gtk_entry_completion_set_inline_selection ()
gboolean gtk_entry_completion_get_inline_selection ()
void gtk_entry_completion_set_popup_completion ()
gboolean gtk_entry_completion_get_popup_completion ()
void gtk_entry_completion_set_popup_set_width ()
gboolean gtk_entry_completion_get_popup_set_width ()
void gtk_entry_completion_set_popup_single_match ()
gboolean gtk_entry_completion_get_popup_single_match ()

Свойства

GtkCellArea * cell-area Чтение / Запись / Только для создания
gboolean inline-completion Чтение / Запись
gboolean inline-selection Чтение / Запись
gint minimum-key-length Чтение / Запись
GtkTreeModel * model Чтение / Запись
gboolean popup-completion Чтение / Запись
gboolean popup-set-width Чтение / Запись
gboolean popup-single-match Чтение / Запись
gint text-column Чтение / Запись

Сигналы

void action-activated Выполнить последним
gboolean cursor-on-match Выполнить последним
gboolean insert-prefix Выполнить последним
gboolean match-selected Выполнить последним
void no-matches Выполнить последним

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

struct GtkEntryCompletion

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

    GObject
    ╰── GtkEntryCompletion

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

GtkEntryCompletion реализует GtkCellLayout и GtkBuildable.

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

#include <gtk/gtk.h>

Описание

GtkEntryCompletion — вспомогательный объект, используемый совместно с GtkEntry для предоставления функциональности автозаполнения. Он реализует интерфейс GtkCellLayout, что позволяет пользователю добавлять дополнительные ячейки в GtkTreeView с совпадающими результатами автозаполнения.

«Функциональность автозаполнения» означает, что при изменении текста пользователем объект GtkEntryCompletion проверяет, какие строки в модели соответствуют текущему содержимому поля ввода, и отображает список совпадений. По умолчанию сопоставление выполняется путем сравнения текста поля ввода без учета регистра с текстовой колонкой модели (см. gtk_entry_completion_set_text_column()), но это можно переопределить с помощью пользовательской функции сопоставления (см. gtk_entry_completion_set_match_func()).

При выборе совпадения содержимое поля ввода обновляется. По умолчанию содержимое поля ввода заменяется на текстовую колонку модели, но это можно переопределить, подключившись к сигналу “match-selected” и обновляя поле ввода в обработчике сигнала. Обратите внимание, что вы должны вернуть TRUE из обработчика сигнала, чтобы подавить стандартное поведение.

Для добавления функциональности автозаполнения в поле ввода используйте gtk_entry_set_completion().

Помимо обычных совпадений автозаполнения, которые будут вставлены в поле ввода при их выборе, GtkEntryCompletion также позволяет отображать «действия» в всплывающем окне. Их внешний вид похож на пункты меню, чтобы четко отличать их от строк совпадений. При выборе действия генерируется сигнал “action-activated”.

GtkEntryCompletion использует модель GtkTreeModelFilter для представления подмножества всей модели, которое в настоящее время соответствует искомому. Хотя сигналы GtkEntryCompletion “match-selected” и “cursor-on-match” принимают исходную модель и итератор, указывающий на эту модель в качестве аргументов, другие обратные вызовы и сигналы (например, GtkCellLayoutDataFuncs или “apply-attributes”) обычно принимают модель фильтра в качестве аргумента. Поскольку вы только вызываете gtk_tree_model_get(), это не повлияет на вас. Если по какой-либо причине вам нужна исходная модель, используйте gtk_tree_model_filter_get_model(). Не забудьте использовать gtk_tree_model_filter_convert_iter_to_child_iter() для получения совпадающего итератора.

Функции

GtkEntryCompletionMatchFunc ()

gboolean
(*GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion,
                                const gchar *key,
                                GtkTreeIter *iter,
                                gpointer user_data);

Функция, определяющая, соответствует ли строка, указанная в iter, заданному key и должна ли она отображаться в качестве возможного дополнения для key. Обратите внимание, что key нормализована и приведена к нижнему регистру (см. g_utf8_normalize() и g_utf8_casefold()). Если это не подходит, функции сопоставления имеют доступ к исходному ключу через gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry())).

Параметры

completion

объект GtkEntryCompletion

key

строка для сопоставления, нормализованная и приведённая к нижнему регистру

iter

GtkTreeIter, указывающая на строку для сопоставления

user_data

пользовательские данные, переданные в gtk_entry_completion_set_match_func()

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

TRUE, если iter должна отображаться в качестве возможного дополнения для key

gtk_entry_completion_new ()

GtkEntryCompletion *
gtk_entry_completion_new (void);

Создаёт новый объект GtkEntryCompletion.

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

Созданный объект GtkEntryCompletion

С: 2.4

gtk_entry_completion_new_with_area ()

GtkEntryCompletion *
gtk_entry_completion_new_with_area (GtkCellArea *area);

Создаёт новый объект GtkEntryCompletion, используя указанный area для выравнивания ячеек во внутреннем GtkTreeViewColumn раскрывающегося меню.

Параметры

area

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

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

Созданный объект GtkEntryCompletion

С: 3.0

gtk_entry_completion_get_entry ()

GtkWidget *
gtk_entry_completion_get_entry (GtkEntryCompletion *completion);

Возвращает поле, к которому прикреплён completion.

Параметры

completion

объект GtkEntryCompletion

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

Поле, к которому прикреплён completion.

[transfer none]

С: 2.4

gtk_entry_completion_set_model ()

void
gtk_entry_completion_set_model (GtkEntryCompletion *completion,
                                GtkTreeModel *model);

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

Параметры

completion

объект GtkEntryCompletion

model

GtkTreeModel.

[allow-none]

С: 2.4

gtk_entry_completion_get_model ()

GtkTreeModel *
gtk_entry_completion_get_model (GtkEntryCompletion *completion);

Возвращает модель, используемую объектом GtkEntryCompletion в качестве источника данных. Возвращает NULL, если модель не задана.

Параметры

completion

объект GtkEntryCompletion

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

GtkTreeModel или NULL, если модель не установлена.

[nullable][transfer none]

С: 2.4

gtk_entry_completion_set_match_func ()

void
gtk_entry_completion_set_match_func (GtkEntryCompletion *completion,
                                     GtkEntryCompletionMatchFunc func,
                                     gpointer func_data,
                                     GDestroyNotify func_notify);

Устанавливает функцию сопоставления для completion в func. Функция сопоставления используется для определения, должна ли строка быть включена в список дополнений.

Параметры

completion

объект GtkEntryCompletion

func

используемая функция GtkEntryCompletionMatchFunc

func_data

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

func_notify

уведомление об удалении для func_data.

С: 2.4

gtk_entry_completion_set_minimum_key_length ()

void
gtk_entry_completion_set_minimum_key_length
                               (GtkEntryCompletion *completion,
                                gint length);

Требует, чтобы длина ключа поиска для completion была не меньше length. Это полезно для длинных списков, где завершение по короткому ключу занимает много времени и в любом случае приведёт к бессмысленным результатам (т.е., слишком большая база данных).

Параметры

completion

объект GtkEntryCompletion

length

минимальная длина ключа для начала завершения

С: 2.4

gtk_entry_completion_get_minimum_key_length ()

gint
gtk_entry_completion_get_minimum_key_length
                               (GtkEntryCompletion *completion);

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

Параметры

completion

объект GtkEntryCompletion

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

Текущая минимальная длина ключа

С: 2.4

gtk_entry_completion_compute_prefix ()

gchar *
gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion,
                                     const char *key);

Вычисляет общее префиксное совпадение, которое разделяют все строки в completion, начинающиеся с key. Если ни одна строка не соответствует key, возвращается NULL. Обратите внимание, что для работы этой функции должна быть установлена колонка текста; см. gtk_entry_completion_set_text_column() для получения подробностей.

Параметры

completion

объект завершения ввода

key

текст для завершения

Возвращает

Общее префиксное совпадение всех строк, начинающихся с key, или NULL, если ни одна строка не соответствует key.

[nullable][transfer full]

С момента: 3.4

gtk_entry_completion_complete ()

void
gtk_entry_completion_complete (GtkEntryCompletion *completion);

Запрашивает операцию завершения, или, другими словами, повторное фильтрование текущего списка с помощью текущего ключа. Список завершений будет обновлен соответствующим образом.

Параметры

completion

объект GtkEntryCompletion

С момента: 2.4

gtk_entry_completion_get_completion_prefix ()

const gchar *
gtk_entry_completion_get_completion_prefix
                               (GtkEntryCompletion *completion);

Получить исходный текст, введённый пользователем, который инициировал завершение, или NULL, если процесс завершения не происходит.

Параметры

completion

объект GtkEntryCompletion

Возвращает

префикс текущего завершения

С момента: 2.12

gtk_entry_completion_insert_prefix ()

void
gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion);

Запрашивает вставку префикса.

Параметры

completion

объект GtkEntryCompletion

С момента: 2.6

gtk_entry_completion_insert_action_text ()

void
gtk_entry_completion_insert_action_text
                               (GtkEntryCompletion *completion,
                                gint index_,
                                const gchar *text);

Вставляет действие в список элементов действий completion в позиции index_ с текстом text. Если вы хотите, чтобы элемент действия имел разметку, используйте gtk_entry_completion_insert_action_markup().

Обратите внимание, что index_ — это относительная позиция в списке действий, и позиция действия может измениться при удалении другого действия.

Параметры

completion

объект GtkEntryCompletion

index_

индекс вставляемого элемента

text

текст вставляемого элемента

С момента: 2.4

gtk_entry_completion_insert_action_markup ()

void
gtk_entry_completion_insert_action_markup
                               (GtkEntryCompletion *completion,
                                gint index_,
                                const gchar *markup);

Вставляет действие в список элементов действий completion в позиции index_ с разметкой markup.

Параметры

completion

объект GtkEntryCompletion

index_

индекс вставляемого элемента

markup

разметка вставляемого элемента

С момента: 2.4

gtk_entry_completion_delete_action ()

void
gtk_entry_completion_delete_action (GtkEntryCompletion *completion,
                                    gint index_);

Удаляет действие в позиции index_ из списка действий completion.

Обратите внимание, что index_ — это относительная позиция, а позиция действия может измениться с момента её вставки.

Параметры

completion

объект GtkEntryCompletion

index_

индекс удаляемого элемента

С момента: 2.4

gtk_entry_completion_set_text_column ()

void
gtk_entry_completion_set_text_column (GtkEntryCompletion *completion,
                                      gint column);

Функция-помощник для настройки наиболее часто используемого случая: списка завершений только с текстовыми строками. Эта функция настроит completion для отображения списка (и только) всех строк в списке завершений и получения этих строк из column в модели completion.

Эта функция создаёт и добавляет GtkCellRendererText для выбранной колонки. Если вам нужно установить колонку текста, но вы не хотите использовать компонент отображения ячейки, используйте g_object_set() для прямого задания свойства “text-column”.

Параметры

completion

объект GtkEntryCompletion

column

колонка в модели completion для получения строк

С момента: 2.4

gtk_entry_completion_get_text_column ()

gint
gtk_entry_completion_get_text_column (GtkEntryCompletion *completion);

Возвращает колонку в модели completion для получения строк.

Параметры

completion

объект GtkEntryCompletion

Возвращает

колонку, содержащую строки

С момента: 2.6

gtk_entry_completion_set_inline_completion ()

void
gtk_entry_completion_set_inline_completion
                               (GtkEntryCompletion *completion,
                                gboolean inline_completion);

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

Параметры

completion

объект GtkEntryCompletion

inline_completion

TRUE для включения inline-завершения

С момента: 2.6

gtk_entry_completion_get_inline_completion ()

gboolean
gtk_entry_completion_get_inline_completion
                               (GtkEntryCompletion *completion);

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

Параметры

completion

a GtkEntryCompletion

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

TRUE, если вставка дополнений включена

С: 2.6

gtk_entry_completion_set_inline_selection ()

void
gtk_entry_completion_set_inline_selection
                               (GtkEntryCompletion *completion,
                                gboolean inline_selection);

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

Параметры

completion

a GtkEntryCompletion

inline_selection

TRUE для включения циклического перебора

С: 2.12

gtk_entry_completion_get_inline_selection ()

gboolean
gtk_entry_completion_get_inline_selection
                               (GtkEntryCompletion *completion);

Возвращает TRUE, если режим вставки дополнений включён.

Параметры

completion

a GtkEntryCompletion

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

TRUE, если режим вставки дополнений включен

С: 2.12

gtk_entry_completion_set_popup_completion ()

void
gtk_entry_completion_set_popup_completion
                               (GtkEntryCompletion *completion,
                                gboolean popup_completion);

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

Параметры

completion

a GtkEntryCompletion

popup_completion

TRUE для отображения дополнений во всплывающем окне

С: 2.6

gtk_entry_completion_get_popup_completion ()

gboolean
gtk_entry_completion_get_popup_completion
                               (GtkEntryCompletion *completion);

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

Параметры

completion

a GtkEntryCompletion

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

TRUE, если всплывающее окно для дополнений включено

С: 2.6

gtk_entry_completion_set_popup_set_width ()

void
gtk_entry_completion_set_popup_set_width
                               (GtkEntryCompletion *completion,
                                gboolean popup_set_width);

Устанавливает, будет ли ширина всплывающего окна для дополнений соответствовать ширине поля ввода.

Параметры

completion

a GtkEntryCompletion

popup_set_width

TRUE для установки ширины всплывающего окна равной ширине поля ввода

С: 2.8

gtk_entry_completion_get_popup_set_width ()

gboolean
gtk_entry_completion_get_popup_set_width
                               (GtkEntryCompletion *completion);

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

Параметры

completion

a GtkEntryCompletion

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

TRUE, если ширина всплывающего окна будет соответствовать ширине поля ввода

С: 2.8

gtk_entry_completion_set_popup_single_match ()

void
gtk_entry_completion_set_popup_single_match
                               (GtkEntryCompletion *completion,
                                gboolean popup_single_match);

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

Параметры

completion

a GtkEntryCompletion

popup_single_match

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

С: 2.8

gtk_entry_completion_get_popup_single_match ()

gboolean
gtk_entry_completion_get_popup_single_match
                               (GtkEntryCompletion *completion);

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

Параметры

completion

a GtkEntryCompletion

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

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

С: 2.8

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

struct GtkEntryCompletion

struct GtkEntryCompletion;

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

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

  “cell-area”                GtkCellArea *

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

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

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

С версии: 3.0

Свойство “inline-completion”

  “inline-completion”        gboolean

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

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

Значение по умолчанию: ЛОЖЬ

С версии: 2.6

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

  “inline-selection”         gboolean

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

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

Значение по умолчанию: ЛОЖЬ

С версии: 2.12

Свойство “minimum-key-length”

  “minimum-key-length”       gint

Минимальная длина ключа поиска для поиска совпадений.

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

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

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

Свойство “model”

  “model”                    GtkTreeModel *

Модель для поиска совпадений.

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

Свойство “popup-completion”

  “popup-completion”         gboolean

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

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

Значение по умолчанию: ИСТИНА

С версии: 2.6

Свойство “popup-set-width”

  “popup-set-width”          gboolean

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

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

Значение по умолчанию: ИСТИНА

С версии: 2.8

Свойство “popup-single-match”

  “popup-single-match”       gboolean

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

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

Значение по умолчанию: ИСТИНА

С версии: 2.8

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

  “text-column”              gint

Столбец модели, содержащий строки. Обратите внимание, что строки должны быть в кодировке UTF-8.

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

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

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

С версии: 2.6

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

Сигнал “action-activated”

void
user_function (GtkEntryCompletion *widget,
               gint                index,
               gpointer            user_data)

Выдаётся, когда активируется действие.

Параметры

widget

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

index

индекс активированного действия

user_data

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

Флаги: Run Last

С версии: 2.4

Сигнал “cursor-on-match”

gboolean
user_function (GtkEntryCompletion *widget,
               GtkTreeModel       *model,
               GtkTreeIter        *iter,
               gpointer            user_data)

Выдаётся, когда совпадение из курсора находится на совпадении из списка. По умолчанию содержимое поля ввода заменяется содержимым столбца текста в строке, на которую указывает iter.

Обратите внимание, что model — это модель, переданная в gtk_entry_completion_set_model().

Параметры

widget

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

model

модель GtkTreeModel, содержащая совпадения

iter

объект GtkTreeIter, установленный на выбранное совпадение

user_data

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

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

TRUE, если сигнал был обработан

Флаги: Run Last

С версии: 2.12

Сигнал “insert-prefix”

gboolean
user_function (GtkEntryCompletion *widget,
               gchar              *prefix,
               gpointer            user_data)

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

Приложения могут подключиться к этому сигналу, чтобы вставить только меньшую часть prefix в поле ввода — например, поле ввода в GtkFileChooser вставляет только часть префикса до следующего '/'.

Параметры

widget

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

prefix

общее префиксное совпадение всех возможных дополнений

user_data

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

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

TRUE, если сигнал был обработан

Флаги: Run Last

С версии: 2.6

Сигнал “match-selected”

gboolean
user_function (GtkEntryCompletion *widget,
               GtkTreeModel       *model,
               GtkTreeIter        *iter,
               gpointer            user_data)

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

Обратите внимание, что model — это модель, переданная в gtk_entry_completion_set_model().

Параметры

widget

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

model

модель GtkTreeModel, содержащая совпадения

iter

объект GtkTreeIter, установленный на выбранное совпадение

user_data

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

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

TRUE, если сигнал был обработан

Флаги: Run Last

С версии: 2.4

Сигнал “no-matches”

void
user_function (GtkEntryCompletion *widget,
               gpointer            user_data)

Выдаётся, когда модель фильтра имеет ноль строк в методе completion_complete. (Другими словами, когда у GtkEntryCompletion нет предложений)

Параметры

widget

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

user_data

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

Флаги: Run Last

С версии: 3.14

© 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/GtkEntryCompletion.html

Spec-Zone.ru

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