Spec-Zone.ru › GTK 3.22

GtkHeaderBar

GtkHeaderBar — рамка с центрированным дочерним элементом

Функции

GtkWidget * gtk_header_bar_new ()
void gtk_header_bar_set_title ()
const gchar * gtk_header_bar_get_title ()
void gtk_header_bar_set_subtitle ()
const gchar * gtk_header_bar_get_subtitle ()
void gtk_header_bar_set_has_subtitle ()
gboolean gtk_header_bar_get_has_subtitle ()
void gtk_header_bar_set_custom_title ()
GtkWidget * gtk_header_bar_get_custom_title ()
void gtk_header_bar_pack_start ()
void gtk_header_bar_pack_end ()
void gtk_header_bar_set_show_close_button ()
gboolean gtk_header_bar_get_show_close_button ()
void gtk_header_bar_set_decoration_layout ()
const gchar * gtk_header_bar_get_decoration_layout ()

Свойства

GtkWidget * custom-title Чтение/Запись
gchar * decoration-layout Чтение/Запись
gboolean decoration-layout-set Чтение/Запись
gboolean has-subtitle Чтение/Запись
gboolean show-close-button Чтение/Запись
gint spacing Чтение/Запись
gchar * subtitle Чтение/Запись
gchar * title Чтение/Запись

Свойства дочерних элементов

GtkPackType pack-type Чтение/Запись
gint position Чтение/Запись

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

struct GtkHeaderBar

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

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkHeaderBar

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

GtkHeaderBar реализует AtkImplementorIface и GtkBuildable.

Файлы

#include <gtk/gtk.h>

Описание

GtkHeaderBar похож на горизонтальную GtkBox. Он позволяет размещать дочерние элементы в начале или в конце. Кроме того, он позволяет отображать заголовок и подзаголовок. Заголовок будет центрирован относительно ширины рамки, даже если дочерние элементы по обе стороны занимают разное пространство. Высота заголовка будет установлена для предоставления достаточного места для подзаголовка, даже если он не задан в настоящее время. Если подзаголовок не нужен, резервирование пространства можно отключить с помощью gtk_header_bar_set_has_subtitle().

GtkHeaderBar может добавлять типичные элементы управления рамкой окна, такие как кнопки минимизации, максимизации и закрытия, или значок окна.

Функции

gtk_header_bar_new ()

GtkWidget *
gtk_header_bar_new (void);

Создаёт новый виджет GtkHeaderBar.

Возвращает

новый GtkHeaderBar

С: 3.10

gtk_header_bar_set_title ()

void
gtk_header_bar_set_title (GtkHeaderBar *bar,
                          const gchar *title);

Устанавливает заголовок для виджета GtkHeaderBar. Заголовок должен помочь пользователю идентифицировать текущий вид. Хороший заголовок не должен содержать имя приложения.

Параметры

bar

a GtkHeaderBar

title

заголовок, или NULL.

[allow-none]

С: 3.10

gtk_header_bar_get_title ()

const gchar *
gtk_header_bar_get_title (GtkHeaderBar *bar);

Возвращает заголовок. См. gtk_header_bar_set_title().

Параметры

bar

a GtkHeaderBar

Возвращает

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

[nullable]

С: 3.10

gtk_header_bar_set_subtitle ()

void
gtk_header_bar_set_subtitle (GtkHeaderBar *bar,
                             const gchar *subtitle);

Устанавливает подзаголовок для виджета GtkHeaderBar. Подзаголовок предоставляет дополнительную информацию для идентификации текущего вида.

Обратите внимание, что GtkHeaderBar по умолчанию резервирует место для подзаголовка, даже если он не установлен. Если это не нужно, установите свойство “has-subtitle” в FALSE.

Параметры

bar

a GtkHeaderBar

subtitle

подзаголовок, или NULL.

[allow-none]

С: 3.10

gtk_header_bar_get_subtitle ()

const gchar *
gtk_header_bar_get_subtitle (GtkHeaderBar *bar);

Возвращает подзаголовок. См. gtk_header_bar_set_subtitle().

Параметры

bar

a GtkHeaderBar

Возвращает

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

[nullable]

С: 3.10

gtk_header_bar_set_has_subtitle ()

void
gtk_header_bar_set_has_subtitle (GtkHeaderBar *bar,
                                 gboolean setting);

Устанавливает, нужно ли резервировать место для подзаголовка, даже если он не установлен.

Параметры

bar

a GtkHeaderBar

setting

TRUE для резервирования места

С: 3.12

gtk_header_bar_get_has_subtitle ()

gboolean
gtk_header_bar_get_has_subtitle (GtkHeaderBar *bar);

Возвращает, резервирует ли виджет место для подзаголовка, независимо от того, установлен ли он.

Параметры

bar

a GtkHeaderBar

Возвращает

TRUE, если место резервируется

С: 3.12

gtk_header_bar_set_custom_title ()

void
gtk_header_bar_set_custom_title (GtkHeaderBar *bar,
                                 GtkWidget *title_widget);

Устанавливает пользовательский заголовок для GtkHeaderBar.

Заголовок помогает пользователю определить текущий вид. Заменяет любые заголовки, установленные с помощью gtk_header_bar_set_title() или gtk_header_bar_set_subtitle(). Чтобы добиться того же стиля, что и встроенный заголовок и подзаголовок, используйте стили классов «title» и «subtitle».

Установите пользовательский заголовок в NULL, чтобы метка заголовка виджета снова стала видимой.

Параметры

bar

a GtkHeaderBar

title_widget

пользовательский виджет, который нужно использовать для заголовка.

[allow-none]

С: 3.10

gtk_header_bar_get_custom_title ()

GtkWidget *
gtk_header_bar_get_custom_title (GtkHeaderBar *bar);

Возвращает пользовательский виджет заголовка. См. gtk_header_bar_set_custom_title().

Параметры

bar

a GtkHeaderBar

Возвращает

пользовательский виджет заголовка, или NULL, если явно не установлен.

[nullable][transfer none]

С: 3.10

gtk_header_bar_pack_start ()

void
gtk_header_bar_pack_start (GtkHeaderBar *bar,
                           GtkWidget *child);

Добавляет child в bar, упаковывая его относительно начала bar.

Параметры

bar

A GtkHeaderBar

child

the GtkWidget для добавления в bar

С: 3.10

gtk_header_bar_pack_end ()

void
gtk_header_bar_pack_end (GtkHeaderBar *bar,
                         GtkWidget *child);

Добавляет child в bar, упаковывая его относительно конца bar.

Параметры

bar

A GtkHeaderBar

child

the GtkWidget для добавления в bar

С: 3.10

gtk_header_bar_set_show_close_button ()

void
gtk_header_bar_set_show_close_button (GtkHeaderBar *bar,
                                      gboolean setting);

Устанавливает, отображать ли стандартные украшения окна, включая кнопку закрытия, максимизации и минимизации.

Параметры

bar

a GtkHeaderBar

setting

TRUE для отображения стандартных украшений окна

С: 3.10

gtk_header_bar_get_show_close_button ()

gboolean
gtk_header_bar_get_show_close_button (GtkHeaderBar *bar);

Возвращает, отображаются ли стандартные украшения окна.

Параметры

bar

a GtkHeaderBar

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

TRUE, если украшения отображаются

С: 3.10

gtk_header_bar_set_decoration_layout ()

void
gtk_header_bar_set_decoration_layout (GtkHeaderBar *bar,
                                      const gchar *layout);

Устанавливает макет украшений для этого верхнего бара, переопределяя значение “gtk-decoration-layout”.

Существуют веские причины для переопределения этого значения, например, дизайн верхнего бара, который не позволяет кнопкам занимать место справа или предлагает место только для одной кнопки закрытия. Разделенные верхние бары — еще один пример переопределения этого значения.

Формат строки — это названия кнопок, разделенные запятыми. Двоеточие разделяет кнопки, которые должны отображаться слева, от тех, что должны отображаться справа. Распознанные имена кнопок — minimize, maximize, close, icon (иконка окна) и menu (кнопка меню для меню приложения по умолчанию).

Например, «menu:minimize,maximize,close» указывает меню слева и кнопки minimize, maximize и close справа.

Параметры

bar

a GtkHeaderBar

layout

макет украшений или NULL для отмены макета.

[allow-none]

С: 3.12

gtk_header_bar_get_decoration_layout ()

const gchar *
gtk_header_bar_get_decoration_layout (GtkHeaderBar *bar);

Получает макет украшений, установленный с помощью gtk_header_bar_set_decoration_layout().

Параметры

bar

a GtkHeaderBar

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

макет украшений

С: 3.12

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

struct GtkHeaderBar

struct GtkHeaderBar;

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

Свойство “custom-title”

  “custom-title”             GtkWidget *

Виджет пользовательского заголовка для отображения.

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

Свойство “decoration-layout”

  “decoration-layout”        gchar *

Макет украшений для кнопок. Если это свойство не установлено, используется значение “gtk-decoration-layout”.

См. gtk_header_bar_set_decoration_layout() для получения информации о формате этой строки.

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

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

С: 3.12

Свойство “decoration-layout-set”

  “decoration-layout-set”    gboolean

Устанавливается в TRUE, если свойство “decoration-layout” установлено.

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

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

С: 3.12

Свойство “has-subtitle”

  “has-subtitle”             gboolean

Если TRUE, зарезервировать место для подзаголовка, даже если он в данный момент не установлен.

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

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

С: 3.12

Свойство “show-close-button”

  “show-close-button”        gboolean

Отображать ли украшения окна.

Какие кнопки фактически отображаются и где определяется свойством “decoration-layout” и состоянием окна (например, кнопка закрытия не будет отображаться, если окно нельзя закрыть).

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

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

Свойство “spacing”

  “spacing”                  gint

Расстояние между элементами.

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

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

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

Свойство “subtitle”

  “subtitle”                 gchar *

Подзаголовок для отображения.

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

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

Свойство “title”

  “title”                    gchar *

Заголовок для отображения.

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

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

Подробности свойств дочерних элементов

Свойство дочернего элемента “pack-type”

  “pack-type”                GtkPackType

GtkPackType, указывающий, упаковывается ли дочерний элемент относительно начала или конца родительского.

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

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

Свойство дочернего элемента “position”

  “position”                 gint

Индекс дочернего элемента в родительском.

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

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

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

См. также

GtkBox, GtkActionBar

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

Spec-Zone.ru

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