Spec-Zone.ru › GTK 3.20

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

Spec-Zone.ru

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