Spec-Zone.ru › GTK 4.0

GtkRange

GtkRange — Базовый класс для виджетов, которые визуализируют корректировку

Функции

double gtk_range_get_fill_level ()
gboolean gtk_range_get_restrict_to_fill_level ()
gboolean gtk_range_get_show_fill_level ()
void gtk_range_set_fill_level ()
void gtk_range_set_restrict_to_fill_level ()
void gtk_range_set_show_fill_level ()
GtkAdjustment * gtk_range_get_adjustment ()
void gtk_range_set_adjustment ()
gboolean gtk_range_get_inverted ()
void gtk_range_set_inverted ()
double gtk_range_get_value ()
void gtk_range_set_value ()
void gtk_range_set_increments ()
void gtk_range_set_range ()
int gtk_range_get_round_digits ()
void gtk_range_set_round_digits ()
gboolean gtk_range_get_flippable ()
void gtk_range_set_flippable ()
void gtk_range_get_range_rect ()
void gtk_range_get_slider_range ()
gboolean gtk_range_get_slider_size_fixed ()
void gtk_range_set_slider_size_fixed ()

Свойства

GtkAdjustment * adjustment Чтение / Запись / Создание
double fill-level Чтение / Запись
gboolean inverted Чтение / Запись
gboolean restrict-to-fill-level Чтение / Запись
int round-digits Чтение / Запись
gboolean show-fill-level Чтение / Запись

Сигналы

void adjust-bounds Выполнить последним
gboolean change-value Выполнить последним
void move-slider Действие
void value-changed Выполнить последним

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

struct GtkRange

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

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkRange
                ╰── GtkScale

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

GtkRange реализует GtkAccessible, GtkBuildable, GtkConstraintTarget и GtkOrientable.

Файлы заголовков

#include <gtk/gtk.h>

Описание

GtkRange — это общий базовый класс для виджетов, которые визуализируют корректировку, например GtkScale или GtkScrollbar.

Помимо сигналов для отслеживания параметров корректировки, GtkRange предоставляет свойства и методы для установки «уровня заполнения» на виджетах диапазона. См. gtk_range_set_fill_level().

Функции

gtk_range_get_fill_level ()

double
gtk_range_get_fill_level (GtkRange *range);

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

Параметры

range

A GtkRange

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

Текущий уровень заполнения

gtk_range_get_restrict_to_fill_level ()

gboolean
gtk_range_get_restrict_to_fill_level (GtkRange *range);

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

Параметры

range

A GtkRange

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

TRUE если range ограничен уровнем заполнения.

gtk_range_get_show_fill_level ()

gboolean
gtk_range_get_show_fill_level (GtkRange *range);

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

Параметры

range

A GtkRange

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

TRUE если range показывает уровень заполнения.

gtk_range_set_fill_level ()

void
gtk_range_set_fill_level (GtkRange *range,
                          double fill_level);

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

«Уровень заполнения» лучше всего описывается его наиболее распространенным вариантом использования — индикатором степени предварительной буферизации в потоковом медиаплеере. В этом случае значение диапазона будет указывать текущую позицию воспроизведения, а уровень заполнения — позицию, до которой файл/поток был загружен.

Этот объем предварительной буферизации может отображаться на канале диапазона и настраивается отдельно от канала. Чтобы включить отображение уровня заполнения, используйте gtk_range_set_show_fill_level(). По умолчанию диапазон не показывает уровень заполнения.

Кроме того, можно ограничить положение ползунка диапазона значениями, меньшими, чем уровень заполнения. Это контролируется функцией gtk_range_set_restrict_to_fill_level() и по умолчанию включено.

Параметры

range

a GtkRange

fill_level

новое положение индикатора уровня заполнения

gtk_range_set_restrict_to_fill_level ()

void
gtk_range_set_restrict_to_fill_level (GtkRange *range,
                                      gboolean restrict_to_fill_level);

Задает, ограничен ли ползунок уровнем заполнения. См. gtk_range_set_fill_level() для общего описания концепции уровня заполнения.

Параметры

range

A GtkRange

restrict_to_fill_level

Ограничивает ли уровень заполнения движение ползунка.

gtk_range_set_show_fill_level ()

void
gtk_range_set_show_fill_level (GtkRange *range,
                               gboolean show_fill_level);

Задает, отображается ли графический уровень заполнения на канале. См. gtk_range_set_fill_level() для общего описания концепции уровня заполнения.

Параметры

range

A GtkRange

show_fill_level

Отображается ли графика индикатора уровня заполнения.

gtk_range_get_adjustment ()

GtkAdjustment *
gtk_range_get_adjustment (GtkRange *range);

Получает GtkAdjustment, который является объектом «модели» для GtkRange. См. gtk_range_set_adjustment() для подробностей. К возвращаемому значению не добавляется ссылка, поэтому его не следует освобождать.

Параметры

range

a GtkRange

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

a GtkAdjustment.

[transfer none]

gtk_range_set_adjustment ()

void
gtk_range_set_adjustment (GtkRange *range,
                          GtkAdjustment *adjustment);

Устанавливает настройку, которая будет использоваться в качестве объекта «модели» для этого виджета диапазона. Настройка указывает текущее значение диапазона, минимальные и максимальные значения диапазона, приращения шага/страницы, используемые для привязки клавиш и прокрутки, а также размер страницы. Размер страницы обычно равен 0 для GtkScale и не равен нулю для GtkScrollbar, и указывает размер видимой области прокручиваемого виджета. Размер страницы влияет на размер ползунка полосы прокрутки.

Параметры

range

a GtkRange

adjustment

a GtkAdjustment

gtk_range_get_inverted ()

gboolean
gtk_range_get_inverted (GtkRange *range);

Возвращает значение, установленное с помощью gtk_range_set_inverted().

Параметры

range

a GtkRange

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

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

gtk_range_set_inverted ()

void
gtk_range_set_inverted (GtkRange *range,
                        gboolean setting);

Диапазоны обычно перемещаются от меньших к большим значениям, когда ползунок перемещается сверху вниз или слева направо. Инвертированные диапазоны имеют большие значения сверху или справа, а не снизу или слева.

Параметры

range

a GtkRange

setting

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

gtk_range_get_value ()

double
gtk_range_get_value (GtkRange *range);

Возвращает текущее значение диапазона.

Параметры

range

a GtkRange

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

текущее значение диапазона.

gtk_range_set_value ()

void
gtk_range_set_value (GtkRange *range,
                     double value);

Устанавливает текущее значение диапазона; если значение находится за пределами минимальных или максимальных значений диапазона, оно будет ограничено, чтобы соответствовать им. Диапазон излучает сигнал “value-changed”, если значение изменяется.

Параметры

range

a GtkRange

value

новое значение диапазона

gtk_range_set_increments ()

void
gtk_range_set_increments (GtkRange *range,
                          double step,
                          double page);

Устанавливает шаг и размер страницы для диапазона. Размер шага используется, когда пользователь щелкает стрелки GtkScrollbar или перемещает GtkScale с помощью клавиш со стрелками. Размер страницы используется, например, при перемещении с помощью клавиш «Page Up» или «Page Down».

Параметры

range

a GtkRange

step

размер шага

page

размер страницы

gtk_range_set_range ()

void
gtk_range_set_range (GtkRange *range,
                     double min,
                     double max);

Устанавливает допустимые значения в GtkRange и прижимает значение диапазона к значению между min и max. (Если у диапазона есть ненулевой размер страницы, он прижимается к значению между min и max - размер страницы.)

Параметры

range

a GtkRange

min

минимальное значение диапазона

max

максимальное значение диапазона

gtk_range_get_round_digits ()

int
gtk_range_get_round_digits (GtkRange *range);

Получает количество цифр, к которым необходимо округлить значение при изменении. См. “change-value”.

Параметры

range

a GtkRange

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

количество цифр для округления

gtk_range_set_round_digits ()

void
gtk_range_set_round_digits (GtkRange *range,
                            int round_digits);

Устанавливает количество цифр, к которым необходимо округлить значение при изменении. См. “change-value”.

Параметры

range

a GtkRange

round_digits

точность в цифрах или -1

gtk_range_get_flippable ()

gboolean
gtk_range_get_flippable (GtkRange *range);

Получает значение, установленное функцией gtk_range_set_flippable().

Параметры

range

a GtkRange

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

TRUE если диапазон переключаемый

gtk_range_set_flippable ()

void
gtk_range_set_flippable (GtkRange *range,
                         gboolean flippable);

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

См. gtk_widget_get_direction().

Параметры

range

a GtkRange

flippable

TRUE для переключения диапазона

gtk_range_get_range_rect ()

void
gtk_range_get_range_rect (GtkRange *range,
                          GdkRectangle *range_rect);

Эта функция возвращает область, содержащую желоб диапазона, в координатах, относящихся к началу range.

Эта функция полезна в основном для подклассов GtkRange.

Параметры

range

a GtkRange

range_rect

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

[out]

gtk_range_get_slider_range ()

void
gtk_range_get_slider_range (GtkRange *range,
                            int *slider_start,
                            int *slider_end);

Эта функция возвращает диапазон ползунков по длинной оси в координатах виджета->окна.

