Spec-Zone.ru › GTK 3.24

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

объект 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

объект GtkTooltip

text

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

[allow-none]

С версии: 2.12

gtk_tooltip_set_icon ()

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

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

Параметры

tooltip

объект GtkTooltip

pixbuf

объект 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

объект 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

объект 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

объект GtkTooltip

gicon

объект 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

объект GtkTooltip

custom_widget

объект GtkWidget, или NULL для сброса старого настраиваемого виджета.

[allow-none]

С версии: 2.12

gtk_tooltip_trigger_tooltip_query ()

void
gtk_tooltip_trigger_tooltip_query (GdkDisplay *display);

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

Параметры

display

объект 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.24/GtkTooltip.html

Spec-Zone.ru

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