Spec-Zone.ru › GTK 3.24

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 Чтение / Запись
char * decoration-layout Чтение / Запись
gboolean decoration-layout-set Чтение / Запись
gboolean has-subtitle Чтение / Запись
gboolean show-close-button Чтение / Запись
int spacing Чтение / Запись
char * subtitle Чтение / Запись
char * title Чтение / Запись

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

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

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

struct GtkHeaderBar

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

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

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

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

Включаемые файлы

#include <gtk/gtk.h>

Описание

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

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

По этим причинам GtkHeaderBar является естественным выбором для использования в качестве пользовательского виджета заголовка окна GtkWindow (см. gtk_window_set_titlebar()), так как он предоставляет функции, типичные для заголовков, позволяя при этом добавлять дочерние виджеты.

Функции

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 to be added to 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 *

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

Владелец: GtkHeaderBar

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

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

  “decoration-layout”        char *

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

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

Владелец: GtkHeaderBar

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

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

С: 3.12

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

  “decoration-layout-set”    gboolean

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

Владелец: GtkHeaderBar

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

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

С: 3.12

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

  “has-subtitle”             gboolean

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

Владелец: GtkHeaderBar

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

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

С: 3.12

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

  “show-close-button”        gboolean

Определяет, отображать ли элементы управления окном.

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

Владелец: GtkHeaderBar

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

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

Свойство “spacing”

  “spacing”                  int

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

Владелец: GtkHeaderBar

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

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

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

Свойство “subtitle”

  “subtitle”                 char *

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

Владелец: GtkHeaderBar

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

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

Свойство “title”

  “title”                    char *

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

Владелец: GtkHeaderBar

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

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

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

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

  “pack-type”                GtkPackType

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

Владелец: GtkHeaderBar

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

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

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

  “position”                 int

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

Владелец: GtkHeaderBar

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

Допустимые значения: >= -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.24/GtkHeaderBar.html

Spec-Zone.ru

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