Файлы ресурсов

Файлы по умолчанию

Приложение может заставить GTK+ разобрать определённый файл RC, вызвав gtk_rc_parse(). Кроме этого, определённые файлы будут прочитаны в конце gtk_init(). Если не изменять, будут искаться файлы SYSCONFDIR/gtk-2.0/gtkrc и .gtkrc-3.0 в домашнем каталоге пользователя. (SYSCONFDIR по умолчанию /usr/local/etc. Его можно изменить с помощью опций --prefix или --sysconfdir при настройке GTK+.)

Набор этих «файлов по умолчанию» можно получить с помощью gtk_rc_get_default_files() и изменить с помощью gtk_rc_add_default_file() и gtk_rc_set_default_files(). Кроме того, переменная среды GTK2_RC_FILES может быть установлена в список файлов, разделённых символом G_SEARCHPATH_SEPARATOR_S, чтобы перезаписать набор файлов по умолчанию во время выполнения.

Файлы, специфичные для локали

Для каждого файла RC, помимо самого файла, GTK+ будет искать локально-специфичный файл, который будет обработан после основного файла. Например, если LANG установлено в ja_JP.ujis, при загрузке файла по умолчанию ~/.gtkrc, GTK+ ищет ~/.gtkrc.ja_JP и ~/.gtkrc.ja, и обрабатывает первый из тех, которые существуют.

Имена путей и шаблоны

Файл ресурсов определяет ряд стилей и назначений клавиш и прикрепляет их к определённым виджетам. Привязка выполняется с помощью widget, widget_class, и class объявлений. Пример такого утверждения:

прикрепляет стиль "my-entry-class" ко всем виджетам, путь к которым соответствует шаблону "mywindow.*.GtkEntry". То есть, все виджеты GtkEntry, которые являются частью окна GtkWindow с именем "mywindow".

Здесь шаблоны заданы в стандартной синтаксике оболочки glob. Символ "?" соответствует любому символу, а "*" соответствует нулю или более любым символам. Три типа сопоставления осуществляются по пути к виджету, по «пути класса» и по иерархии классов. И путь к виджету, и путь к классу состоят из списка родителей виджета и самого виджета, разделённых символом ".", от внешнего к внутреннему. Разница в том, что в пути к виджету используется имя, заданное с помощью gtk_widget_set_name(), если оно присутствует, в противном случае используется имя класса виджета, а для пути к классу всегда используется имя класса.

Начиная с GTK+ 2.10, пути widget_class могут также содержать подстроки <classname>, которые соответствуют классу с заданным именем и всем производным классам. Например,

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

Таким образом, если у вас есть виджет GtkEntry с именем "myentry", внутри горизонтальной панели в окне с именем "mywindow", то путь к виджету: "mywindow.GtkHBox.myentry", а путь к классу: "GtkWindow.GtkHBox.GtkEntry".

Сопоставление с классом немного отличается. Сопоставление шаблона выполняется со всеми именами классов в иерархии классов виджетов (а не в иерархии компоновки) последовательно, поэтому шаблон:

будет соответствовать не только виджетам GtkButton, но также и виджетам GtkToggleButton и GtkCheckButton, так как эти классы являются производными от GtkButton.

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

rc — значение по умолчанию для стилей, считываемых из файла RC, theme — значение по умолчанию для стилей, считываемых из файлов темы RC, application следует использовать для стилей, настраиваемых приложением, и gtk используется для стилей, созданных GTK+ внутри.

Файлы темы gtkrc

Файлы темы RC загружаются сначала из ~/.themes/, а затем из каталога из gtk_rc_get_theme_dir(). Изучаемые файлы будут gtk-3.0/gtkrc.

Когда приложение предпочитает тёмные темы (см. свойство “gtk-application-prefer-dark-theme” для подробностей), gtk-3.0/gtkrc-dark будет загружен первым, а если его нет, то gtk-3.0/gtkrc.

Оптимизация сопоставлений стиля RC

Каждый раз, когда виджет создаётся и добавляется в иерархию компоновки GtkWindow («прикреплён»), составляется список соответствующих стилей RC из всех прочитанных стилей RC. Для этого каждый стиль RC сопоставляется с путём к классу виджетов, путём к имени виджетов и иерархией наследования виджетов. Вследствие этого значительное замедление может быть вызвано использованием большого количества стилей RC и использованием шаблонов стилей RC, которые медленно или сложно сопоставляются с данным виджетом. Следующий упорядоченный список даёт ряд советов (в порядке убывания эффективности) для уменьшения накладных расходов, связанных с сопоставлением стилей RC:

Объявления верхнего уровня

Файл RC — это текстовый файл, состоящий из последовательности объявлений. Символы “#” обозначают комментарии, а часть строки после “#” игнорируется при разборе файла RC.

Возможные объявления верхнего уровня:

Стили

Стиль RC задаётся объявлением style в файле RC, а затем связывается с виджетами с помощью объявления widget, widget_class, или class. Все стили, применяемые к определённому виджету, композируются вместе, причём объявления widget переопределяют объявления widget_class, которые в свою очередь переопределяют объявления class. Внутри каждого типа объявлений последующие объявления переопределяют предыдущие.

Внутри объявления style возможные элементы:

Цвета и фоновые изображения задаются в зависимости от состояния виджета. Состояния:

Настройки клавиш

Настройки клавиш позволяют пользователю указывать действия, которые должны выполняться при нажатии определенных клавиш. Формат объявления набора настроек:

key — это строка, состоящая из последовательности модификаторов, за которыми следует имя клавиши. Модификаторы могут быть:

<shft> является псевдонимом для <shift>, <ctl> — псевдонимом для <control>, а <alt> — псевдонимом для <mod1>.

Действие, связанное с нажатием клавиши, представляет собой последовательность имён сигналов (строки), за которыми следуют параметры для каждого сигнала. Сигналы должны быть сигналами действия. (См. g_signal_new()). Каждый параметр может быть числом с плавающей точкой, целым числом, строкой или необрамлённой строкой, представляющей значение перечисления. Типы указанных параметров должны соответствовать типам параметров сигнала.

Наборы настроек связываются с виджетами так же, как и стили, с одним отличием: Наборы настроек переопределяют другие наборы настроек сначала по типу шаблона, затем по приоритету и затем по порядку указания. Приоритеты, которые можно указать, и их значения по умолчанию такие же, как и для стилей.

gtk_rc_scanner_new ()

GScanner *
gtk_rc_scanner_new (void);

[skip]

gtk_rc_get_style ()

GtkStyle *
gtk_rc_get_style (GtkWidget *widget);

Находит все соответствующие стили RC для данного виджета, объединяет их и затем создает GtkStyle, представляющий объединенный внешний вид. (GTK+ фактически хранит кэш ранее созданных стилей, поэтому новый стиль может не создаваться.)

gtk_rc_get_style_by_paths ()

GtkStyle *
gtk_rc_get_style_by_paths (GtkSettings *settings,
                           const char *widget_path,
                           const char *class_path,
                           GType type);

Создает GtkStyle из стилей, определенных в файле RC, предоставляя необработанные компоненты, используемые при сопоставлении. Эта функция может быть полезна при создании псевдо-виджетов, которые должны быть оформлены как виджеты, но на самом деле не имеют соответствующих виджетов GTK+. Примером этого могут быть элементы внутри виджета GNOME canvas.

Действие gtk_rc_get_style() аналогично:

widget "mywindow.*.GtkEntry" style "my-entry-class"

gtk_rc_parse ()

void
gtk_rc_parse (const gchar *filename);

Разбирает заданный файл ресурсов.

gtk_rc_parse_string ()

void
gtk_rc_parse_string (const gchar *rc_string);

Разбирает информацию о ресурсах непосредственно из строки.

gtk_rc_reparse_all ()

gboolean
gtk_rc_reparse_all (void);

Если время изменения любого ранее прочитанного файла для настроек по умолчанию GtkSettings изменилось, отбросьте всю информацию о стиле и заново прочитайте все ранее прочитанные файлы RC.

gtk_rc_reparse_all_for_settings ()

gboolean
gtk_rc_reparse_all_for_settings (GtkSettings *settings,
                                 gboolean force_load);

Если время изменения любого ранее прочитанного файла для заданных GtkSettings изменилось, отбросьте всю информацию о стиле и заново прочитайте все ранее прочитанные файлы RC.

gtk_rc_reset_styles ()

void
gtk_rc_reset_styles (GtkSettings *settings);

Эта функция пересчитывает стили для всех виджетов, которые используют определенный объект GtkSettings. (Существует один объект GtkSettings на каждый GdkScreen, см. gtk_settings_get_for_screen()); Он полезен, когда изменяется какой-либо глобальный параметр, влияющий на внешний вид всех виджетов, поскольку, когда виджет получает новый стиль, он будет как перерисовываться, так и пересчитывать любую кэшированную информацию о своем внешнем виде. Например, он используется, когда меняется размер шрифта по умолчанию, установленный операционной системой. Обратите внимание, что эта функция не влияет на виджеты, у которых стиль установлен явно с помощью gtk_widget_set_style().

С версии: 2.4

gtk_rc_add_default_file ()

void
gtk_rc_add_default_file (const gchar *filename);

Добавляет файл в список файлов, которые будут пропарсированы в конце gtk_init().

gtk_rc_get_default_files ()

gchar **
gtk_rc_get_default_files (void);

Возвращает текущий список файлов RC, которые будут пропарсированы в конце gtk_init().

gtk_rc_set_default_files ()

void
gtk_rc_set_default_files (gchar **filenames);

Устанавливает список файлов, которые GTK+ будет читать в конце gtk_init().

gtk_rc_parse_color ()

guint
gtk_rc_parse_color (GScanner *scanner,
                    GdkColor *color);

Парсит цвет в формате, ожидаемом в файле RC.

Обратите внимание, что движки тем должны использовать gtk_rc_parse_color_full() для поддержки символьных цветов.

gtk_rc_parse_color_full ()

guint
gtk_rc_parse_color_full (GScanner *scanner,
                         GtkRcStyle *style,
                         GdkColor *color);

Парсит цвет в формате, ожидаемом в файле RC. Если style не NULL, он будет использован для разрешения ссылок на символьные цвета.

С: 2.12

gtk_rc_parse_state ()

guint
gtk_rc_parse_state (GScanner *scanner,
                    GtkStateType *state);

Парсит значение GtkStateType в формате, ожидаемом в файле RC.

gtk_rc_parse_priority ()

guint
gtk_rc_parse_priority (GScanner *scanner,
                       GtkPathPriorityType *priority);

Парсит значение GtkPathPriorityType в формате, ожидаемом в файле RC.

gtk_rc_find_module_in_path ()

gchar *
gtk_rc_find_module_in_path (const gchar *module_file);

Ищет движок темы в пути поиска GTK+. Эта функция не полезна для приложений и не должна использоваться.

gtk_rc_find_pixmap_in_path ()

gchar *
gtk_rc_find_pixmap_in_path (GtkSettings *settings,
                            GScanner *scanner,
                            const gchar *pixmap_file);

Ищет файл в пути к пиктограммам для указанных GtkSettings. Если файл не найден, выводится сообщение об ошибке с использованием g_warning() и возвращается NULL.

gtk_rc_get_module_dir ()

gchar *
gtk_rc_get_module_dir (void);

Возвращает каталог, в котором GTK+ ищет движки тем. Полную информацию о поиске движков тем см. в документации к GTK_PATH в разделе Запуск приложений GTK+.

gtk_rc_get_im-module-path ()

gchar *
gtk_rc_get_im_module_path (void);

Получает путь, в котором следует искать модули IM. Дополнительные сведения о поиске модулей см. в документации переменной среды GTK_PATH. Эта функция полезна только для утилит, поставляемых с GTK+, и не должна использоваться приложениями в обычных условиях.

gtk_rc_get_im_module_file ()

gchar *
gtk_rc_get_im_module_file (void);

Получает путь к файлу модулей IM. Дополнительные сведения см. в документации переменной среды GTK_IM_MODULE_FILE.

gtk_rc_get_theme_dir ()

gchar *
gtk_rc_get_theme_dir (void);

Возвращает стандартный каталог, в котором следует устанавливать темы. (GTK+ на самом деле не использует этот каталог сам.)

gtk_rc_style_new ()

GtkRcStyle *
gtk_rc_style_new (void);

Создает новый GtkRcStyle без установленных полей и со значением счетчика ссылок 1.

gtk_rc_style_copy ()

GtkRcStyle *
gtk_rc_style_copy (GtkRcStyle *orig);

Создает копию указанного GtkRcStyle. Эта функция правильно копирует стиль RC, который является членом класса, производного от GtkRcStyle.

GtkRcStyle

typedef struct {
  gchar *name;
  gchar *bg_pixmap_name[5];
  PangoFontDescription *font_desc;

  GtkRcFlags color_flags[5];
  GdkColor   fg[5];
  GdkColor   bg[5];
  GdkColor   text[5];
  GdkColor   base[5];

  gint xthickness;
  gint ythickness;
} GtkRcStyle;

Структура GtkRcStyle используется для представления набора информации о внешнем виде виджета. Позже её можно комбинировать с другими структурами GtkRcStyle<!-- --> для формирования структуры GtkStyle.

struct GtkRcStyleClass

struct GtkRcStyleClass {
  GObjectClass parent_class;

  /* Create an empty RC style of the same type as this RC style.
   * The default implementation, which does
   * g_object_new (G_OBJECT_TYPE (style), NULL);
   * should work in most cases.
   */
  GtkRcStyle * (*create_rc_style) (GtkRcStyle *rc_style);

  /* Fill in engine specific parts of GtkRcStyle by parsing contents
   * of brackets. Returns G_TOKEN_NONE if successful, otherwise returns
   * the token it expected but didn't get.
   */
  guint     (*parse)  (GtkRcStyle   *rc_style,
                       GtkSettings  *settings,
                       GScanner     *scanner);

  /* Combine RC style data from src into dest. If overridden, this
   * function should chain to the parent.
   */
  void      (*merge)  (GtkRcStyle *dest,
                       GtkRcStyle *src);

  /* Create an empty style suitable to this RC style
   */
  GtkStyle * (*create_style) (GtkRcStyle *rc_style);
};

перечисление GtkRcFlags

Устарело

Перечисление GtkRcTokenType

Перечисление GtkRcTokenType представляет маркеры в файле RC. Оно предоставляется для того, чтобы движки тем могли повторно использовать эти маркеры при разборе специфичных для движка тем частей файла RC.

Перечисление GtkPathPriorityType

Приоритеты для поиска путей. См. также gtk_binding_set_add_path().

Перечисление GtkPathType

Типы путей виджетов. См. также gtk_binding_set_add_path().