Spec-Zone.ru › GTK 3.22

GtkTooltip

GtkTooltip — Добавление подсказок к виджетам

Функции

void gtk_tooltip_set_markup ()
void gtk_tooltip_set_text ()
void gtk_tooltip_set_icon ()
void gtk_tooltip_set_icon_from_stock ()
void gtk_tooltip_set_icon_from_icon_name ()
void gtk_tooltip_set_icon_from_gicon ()
void gtk_tooltip_set_custom ()
void gtk_tooltip_trigger_tooltip_query ()
void gtk_tooltip_set_tip_area ()

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

GtkTooltip

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

    GObject
    ╰── GtkTooltip

Файлы

#include <gtk/gtk.h>

Описание

Базовые всплывающие подсказки могут быть реализованы просто с помощью gtk_widget_set_tooltip_text() или gtk_widget_set_tooltip_markup() без явного объекта подсказки.

Когда вам нужна подсказка с более сложным содержимым, например, с добавлением изображения, или вы хотите, чтобы подсказка имела разное содержимое для каждой строки или ячейки GtkTreeView, вам придется поработать немного больше:

  • Установите свойство «has-tooltip» в значение TRUE. Это позволит GTK+ отслеживать движение и связанные события виджета, необходимые для определения того, когда и где отобразить подсказку.

  • Подключитесь к сигналу «query-tooltip». Этот сигнал будет выпущен, когда предполагается отобразить подсказку. Один из аргументов, передаваемых обработчику сигнала, — это объект GtkTooltip. Это объект, который мы собираемся отобразить как подсказку, и им можно управлять в вашем обратном вызове, используя функции, такие как gtk_tooltip_set_icon(). Существуют функции для установки разметки подсказки, установки изображения из именованного значка или даже вставки пользовательского виджета.

    Возвращайте значение TRUE из вашего обработчика «query-tooltip». Это вызывает отображение подсказки. Если вы вернете FALSE, она не будет отображена.

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

  • Установите «has-tooltip» и подключитесь к «query-tooltip», как и прежде. Используйте gtk_widget_set_tooltip_window() для установки созданного вами GtkWindow в качестве окна подсказки.

  • В обратном вызове «query-tooltip» вы можете получить доступ к вашему окну, используя gtk_widget_get_tooltip_window(), и управлять им по своему усмотрению. Семантика возвращаемого значения такая же, как и прежде: верните TRUE, чтобы отобразить окно, FALSE, чтобы не отображать его.

Функции

gtk_tooltip_set_markup ()

void
gtk_tooltip_set_markup (GtkTooltip *tooltip,
                        const gchar *markup);

Устанавливает текст подсказки в markup , который размечается с помощью языка разметки текста Pango. Если markup является NULL, метка будет скрыта.

Параметры

tooltip

a GtkTooltip

markup

строка разметки (см. формат разметки Pango) или NULL.

[allow-none]

С версии: 2.12

gtk_tooltip_set_text ()

void
gtk_tooltip_set_text (GtkTooltip *tooltip,
                      const gchar *text);

Устанавливает текст подсказки в text . Если text является NULL, метка будет скрыта. См. также gtk_tooltip_set_markup().

Параметры

tooltip

a GtkTooltip

text

текстовая строка или NULL.

[allow-none]

С версии: 2.12

gtk_tooltip_set_icon ()

void
gtk_tooltip_set_icon (GtkTooltip *tooltip,
                      GdkPixbuf *pixbuf);

Устанавливает значок подсказки (который находится перед текстом) в pixbuf . Если pixbuf является NULL, изображение будет скрыто.

Параметры

tooltip

a GtkTooltip

pixbuf

a GdkPixbuf, или NULL.

[allow-none]

С версии: 2.12

gtk_tooltip_set_icon_from_stock ()

void
gtk_tooltip_set_icon_from_stock (GtkTooltip *tooltip,
                                 const gchar *stock_id,
                                 GtkIconSize size);

gtk_tooltip_set_icon_from_stock устарел начиная с версии 3.10 и не должен использоваться в новом коде.

Используйте gtk_tooltip_set_icon_from_icon_name() вместо этого.

Устанавливает значок подсказки (который находится перед текстом) в виде стандартного элемента, указанного stock_id с размером, указанным size . Если stock_id является NULL, изображение будет скрыто.

Параметры

tooltip

a GtkTooltip

stock_id

идентификатор стандартного элемента или NULL.

[allow-none]

size

размер стандартного значка (GtkIconSize).

[type int]

С версии: 2.12

gtk_tooltip_set_icon_from_icon_name ()

void
gtk_tooltip_set_icon_from_icon_name (GtkTooltip *tooltip,
                                     const gchar *icon_name,
                                     GtkIconSize size);

Устанавливает значок подсказки (который находится перед текстом) в виде значка, указанного icon_name с размером, указанным size . Если icon_name является NULL, изображение будет скрыто.

Параметры

tooltip

a GtkTooltip

icon_name

имя значка или NULL.

[allow-none]

size

размер стандартного значка (GtkIconSize).

[type int]

С версии: 2.14

gtk_tooltip_set_icon_from_gicon ()

void
gtk_tooltip_set_icon_from_gicon (GtkTooltip *tooltip,
                                 GIcon *gicon,
                                 GtkIconSize size);

Устанавливает значок подсказки (который находится перед текстом) в виде значка, указанного gicon с размером, указанным size . Если gicon является NULL, изображение будет скрыто.

Параметры

tooltip

a GtkTooltip

gicon

a GIcon представляющий значок, или NULL.

[allow-none]

size

размер стандартного значка (GtkIconSize).

[type int]

С версии: 2.20

gtk_tooltip_set_custom ()

void
gtk_tooltip_set_custom (GtkTooltip *tooltip,
                        GtkWidget *custom_widget);

Заменяет виджет, упакованный в подсказку, на custom_widget . custom_widget не уничтожается, когда подсказка исчезает. По умолчанию в подсказку внедряется контейнер с GtkImage и GtkLabel, который можно настроить с помощью gtk_tooltip_set_markup() и gtk_tooltip_set_icon().

Параметры

tooltip

a GtkTooltip

custom_widget

a GtkWidget, или NULL чтобы сбросить старый пользовательский виджет.

[allow-none]

С версии: 2.12

gtk_tooltip_trigger_tooltip_query ()

void
gtk_tooltip_trigger_tooltip_query (GdkDisplay *display);

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

Параметры

display

a GdkDisplay

С: 2.12

gtk_tooltip_set_tip_area ()

void
gtk_tooltip_set_tip_area (GtkTooltip *tooltip,
                          const GdkRectangle *rect);

Устанавливает область виджета, где отображается содержимое этой подсказки, в rect (в координатах виджета). Это особенно полезно для правильной установки подсказок для строк и ячеек в GtkTreeView, GtkIconViews и т. п.

Для установки подсказок в GtkTreeView используйте вспомогательные функции: gtk_tree_view_set_tooltip_row() и gtk_tree_view_set_tooltip_cell().

Параметры

tooltip

a GtkTooltip

rect

a GdkRectangle

С: 2.12

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

GtkTooltip

typedef struct _GtkTooltip GtkTooltip;

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

Spec-Zone.ru

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