[ новости /+++ | форум | теги | ]

Каталог документации / Раздел "Программирование, языки" / Оглавление документа

Краткий обзор

#include <gtk/gtk.h>


            GtkIconSource;
            GtkIconFactory;
            GtkIconSet;
enum        GtkIconSize;
GtkIconSource* gtk_icon_source_copy         (const GtkIconSource *source);
void        gtk_icon_source_free            (GtkIconSource *source);
void        gtk_icon_factory_add            (GtkIconFactory *factory,
                                             const gchar *stock_id,
                                             GtkIconSet *icon_set);
void        gtk_icon_factory_add_default    (GtkIconFactory *factory);
GtkIconSet* gtk_icon_factory_lookup         (GtkIconFactory *factory,
                                             const gchar *stock_id);
GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);
GtkIconFactory* gtk_icon_factory_new        (void);
void        gtk_icon_factory_remove_default (GtkIconFactory *factory);
void        gtk_icon_set_add_source         (GtkIconSet *icon_set,
                                             const GtkIconSource *source);
GtkIconSet* gtk_icon_set_copy               (GtkIconSet *icon_set);
GtkIconSet* gtk_icon_set_new                (void);
GtkIconSet* gtk_icon_set_new_from_pixbuf    (GdkPixbuf *pixbuf);
GtkIconSet* gtk_icon_set_ref                (GtkIconSet *icon_set);
GdkPixbuf*  gtk_icon_set_render_icon        (GtkIconSet *icon_set,
                                             GtkStyle *style,
                                             GtkTextDirection direction,
                                             GtkStateType state,
                                             GtkIconSize size,
                                             GtkWidget *widget,
                                             const char *detail);
void        gtk_icon_set_unref              (GtkIconSet *icon_set);
gboolean    gtk_icon_size_lookup            (GtkIconSize size,
                                             gint *width,
                                             gint *height);
gboolean    gtk_icon_size_lookup_for_settings
                                            (GtkSettings *settings,
                                             GtkIconSize size,
                                             gint *width,
                                             gint *height);
GtkIconSize gtk_icon_size_register          (const gchar *name,
                                             gint width,
                                             gint height);
void        gtk_icon_size_register_alias    (const gchar *alias,
                                             GtkIconSize target);
GtkIconSize gtk_icon_size_from_name         (const gchar *name);
const gchar* gtk_icon_size_get_name         (GtkIconSize size);
void        gtk_icon_set_get_sizes          (GtkIconSet *icon_set,
                                             GtkIconSize **sizes,
                                             gint *n_sizes);
GtkTextDirection gtk_icon_source_get_direction
                                            (const GtkIconSource *source);
gboolean    gtk_icon_source_get_direction_wildcarded
                                            (const GtkIconSource *source);
const gchar* gtk_icon_source_get_filename   (const GtkIconSource *source);
GdkPixbuf*  gtk_icon_source_get_pixbuf      (const GtkIconSource *source);
const gchar* gtk_icon_source_get_icon_name  (const GtkIconSource *source);
GtkIconSize gtk_icon_source_get_size        (const GtkIconSource *source);
gboolean    gtk_icon_source_get_size_wildcarded
                                            (const GtkIconSource *source);
GtkStateType gtk_icon_source_get_state      (const GtkIconSource *source);
gboolean    gtk_icon_source_get_state_wildcarded
                                            (const GtkIconSource *source);
GtkIconSource* gtk_icon_source_new          (void);
void        gtk_icon_source_set_direction   (GtkIconSource *source,
                                             GtkTextDirection direction);
void        gtk_icon_source_set_direction_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);
void        gtk_icon_source_set_filename    (GtkIconSource *source,
                                             const gchar *filename);
void        gtk_icon_source_set_pixbuf      (GtkIconSource *source,
                                             GdkPixbuf *pixbuf);
void        gtk_icon_source_set_icon_name   (GtkIconSource *source,
                                             const gchar *icon_name);
void        gtk_icon_source_set_size        (GtkIconSource *source,
                                             GtkIconSize size);
void        gtk_icon_source_set_size_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);
void        gtk_icon_source_set_state       (GtkIconSource *source,
                                             GtkStateType state);
void        gtk_icon_source_set_state_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);

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

  GObject
   +----GtkIconFactory

Описание

Посмотреть доступные заготовки значков в списке заготовленных IDs можно здесь. Вы можете также использовать gtk-demo приложение для решения этой задачи.

