Spec-Zone.ru › GTK 3.22

GtkNumerableIcon

GtkNumerableIcon — Значок GIcon, позволяющий отображать номерные эмблемы

Функции

GIcon * gtk_numerable_icon_new ()
GIcon * gtk_numerable_icon_new_with_style_context ()
GIcon * gtk_numerable_icon_get_background_gicon ()
void gtk_numerable_icon_set_background_gicon ()
const gchar * gtk_numerable_icon_get_background_icon_name ()
void gtk_numerable_icon_set_background_icon_name ()
gint gtk_numerable_icon_get_count ()
void gtk_numerable_icon_set_count ()
const gchar * gtk_numerable_icon_get_label ()
void gtk_numerable_icon_set_label ()
GtkStyleContext * gtk_numerable_icon_get_style_context ()
void gtk_numerable_icon_set_style_context ()

Свойства

GIcon * background-icon Чтение/Запись
gchar * background-icon-name Чтение/Запись
gint count Чтение/Запись
gchar * label Чтение/Запись
GtkStyleContext * style-context Чтение/Запись

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

struct GtkNumerableIcon

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

    GObject
    ╰── GEmblemedIcon
        ╰── GtkNumerableIcon

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

GtkNumerableIcon реализует GIcon.

Включения

#include <gtk/gtk.h>

Описание

GtkNumerableIcon — подкласс GEmblemedIcon, который может отображать число или короткую строку в виде эмблемы. Число может быть наложено поверх другой эмблемы, если это необходимо.

Он поддерживает настройку, получая информацию о шрифте и цвете из предоставленного GtkStyleContext; см. gtk_numerable_icon_set_style_context().

Типичные значки с номерами:

Функции

gtk_numerable_icon_new ()

GIcon *
gtk_numerable_icon_new (GIcon *base_icon);

gtk_numerable_icon_new устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

Создаёт новый нетематизированный GtkNumerableIcon.

Параметры

base_icon

a GIcon для наложения

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

новый GIcon.

[передача полной]

С: 3.0

gtk_numerable_icon_new_with_style_context ()

GIcon *
gtk_numerable_icon_new_with_style_context
                               (GIcon *base_icon,
                                GtkStyleContext *context);

gtk_numerable_icon_new_with_style_context устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

Создаёт новый GtkNumerableIcon, который будет тематизирован в соответствии с переданным GtkStyleContext. Это удобный конструктор, который вызывает gtk_numerable_icon_set_style_context() внутри.

Параметры

base_icon

a GIcon для наложения

context

a GtkStyleContext

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

новый GIcon.

[передача полной]

С: 3.0

gtk_numerable_icon_get_background_gicon ()

GIcon *
gtk_numerable_icon_get_background_gicon
                               (GtkNumerableIcon *self);

gtk_numerable_icon_get_background_gicon устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

Возвращает GIcon, установленный в качестве базового изображения фона, или NULL, если его нет. Вызывающий функцию не владеет ссылкой на возвращённый GIcon.

Параметры

self

a GtkNumerableIcon

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

GIcon, или NULL.

[nullable][передача ничего]

С: 3.0

gtk_numerable_icon_set_background_gicon ()

void
gtk_numerable_icon_set_background_gicon
                               (GtkNumerableIcon *self,
                                GIcon *icon);

gtk_numerable_icon_set_background_gicon устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

Обновляет иконку, используя icon в качестве базового изображения фона. Если icon равно NULL, self вернётся к использованию стилевой информации или стандартной темы для изображения фона.

Если этот метод вызывается, и имя иконки уже было установлено в качестве фона иконки, icon будет использоваться, т.е. последний вызванный метод между gtk_numerable_icon_set_background_gicon() и gtk_numerable_icon_set_background_icon_name() всегда имеет приоритет.

Параметры

self

a GtkNumerableIcon

icon

a GIcon, или NULL.

[allow-none]

С: 3.0

gtk_numerable_icon_get_background_icon_name ()

const gchar *
gtk_numerable_icon_get_background_icon_name
                               (GtkNumerableIcon *self);

gtk_numerable_icon_get_background_icon_name устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

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

Параметры

self

a GtkNumerableIcon

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

имя иконки, или NULL.

[nullable]

С: 3.0

gtk_numerable_icon_set_background_icon_name ()

