Wiki
Задать вопрос на форуме...

prev

up

home

gtk+ reference manual

next

top  |  description  |  object hierarchy  |  implemented interfaces  |  properties  |  signals

gtkentrycompletion

gtkentrycompletion – функциональные возможности завершения для gtkentry

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

#include <gtk/gtk.h>


            gtkentrycompletion;
gboolean    (*gtkentrycompletionmatchfunc)  (gtkentrycompletion *completion,
                                             const gchar *key,
                                             gtktreeiter *iter,
                                             gpointer user_data);
gtkentrycompletion* gtk_entry_completion_new
                                            (void);
gtkwidget*  gtk_entry_completion_get_entry  (gtkentrycompletion *completion);
void        gtk_entry_completion_set_model  (gtkentrycompletion *completion,
                                             gtktreemodel *model);
gtktreemodel* gtk_entry_completion_get_model
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_set_match_func
                                            (gtkentrycompletion *completion,
                                             gtkentrycompletionmatchfunc func,
                                             gpointer func_data,
                                             gdestroynotify func_notify);
void        gtk_entry_completion_set_minimum_key_length
                                            (gtkentrycompletion *completion,
                                             gint length);
gint        gtk_entry_completion_get_minimum_key_length
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_complete   (gtkentrycompletion *completion);
void        gtk_entry_completion_insert_prefix
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_insert_action_text
                                            (gtkentrycompletion *completion,
                                             gint index_,
                                             const gchar *text);
void        gtk_entry_completion_insert_action_markup
                                            (gtkentrycompletion *completion,
                                             gint index_,
                                             const gchar *markup);
void        gtk_entry_completion_delete_action
                                            (gtkentrycompletion *completion,
                                             gint index_);
void        gtk_entry_completion_set_text_column
                                            (gtkentrycompletion *completion,
                                             gint column);
gint        gtk_entry_completion_get_text_column
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_set_inline_completion
                                            (gtkentrycompletion *completion,
                                             gboolean inline_completion);
gboolean    gtk_entry_completion_get_inline_completion
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_set_popup_completion
                                            (gtkentrycompletion *completion,
                                             gboolean popup_completion);
gboolean    gtk_entry_completion_get_popup_completion
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_set_popup_set_width
                                            (gtkentrycompletion *completion,
                                             gboolean popup_set_width);
gboolean    gtk_entry_completion_get_popup_set_width
                                            (gtkentrycompletion *completion);
void        gtk_entry_completion_set_popup_single_match
                                            (gtkentrycompletion *completion,
                                             gboolean popup_single_match);
gboolean    gtk_entry_completion_get_popup_single_match
                                            (gtkentrycompletion *completion);

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

  gobject
   +----gtkentrycompletion

осуществляемый интерфейс

gtkentrycompletion осуществляет gtkcelllayout.

свойства

  "inline-completion"    gboolean              : read / write
  "minimum-key-length"   gint                  : read / write
  "model"                gtktreemodel          : read / write
  "popup-completion"     gboolean              : read / write
  "popup-set-width"      gboolean              : read / write
  "popup-single-match"   gboolean              : read / write
  "text-column"          gint                  : read / write

сигналы

"action-activated"
            void        user_function      (gtkentrycompletion *widget,
                                            gint                index,
                                            gpointer            user_data)      : run last
"insert-prefix"
            gboolean    user_function      (gtkentrycompletion *widget,
                                            gchar              *prefix,
                                            gpointer            user_data)      : run last
"match-selected"
            gboolean    user_function      (gtkentrycompletion *widget,
                                            gtktreemodel       *model,
                                            gtktreeiter        *iter,
                                            gpointer            user_data)      : run last

описание

gtkentrycompletion это вспомогательный объект для использования в связке с gtkentry для обеспечения функциональности завершения. он осуществляет gtkcelllayout интерфейс, позволяя пользователю добавлять дополнительные ячейки для gtktreeview с подходящим завершением.

"completion functionality" означает что когда пользователь изменяет текст ввода, gtkentrycompletion проверяет какие строки в соответствуют модели текущемго содержимого ввода и отображают список соответствий. по умолчанию, соответствие выполняется сравнивая текст ввода без учета регистра с текстом графы модели (смотрите gtk_entry_completion_set_text_column()), но это может быть отменено с помощью настройки функции соответствия (смотрите gtk_entry_completion_set_match_func()).

когда пользователь выделяет завершение, содержимое ввода обновляется. по умолчанию, содержимое ввода заменяется текстом графы модели, но это может быть изменено подключением сигнала ::match-selected и обновлением ввода в обработчике сигнала. помните, вы должны вернуть true из обработчика сигнала чтобы подавить поведение по умолчанию.

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

в дополнение к обычному соответствующему завершению, которое вставляется в вод когда происходит выделение, gtkentrycompletion также позволяет отображать "actions" во всплывающем окне. их внешний вид похож на пункты меню, для явного отличия от строк завершения. когда действие выбрано, издаётся сигнал ::action-activated.

детали

gtkentrycompletion

typedef struct _gtkentrycompletion gtkentrycompletion;

структура gtkentrycompletion содержит только закрытые данные.

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_get_entry ()

gtkwidget*  gtk_entry_completion_get_entry  (gtkentrycompletion *completion);

получает ввод к которому должно быть прикреплено завершение completion.

completion :

gtkentrycompletion.

возвращает:

получает ввод к которому должно быть прикреплено завершение completion.

начиная с версии 2.4

gtk_entry_completion_set_model ()

void        gtk_entry_completion_set_model  (gtkentrycompletion *completion,
                                             gtktreemodel *model);

устанавливает модель для gtkentrycompletion. если completion уже имеет модель, она будет удалена перед установкой новой модели. если модель null, то когда просто удаляется существующая.

completion :

gtkentrycompletion.

model :

gtktreemodel.

начиная с версии 2.4

gtk_entry_completion_get_model ()

gtktreemodel* gtk_entry_completion_get_model
                                            (gtkentrycompletion *completion);

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

completion :

gtkentrycompletion.

возвращает:

gtktreemodel, или null если в текущий момент не используется.

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

void        gtk_entry_completion_complete   (gtkentrycompletion *completion);

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

completion :

gtkentrycompletion.

начиная с версии 2.4

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's в позицию index_ с текстом text. если вы хотите отметить элемент действия, используйте gtk_entry_completion_insert_action_markup().

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's в позицию 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's.

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 выполняет встроенное завершение

начиная с версии 2.6

gtk_entry_completion_get_inline_completion ()

gboolean    gtk_entry_completion_get_inline_completion
                                            (gtkentrycompletion *completion);

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

completion :

gtkentrycompletion

возвращает:

true если встроенное завершение включено

начиная с версии 2.6

gtk_entry_completion_set_popup_completion ()

void        gtk_entry_completion_set_popup_completion
                                            (gtkentrycompletion *completion,
                                             gboolean popup_completion);

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

completion :

gtkentrycompletion

popup_completion :

true для всплывающего завершения

начиная с версии 2.6

gtk_entry_completion_get_popup_completion ()

gboolean    gtk_entry_completion_get_popup_completion
                                            (gtkentrycompletion *completion);

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

completion :

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 :

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 :

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, если вы используете inline completion.

completion :

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 :

gtkentrycompletion

возвращает:

true если всплывающее окно отображает единственное соответствие.

начиная с версии 2.8

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

свойство "inline-completion"

  "inline-completion"    gboolean              : read / write

определяет должен ли обычный префикс возможного завершения появляться автоматически во вводе. помните, требуется установка текста столбца (text-column), даже если вы используете функцию обычного соответствия.

значение по умолчанию: false

начиная с версии 2.6

свойство "minimum-key-length"

  "minimum-key-length"   gint                  : read / write

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

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

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

свойство "model"

  "model"                gtktreemodel          : read / write

модель в которой происходит поиск соответствий.

свойство "popup-completion"

  "popup-completion"     gboolean              : read / write

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

значение по умолчанию: true

начиная с версии 2.6

свойство "popup-set-width"

  "popup-set-width"      gboolean              : read / write

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

значение по умолчанию: true

начиная с версии 2.8

свойство "popup-single-match"

  "popup-single-match"   gboolean              : read / write

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

значение по умолчанию: true

начиная с версии 2.8

свойство "text-column"

  "text-column"          gint                  : read / write

столб модели которая содержит строки.

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

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

начиная с версии 2.6

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

сигнал "action-activated"

void        user_function                  (gtkentrycompletion *widget,
                                            gint                index,
                                            gpointer            user_data)      : run last

издаётся при активации действия.

widget :

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

index :

позиция активизированного действия.

user_data :

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

начиная с версии 2.4

сигнал "insert-prefix"

gboolean    user_function                  (gtkentrycompletion *widget,
                                            gchar              *prefix,
                                            gpointer            user_data)      : run last

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

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

widget :

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

prefix :

основной префикс всех возможных завершений

user_data :

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

возвращает:

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

начиная с версии 2.6

сигнал "match-selected"

gboolean    user_function                  (gtkentrycompletion *widget,
                                            gtktreemodel       *model,
                                            gtktreeiter        *iter,
                                            gpointer            user_data)      : run last

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

widget :

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

model :

gtktreemodel содержащая соответствия

iter :

gtktreeiter позиционируемое выбранным соответствием

user_data :

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

возвращает:

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

начиная с версии 2.4