Производство¹ значков управляет коллекцией GtkIconSet; GtkIconSet управляет специальными вариантами установки значка (т.е. GtkIconSet вмещает варианты различных размеров и состояний виджета). Значки в производстве значков имеют именованные заготовки ID, который является простой строкой идентифицирующей значок. Каждый GtkStyle имеет список GtkIconFactory, полученный из текущемй темы; производство значков для поиска значка, сначала обращается к ним. Если тема не установила специфический значок, GTK+ ищет значок значения по умолчанию в списке производства значков, используя gtk_icon_factory_add_default() и gtk_icon_factory_remove_default(). Приложения со значками должны добавлять их в производство значков, чтобы тема могла аннулировать значок для приложения.

Для отображения значков, всегда используется gtk_style_lookup_icon_set() с виджетом, который отображает значок, или функцию gtk_widget_render_icon(). Эти функции принимают во внимание использующуюся тему и ищут значок с полученным заготовленным ID.

Детали

GtkIconSource

typedef struct _GtkIconSource GtkIconSource;

GtkIconFactory

typedef struct _GtkIconFactory GtkIconFactory;

GtkIconSet

typedef struct _GtkIconSet GtkIconSet;

перечень GtkIconSize

typedef enum
{
  GTK_ICON_SIZE_INVALID,
  GTK_ICON_SIZE_MENU,
  GTK_ICON_SIZE_SMALL_TOOLBAR,
  GTK_ICON_SIZE_LARGE_TOOLBAR,
  GTK_ICON_SIZE_BUTTON,
  GTK_ICON_SIZE_DND,
  GTK_ICON_SIZE_DIALOG
} GtkIconSize;

gtk_icon_source_copy ()

GtkIconSource* gtk_icon_source_copy         (const GtkIconSource *source);

Создаёт копию source; полезно главным образом для языковых привязок.

gtk_icon_source_free ()

void        gtk_icon_source_free            (GtkIconSource *source);

Освобождает динамически-распределённый источник значка, наряду с его именем файла, размером и полем pixbuf если те не равны NULL.

gtk_icon_factory_add ()

void        gtk_icon_factory_add            (GtkIconFactory *factory,
                                             const gchar *stock_id,
                                             GtkIconSet *icon_set);

Добавляет полученный icon_set к производству значков, в соответствии с именем stock_id. stock_id, должен быть примечательным для вашего приложения, например "myapp-whatever-icon". Обычно приложения создают GtkIconFactory, который добавляют в список производства по умолчанию, используя gtk_icon_factory_add_default(). Потом они передают stock_id в виджеты, такие как GtkImage для отображения значков. Темы могут предоставлять значки с некоторым именем (как например "myapp-whatever-icon"), для отмены значка по умолчанию вашим приложением. Если значок существует в factory для stock_id, это не отсылается и перезаписывается новым icon_set.

gtk_icon_factory_add_default ()

void        gtk_icon_factory_add_default    (GtkIconFactory *factory);

Добавляет производство значков в список, для поиска с помощью gtk_style_lookup_icon_set(). Это значит что, например gtk_image_new_from_stock() будет способна найти значки в factory. Обычно добавляется производство значков для каждой библиотеки или приложения идущих со значками. По умолчанию, производство значков может быть отменено темами.

gtk_icon_factory_lookup ()

GtkIconSet* gtk_icon_factory_lookup         (GtkIconFactory *factory,
                                             const gchar *stock_id);

Находит stock_id в производстве значков, возвращает установки значка если найдено, или NULL. Для отображения пользователю, вы должны использовать gtk_style_lookup_icon_set() на GtkStyle, для виджета который будет отображать значок, вместо непосредственного использования функции, так чтобы темы были приняты во внимание.

gtk_icon_factory_lookup_default ()

GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);

Ищет значок в списке производств значков по умолчанию. Для отображения пользователю, вы должны использовать gtk_style_lookup_icon_set() на GtkStyle, для виджета который будет отображать значок, вместо использования этой функции непосредственно, так чтобы темы были приняты во внимание.

gtk_icon_factory_new ()

GtkIconFactory* gtk_icon_factory_new        (void);

Создаёт новый GtkIconFactory. Производство значков управляет коллекцией GtkIconSets; GtkIconSet управляет вариантами установок специального значка (т.е. GtkIconSet содержит варианты для различных размеров и состояний виджетов). Значки в производстве значков именованы заготовленными ID, являющимся просто строкой идентифицирующей значок. Каждый GtkStyle имеет список GtkIconFactorys, полученный из текущемй темы; для поиска значка, сначала обращаются к этому списку производств значков. Если тема не установила специальный значок, GTK+ ищет значок в списке производств по умолчанию, с помощью gtk_icon_factory_add_default() и gtk_icon_factory_remove_default(). Приложения со значками должны добавлять их в производство значков по умолчанию, которое позволит темам отменять значки приложения.

