Spec-Zone.ru › GTK 3.20

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

Spec-Zone.ru

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