void
gtk_numerable_icon_set_background_icon_name
                               (GtkNumerableIcon *self,
                                const gchar *icon_name);

gtk_numerable_icon_set_background_icon_name устарела начиная с версии 3.14 и не должна использоваться в новых кодах.

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

Если этот метод вызывается, и GIcon был уже установлен в качестве фона иконки, icon_name будет использован, т.е. последний вызванный метод между gtk_numerable_icon_set_background_icon_name() и gtk_numerable_icon_set_background_gicon() всегда имеет приоритет.

Параметры

self

a GtkNumerableIcon

icon_name

имя иконки, или NULL.

[allow-none]

С: 3.0

gtk_numerable_icon_get_count ()

gint
gtk_numerable_icon_get_count (GtkNumerableIcon *self);

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

Возвращает значение, отображаемое в настоящее время self.

Параметры

self

a GtkNumerableIcon

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

текущее отображаемое значение

С версии: 3.0

gtk_numerable_icon_set_count ()

void
gtk_numerable_icon_set_count (GtkNumerableIcon *self,
                              gint count);

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

Устанавливает текущее отображаемое значение self в count.

Числовое значение всегда ограничено двумя цифрами, т. е. находится в диапазоне от -99 до 99. Установка счётчика в ноль удаляет эмблему. Если этот метод вызывается, и на значке уже задана метка, она будет автоматически сброшена до NULL перед отрисовкой числа, т. е. последний вызов метода между gtk_numerable_icon_set_count() и gtk_numerable_icon_set_label() имеет приоритет.

Параметры

self

a GtkNumerableIcon

count

число от -99 до 99

С версии: 3.0

gtk_numerable_icon_get_label ()

const gchar *
gtk_numerable_icon_get_label (GtkNumerableIcon *self);

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

Возвращает текущую отображаемую метку значка или NULL.

Параметры

self

a GtkNumerableIcon

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

текущая отображаемая метка.

[nullable]

С версии: 3.0

gtk_numerable_icon_set_label ()

void
gtk_numerable_icon_set_label (GtkNumerableIcon *self,
                              const gchar *label);

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

Устанавливает текущее отображаемое значение self на строку в label. Установка пустой метки удаляет эмблему.

Обратите внимание, что это предназначено для отображения коротких меток, таких как римские цифры или одиночные буквы. Для римских цифр используйте символы Юникода U+2160 - U+217F. Строки длиннее двух символов, скорее всего, будут отображаться не очень хорошо.

Если этот метод вызывается, и на значке уже установлено число, оно автоматически сбрасывается до нуля перед отрисовкой метки, т. е. последний вызов метода между gtk_numerable_icon_set_label() и gtk_numerable_icon_set_count() имеет приоритет.

Параметры

self

a GtkNumerableIcon

label

короткая метка или NULL.

[allow-none]

С версии: 3.0

gtk_numerable_icon_get_style_context ()

GtkStyleContext *
gtk_numerable_icon_get_style_context (GtkNumerableIcon *self);

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

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

Параметры

self

a GtkNumerableIcon

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

a GtkStyleContext или NULL. Этот объект является внутренним для GTK+ и не должен быть освобожден. Используйте g_object_ref(), если хотите сохранить его.

[nullable][transfer none]

С версии: 3.0

gtk_numerable_icon_set_style_context ()

void
gtk_numerable_icon_set_style_context (GtkNumerableIcon *self,
                                      GtkStyleContext *style);

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

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

Параметры

self

a GtkNumerableIcon

style

a GtkStyleContext

С версии: 3.0

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

struct GtkNumerableIcon

struct GtkNumerableIcon;

Подробности свойств

Свойство “background-icon”

  “background-icon”          GIcon *

Значок для фона эмблемы числа.

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

Свойство “background-icon-name”

  “background-icon-name”     gchar *

Имя значка для фона эмблемы числа.

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

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

Свойство “count”

  “count”                    gint

Счётчик, отображаемый в настоящее время.

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

Допустимые значения: [-99,99]

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

Свойство “label”

  “label”                    gchar *

Метка, отображаемая над значком.

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

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

Свойство “style-context”

  “style-context”            GtkStyleContext *

Контекст стиля для оформления внешнего вида значка.

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

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

Spec-Zone.ru

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