gtk_icon_factory_remove_default ()

void        gtk_icon_factory_remove_default (GtkIconFactory *factory);

Удаляет производство значков из списка производств по умолчанию. Используется не обычно; вы могли бы использовать это для библиотеки которая может быть выгружена или отключена.

gtk_icon_set_add_source ()

void        gtk_icon_set_add_source         (GtkIconSet *icon_set,
                                             const GtkIconSource *source);

Наборы значков имеют список GtkIconSource, который они используют как основу для представления значков в различных статусах и размерах. Значки масштабируются, делаются не чуствительными, и т.д. в gtk_icon_set_render_icon(), но для работы, GtkIconSet нуждается в основных изображениях. Основные изображения и когда их использовать описаны в GtkIconSource.

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

Например, когда вы используете эту функцию: значок веб-браузера "Back to Previous Page" указывает в различных направлениях на иврите и на английском языках; возможен различный вид нечувствительности; и можно изменять размер в зависимости от режима панели инструментов (маленькие/большие значки). Таким образом единственный набор значков может содержать все эти варианты значка, и вы можете добавить отдельный источник для каждого.

Вы должны почти всегда добавлять источник значка "default", во все поля групп, который будет использоваться как аварийный вариант, если не найден ни один источник. GtkIconSet всегда предпочитает более определённые источники значков, чем основные источники значков. Порядок в котором вы добавляете источник значка к набору значков, не имеет значения.

gtk_icon_set_new_from_pixbuf() создаёт новый набор значков с источником значков по умолчанию, основанном на полученном буфере изображения (pixbuf).

gtk_icon_set_copy ()

GtkIconSet* gtk_icon_set_copy               (GtkIconSet *icon_set);

Копирует значение icon_set.

gtk_icon_set_new ()

GtkIconSet* gtk_icon_set_new                (void);

Создаёт новый GtkIconSet. GtkIconSet представляет единственный значок в различных размерах и состояниях виджета. Это может обеспечить GdkPixbuf для получения размера и состояния запроса, а также автоматически кэширует некоторые предоставленные объекты GdkPixbuf.

Обычно используется gtk_widget_render_icon() вместо непосредственного использования GtkIconSet. Единственный случай где необходимо использование GtkIconSet, это набор значков, специфичный для приложения, помещаемый в GtkIconFactory.

gtk_icon_set_new_from_pixbuf ()

GtkIconSet* gtk_icon_set_new_from_pixbuf    (GdkPixbuf *pixbuf);

Создаёт новый GtkIconSet с pixbuf как источник изображения по умолчанию при переходе на аварийный режим. Если вы не добавите в набор значков любые дополнения GtkIconSource, все варианты значков будут созданы из pixbuf, используя масштабирование, разбор изображения, и т.д. что потребуется, чтобы корректировать размер значка или создать нечувствительный/затененный значок.

gtk_icon_set_ref ()

GtkIconSet* gtk_icon_set_ref                (GtkIconSet *icon_set);

Увеличивает справочную информацию на icon_set.

gtk_icon_set_render_icon ()

GdkPixbuf*  gtk_icon_set_render_icon        (GtkIconSet *icon_set,
                                             GtkStyle *style,
                                             GtkTextDirection direction,
                                             GtkStateType state,
                                             GtkIconSize size,
                                             GtkWidget *widget,
                                             const char *detail);

Отдаёт значок используя gtk_style_render_icon(). В большинстве случаев, gtk_widget_render_icon() лучше, так как автоматически обеспечивает большинство параметров из текущих установок виджета. Эта функция никогда не возвращает NULL; если значок не был получен (возможно потому, что файл изображения не смог загрузиться), вместо него будет возвращен значок по умолчанию "missing image".

gtk_icon_set_unref ()

void        gtk_icon_set_unref              (GtkIconSet *icon_set);

Уменьшает справочную информацию на icon_set и освобождает память если счёт справочной информации достиг 0.

gtk_icon_size_lookup ()

gboolean    gtk_icon_size_lookup            (GtkIconSize size,
                                             gint *width,
                                             gint *height);

Получает размер пиксела семантического размера значка, возможно изменённого пользовательскими настройками значения по умолчанию GtkSettings. (Смотрите gtk_icon_size_lookup_for_settings().) Обычно size будет GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_BUTTON, и т.д.. Эта функция как правило не нужна, gtk_widget_render_icon()- обычный способ получения значка для отображения, после чего просто смотрит размер отображаемого pixbuf. Представляемый pixbuf может даже не соответствовать ширине/высоте возвращаемым gtk_icon_size_lookup(), потому что темы имеют свободное представление pixbuf, однако они предпочитают включать замену обычного размера.