Эта функция полезна в основном для подклассов GtkRange.

Параметры

range

a GtkRange

slider_start

место возврата начала ползунка или NULL.

[out][allow-none]

slider_end

место возврата конца ползунка или NULL.

[out][allow-none]

gtk_range_get_slider_size_fixed ()

gboolean
gtk_range_get_slider_size_fixed (GtkRange *range);

Эта функция полезна в основном для подклассов GtkRange.

См. gtk_range_set_slider_size_fixed().

Параметры

range

a GtkRange

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

флаг, если размер ползунка диапазона фиксированный.

gtk_range_set_slider_size_fixed ()

void
gtk_range_set_slider_size_fixed (GtkRange *range,
                                 gboolean size_fixed);

Устанавливает, имеет ли ползунок диапазона фиксированный размер или размер, зависящий от размера страницы настройки.

Эта функция полезна в основном для подклассов GtkRange.

Параметры

range

a GtkRange

size_fixed

TRUE для постоянного размера ползунка

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

struct GtkRange

struct GtkRange;

Подробное описание свойств

Свойство “adjustment”

  “adjustment”               GtkAdjustment *

GtkAdjustment, содержащий текущее значение этого объекта диапазона.

Владелец: GtkRange

Флаги: Чтение / Запись / Создание

Свойство “fill-level”

  “fill-level”               double

Уровень заполнения (например, предварительная буферизация сетевого потока). См. gtk_range_set_fill_level().

Владелец: GtkRange

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

Значение по умолчанию: 1.79769e+308

Свойство “inverted”

  “inverted”                 gboolean

Инвертировать направление перемещения ползунка для увеличения значения диапазона.

Владелец: GtkRange

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

Значение по умолчанию: ЛОЖЬ

Свойство “restrict-to-fill-level”

  “restrict-to-fill-level”   gboolean

Свойство restrict-to-fill-level контролирует, ограничено ли перемещение ползунка верхней границей, заданной уровнем заполнения. См. gtk_range_set_restrict_to_fill_level().

Владелец: GtkRange

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

Значение по умолчанию: ИСТИНА

Свойство “round-digits”

  “round-digits”             int

Количество цифр для округления значения при изменении, или -1. См. “change-value”.

Владелец: GtkRange

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

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

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

Свойство “show-fill-level”

  “show-fill-level”          gboolean

Свойство show-fill-level контролирует, отображаются ли графические индикаторы уровня заполнения на желобе. См. gtk_range_set_show_fill_level().

Владелец: GtkRange

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

Значение по умолчанию: ЛОЖЬ

Подробное описание сигналов

Сигнал “adjust-bounds”

void
user_function (GtkRange *range,
               double    value,
               gpointer  user_data)

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

Параметры

range

объект GtkRange, получивший сигнал

value

значение перед ограничением

user_data

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

Флаги: Выполнять последним

Сигнал “change-value”

gboolean
user_function (GtkRange     *range,
               GtkScrollType scroll,
               double        value,
               gpointer      user_data)

Сигнал “change-value” генерируется при выполнении действия прокрутки на диапазоне. Он позволяет приложению определить тип события прокрутки и результирующее новое значение. Приложение может обработать событие само и вернуть TRUE для предотвращения дальнейшей обработки. Или, вернув FALSE, оно может передать событие другим обработчикам, пока не будет достигнут обработчик по умолчанию GTK.

Параметр value не округлён. Приложение, которое переопределяет сигнал GtkRange::change-value, отвечает за ограничение значения до желаемого количества десятичных знаков; обработчик по умолчанию GTK ограничивает значение на основе “round-digits”.

Параметры

range

объект GtkRange, получивший сигнал

scroll

тип действия прокрутки, выполненного

value

новое значение, полученное в результате действия прокрутки

user_data

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

Возвращает

TRUE для предотвращения вызова других обработчиков для сигнала, FALSE для распространения сигнала дальше

Флаги: Выполнять последним

Сигнал “move-slider”

void
user_function (GtkRange     *range,
               GtkScrollType step,
               gpointer      user_data)

Виртуальная функция, перемещающая ползунок. Используется для горячих клавиш.

Параметры

range

объект GtkRange, получивший сигнал

step

способ перемещения ползунка

user_data

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

Флаги: Действие

Сигнал “value-changed”

void
user_function (GtkRange *range,
               gpointer  user_data)

Выдается, когда значение диапазона изменяется.

Параметры

range

объект GtkRange, получивший сигнал

user_data

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

Флаги: Выполнять последним

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer-old.gnome.org/gtk4/4.0/GtkRange.html

Spec-Zone.ru

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