gtk_icon_size_lookup_for_settings ()

gboolean    gtk_icon_size_lookup_for_settings
                                            (GtkSettings *settings,
                                             GtkIconSize size,
                                             gint *width,
                                             gint *height);

Получает размер пиксела семантического размера значка, возможно изменённого пользовательскими настройками значения по умолчанию GtkSettings. Обычно size будет GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_BUTTON, и т.д.. Эта функция как правило не нужна, gtk_widget_render_icon()- обычный способ получения значка для отображения, после чего просто смотрит размер отображаемого pixbuf.Представляемый pixbuf может даже не соответствовать ширине/высоте возвращаемым gtk_icon_size_lookup(), потому что темы имеют свободное представление pixbuf, однако они предпочитают включать замену обычного размера.

Начиная с версии 2.2

gtk_icon_size_register ()

GtkIconSize gtk_icon_size_register          (const gchar *name,
                                             gint width,
                                             gint height);

Регистрирует новый размер значка, по тем же самым линиям как GTK_ICON_SIZE_MENU, и т.д.. Возвращает целое значение для размера.

gtk_icon_size_register_alias ()

void        gtk_icon_size_register_alias    (const gchar *alias,
                                             GtkIconSize target);

Регистрирует alias как другое имя для target. Таким образом вызывается gtk_icon_size_from_name() с параметром alias, возвращающая target.

gtk_icon_size_from_name ()

GtkIconSize gtk_icon_size_from_name         (const gchar *name);

Определяет размер значка ассоциированный с name.

gtk_icon_size_get_name ()

const gchar* gtk_icon_size_get_name         (GtkIconSize size);

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

gtk_icon_set_get_sizes ()

void        gtk_icon_set_get_sizes          (GtkIconSet *icon_set,
                                             GtkIconSize **sizes,
                                             gint *n_sizes);

Получает список размеров значка в которых он может отображаться. Возвращает массив, который можно освободить с помощью g_free().

gtk_icon_source_get_direction ()

GtkTextDirection gtk_icon_source_get_direction
                                            (const GtkIconSource *source);

Получает направление текста, к которому обращается этот источник значка. Возвращаемое значение полезно/значимо только если направление текста не универсально (wildcarded).

gtk_icon_source_get_direction_wildcarded ()

gboolean    gtk_icon_source_get_direction_wildcarded
                                            (const GtkIconSource *source);

Получает значение установленное gtk_icon_source_set_direction_wildcarded().

gtk_icon_source_get_filename ()

const gchar* gtk_icon_source_get_filename   (const GtkIconSource *source);

Отыскивает исходное имя файла, или NULL если не установлено. Имя файла не копируется и не должно модифицироваться, или ожидать сохранения после срока действия исходного значка.

gtk_icon_source_get_pixbuf ()

GdkPixbuf*  gtk_icon_source_get_pixbuf      (const GtkIconSource *source);

Отыскивает исходный pixbuf, или NULL если не установлен. Кроме того, если источник имени файла используется, эта функция возвратит в некоторых случаях pixbuf из загруженного файла. Например это истинно для GtkIconSource помещенного в GtkStyle::render_icon() виртуальной функцией. Подсчет справочной информации на pixbuf не увеличивается.

gtk_icon_source_get_icon_name ()

const gchar* gtk_icon_source_get_icon_name  (const GtkIconSource *source);

Отыскивает исходное имя значка, или NULL если не установлено. Имя значка не копируется и не должно изменяться или ожидать сохранения после срока действия исходного значка.

gtk_icon_source_get_size ()

GtkIconSize gtk_icon_source_get_size        (const GtkIconSource *source);

Отыскивает размер значка к которому обращается источник. Возвращаемое значение полезно/значимо только если размер значка не универсален (wildcarded).

gtk_icon_source_get_size_wildcarded ()

gboolean    gtk_icon_source_get_size_wildcarded
                                            (const GtkIconSource *source);

Получает значение установленное gtk_icon_source_set_size_wildcarded().

gtk_icon_source_get_state ()

GtkStateType gtk_icon_source_get_state      (const GtkIconSource *source);

Получает состояние виджета к которому обращается этот источник значка. Возвращаемое значение полезно/значимо только если состояние виджета не универсально (wildcarded).

gtk_icon_source_get_state_wildcarded ()

gboolean    gtk_icon_source_get_state_wildcarded
                                            (const GtkIconSource *source);

Получает значение установленное gtk_icon_source_set_state_wildcarded().

gtk_icon_source_new ()

GtkIconSource* gtk_icon_source_new          (void);

Создаёт новый GtkIconSource. GtkIconSource содержит GdkPixbuf (или имя файла изображения), который служит как основа для одного или более значков в GtkIconSet, наряду со спецификацией, значки в наборе значков будут основаны на pixbuf или файле изображения. Наборы значка содержат установку которая представляет "ту же самую" логическую концепцию в различных состояниях, различные глобальные направления текста и различные размеры.

Таким образом значок веб-браузера "Back to Previous Page" может указывать в различных направлениях в иврите и английском языках; возможен различный вид нечувствительности; и возможно изменение размера в зависимости от состояния панели инструментов (маленькие/большие значки). Таким образом единственный набор значка может содержать все эти варианты значка. GtkIconSet содержит список GtkIconSource, из которого может получить специальные варианты установок значка.

В самом простом случае, GtkIconSet содержит один источник pixbuf из которого получает все варианты. Удобная функция для обработки в этом случае gtk_icon_set_new_from_pixbuf(); если вы имеете только один источник pixbuf, просто используйте её.

Если вы хотите использовать разные основы pixbuf для разных вариантов значка, вы создаёте множественные источники значка, отметьте какие варианты они будут использовать для создания и добавьте элементы в набор значка с помощью gtk_icon_set_add_source().

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

gtk_icon_source_set_direction ()

void        gtk_icon_source_set_direction   (GtkIconSource *source,
                                             GtkTextDirection direction);

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

Установка направления текста в источнике значка не делает различия если направление текста универсально. Поэтому, обычно вы должны вызвать gtk_icon_source_set_direction_wildcarded() to un-wildcard it in addition to calling this function.

gtk_icon_source_set_direction_wildcarded ()

void        gtk_icon_source_set_direction_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);

Если направление текста универсально, этот источник может использоваться как основное изображение для значка в любом GtkTextDirection. Если текстовое направление не универсально, то когда направление текста применяемое источником значка должно быть установлено с помощью gtk_icon_source_set_direction(), и источник значка будет использовать только это направление текста.

GtkIconSet предпочитает не универсальные источники (точное соответствие), и будет использовать точное соответствие когда это возможно.

gtk_icon_source_set_filename ()

void        gtk_icon_source_set_filename    (GtkIconSource *source,
                                             const gchar *filename);

Устанавливает имя файла изображения для использования как основы создаваемых вариантов значка для GtkIconSet. Имя файла должно быть обсалютным.

gtk_icon_source_set_pixbuf ()

void        gtk_icon_source_set_pixbuf      (GtkIconSource *source,
                                             GdkPixbuf *pixbuf);

Устанавливает pixbuf используемый как основа изображения, когда создаётся вариант значка для GtkIconSet.

gtk_icon_source_set_icon_name ()

void        gtk_icon_source_set_icon_name   (GtkIconSource *source,
                                             const gchar *icon_name);

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

gtk_icon_source_set_size ()

void        gtk_icon_source_set_size        (GtkIconSource *source,
                                             GtkIconSize size);

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

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

gtk_icon_source_set_size_wildcarded ()

void        gtk_icon_source_set_size_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);

Если размер значка универсален, этот источник может использоваться как основное изображение для значков любого размера. Если размер не универсален, то когда размер применяемый источником должен быть установлен с помощью gtk_icon_source_set_size() и источник значка будет использоваться только с этим определённым размером.

GtkIconSet предпочитает не универсальные источники (точно соответствующие) и будет использовать точное соответствие когда это возможно.

GtkIconSet будет обычно масштабировать универсальные источники изображения, чтобы создать значок необходимого размера, но не будет изменять размер источника изображения.

gtk_icon_source_set_state ()

void        gtk_icon_source_set_state       (GtkIconSource *source,
                                             GtkStateType state);

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

Установка состояния виджета источника значка, не делает ни каких различий если состояние универсально. Поэтому, вы должны обычно вызвать дополнительно gtk_icon_source_set_state_wildcarded() для не универсальных состояний.

gtk_icon_source_set_state_wildcarded ()

void        gtk_icon_source_set_state_wildcarded
                                            (GtkIconSource *source,
                                             gboolean setting);

Если состояние виджета универсально, этот источник может быть использован как основное изображение для значка в любом GtkStateType. Если состояние виджета не универсально, то когда состояние применяемое источником должно быть установлено с помощью gtk_icon_source_set_state() и источник значка будет использоваться только с этим определённым размером.

GtkIconSet предпочитает не универсальные источники (точно соответствующие) и будет использовать точное соответствие когда это возможно.

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

Партнёры:

Хостинг: