gtkaction

			gtk+ reference manual
top \| description \| object hierarchy \| properties \| signals

gtkaction — действия которые могут быть выполнены пунктами меню или панели инструментов.

краткое описание

#include <gtk/gtk.h>


            gtkaction;
gtkaction*  gtk_action_new                  (const gchar *name,
                                             const gchar *label,
                                             const gchar *tooltip,
                                             const gchar *stock_id);
const gchar* gtk_action_get_name            (gtkaction *action);
gboolean    gtk_action_is_sensitive         (gtkaction *action);
gboolean    gtk_action_get_sensitive        (gtkaction *action);
void        gtk_action_set_sensitive        (gtkaction *action,
                                             gboolean sensitive);
gboolean    gtk_action_is_visible           (gtkaction *action);
gboolean    gtk_action_get_visible          (gtkaction *action);
void        gtk_action_set_visible          (gtkaction *action,
                                             gboolean visible);
void        gtk_action_activate             (gtkaction *action);
gtkwidget*  gtk_action_create_icon          (gtkaction *action,
                                             gtkiconsize icon_size);
gtkwidget*  gtk_action_create_menu_item     (gtkaction *action);
gtkwidget*  gtk_action_create_tool_item     (gtkaction *action);
void        gtk_action_connect_proxy        (gtkaction *action,
                                             gtkwidget *proxy);
void        gtk_action_disconnect_proxy     (gtkaction *action,
                                             gtkwidget *proxy);
gslist*     gtk_action_get_proxies          (gtkaction *action);
void        gtk_action_connect_accelerator  (gtkaction *action);
void        gtk_action_disconnect_accelerator
                                            (gtkaction *action);
void        gtk_action_block_activate_from  (gtkaction *action,
                                             gtkwidget *proxy);
void        gtk_action_unblock_activate_from
                                            (gtkaction *action,
                                             gtkwidget *proxy);
const gchar* gtk_action_get_accel_path      (gtkaction *action);
void        gtk_action_set_accel_path       (gtkaction *action,
                                             const gchar *accel_path);
gclosure*   gtk_action_get_accel_closure    (gtkaction *action);
void        gtk_action_set_accel_group      (gtkaction *action,
                                             gtkaccelgroup *accel_group);

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

  gobject
   +----gtkaction
         +----gtktoggleaction

свойства

  "action-group"         gtkactiongroup        : read / write
  "hide-if-empty"        gboolean              : read / write
  "is-important"         gboolean              : read / write
  "label"                gchararray            : read / write
  "name"                 gchararray            : read / write / construct only
  "sensitive"            gboolean              : read / write
  "short-label"          gchararray            : read / write
  "stock-id"             gchararray            : read / write
  "tooltip"              gchararray            : read / write
  "visible"              gboolean              : read / write
  "visible-horizontal"   gboolean              : read / write
  "visible-overflown"    gboolean              : read / write
  "visible-vertical"     gboolean              : read / write

сигналы

"activate"  void        user_function      (gtkaction *action,
                                            gpointer   user_data)      : run first / no recursion

описание

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

так же как callback-функция которая вызывается когда действие активировано, нижеследующее тоже связано с действием:

имя (не переводится, для поиска пути)
ярлык (переводится, для отображения)
акселератор
указывает ли ярлык заготовленный id
подсказка (опционально, переводится)
ярлык панели инструментов (опционально, короче ярлыка)

действие также имеет некоторую информацию о состоянии:

видимость (показать/скрыть)
чувствительность (включено/выключено)

кроме обычных действий, есть toggle actions, которые могут переключаться между двумя состояниями и radio actions, когда только одно действие из группы может быть в состоянии "active". другие действия могут осуществляеться как подкласс gtkaction.

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

детали

gtkaction

typedef struct _gtkaction gtkaction;

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

gtk_action_new ()

gtkaction*  gtk_action_new                  (const gchar *name,
                                             const gchar *label,
                                             const gchar *tooltip,
                                             const gchar *stock_id);

создаёт новый объект gtkaction. для добавления действия к gtkactiongroup и установки акселератора для действия, вызовите gtk_action_group_add_action_with_accel(). смотрите the section called “ui definitions” для информации о доступных именах действий.

`name` :	уникальное имя для действия
`label` :	ярлык отображаемый в пунктах меню и на кнопках
`tooltip` :	подсказка для действия
`stock_id` :	заготовленный значок для отображения в виджетах представляющих действие
возвращает:	новый gtkaction

начиная с версии 2.4

gtk_action_get_name ()

const gchar* gtk_action_get_name            (gtkaction *action);

возвращает имя действия.

`action` :	объект действия
возвращает:	имя действия. строкой владеет gtk+ поэтому не нужно её освобождать.

начиная с версии 2.4

gtk_action_is_sensitive ()

gboolean    gtk_action_is_sensitive         (gtkaction *action);

возвращает фактическую чувствительность действия.

`action` :	объект действия
возвращает:	`true` если действие и ассоциированная с ним группа действий являются чувствительными.

начиная с версии 2.4

gtk_action_get_sensitive ()

gboolean    gtk_action_get_sensitive        (gtkaction *action);

возвращает чувствительно ли само действие. помните это не означает фактическую чувствительность. смотрите gtk_action_is_sensitive().

`action` :	объект действия
возвращает:	`true` если само действие чувствительно.

начиная с версии 2.4

gtk_action_set_sensitive ()

void        gtk_action_set_sensitive        (gtkaction *action,
                                             gboolean sensitive);

устанавливает ::sensitive свойство для действия в значение sensitive. помните это не означает фактическую чувствительность. смотрите gtk_action_is_sensitive().

`action` :	объект действия
`sensitive` :	`true` чтобы действие стало чувствительным

начиная с версии 2.6

gtk_action_is_visible ()

gboolean    gtk_action_is_visible           (gtkaction *action);

возвращает фактическую видимость действия.

`action` :	объект действия
возвращает:	`true` если действие и ассоциированная с ним группа действий видимы.

начиная с версии 2.4

gtk_action_get_visible ()

gboolean    gtk_action_get_visible          (gtkaction *action);

возвращает видимо ли само действие. помните это не означает фактическую видимость. смотрите gtk_action_is_sensitive().

`action` :	объект действия
возвращает:	`true` если само действие видимо.

начиная с версии 2.4

gtk_action_set_visible ()

void        gtk_action_set_visible          (gtkaction *action,
                                             gboolean visible);

устанавливает ::visible свойство действия в visible. помните это не означает фактическую видимость. смотрите gtk_action_is_visible().

`action` :	объект действия
`visible` :	`true` делает действие видимым

начиная с версии 2.6

gtk_action_activate ()

void        gtk_action_activate             (gtkaction *action);

издаёт сигнал "activate" на определенном действии, если оно чувствительно. эту функцию вызывают полномочные виджеты при активации.

эта функция также может использоваться для самостоятельной активации действия.

action :

объект действия

начиная с версии 2.4

gtk_action_create_icon ()

gtkwidget*  gtk_action_create_icon          (gtkaction *action,
                                             gtkiconsize icon_size);

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

`action` :	объект действия
`icon_size` :	размер создаваемого значка.
возвращает:	виджет отображающий значок для этого действия.

начиная с версии 2.4

gtk_action_create_menu_item ()

gtkwidget*  gtk_action_create_menu_item     (gtkaction *action);

создаёт полномочные виджеты пунктов меню для данного действия.

`action` :	объект действия
возвращает:	пункт меню подключаемый к действию.

начиная с версии 2.4

gtk_action_create_tool_item ()

gtkwidget*  gtk_action_create_tool_item     (gtkaction *action);

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

`action` :	объект действия
возвращает:	пункт панели инструментов подключаемый к данному действию.

начиная с версии 2.4

gtk_action_connect_proxy ()

void        gtk_action_connect_proxy        (gtkaction *action,
                                             gtkwidget *proxy);

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

если виджет уже подключен к действию, эта функция сначала отключает его.

`action` :	объект действия
`proxy` :	полномочный виджет

начиная с версии 2.4

gtk_action_disconnect_proxy ()

void        gtk_action_disconnect_proxy     (gtkaction *action,
                                             gtkwidget *proxy);

отключает уполномоченный виджет от действия. но не разрушает виджет.

`action` :	объект действия
`proxy` :	полномочный виджет

начиная с версии 2.4

gtk_action_get_proxies ()

gslist*     gtk_action_get_proxies          (gtkaction *action);

возвращает уполномоченные виджеты для действия.

`action` :	объект действия
возвращает:	gslist уполномоченных виджетов. списком владеет действие и его не нужно освобождать.

начиная с версии 2.4

gtk_action_connect_accelerator ()

void        gtk_action_connect_accelerator  (gtkaction *action);

устанавливает акселератор для action если action имеет путь акселератора и группу. смотрите gtk_action_set_accel_path() и gtk_action_set_accel_group()

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

action :

gtkaction

начиная с версии 2.4

gtk_action_disconnect_accelerator ()

void        gtk_action_disconnect_accelerator
                                            (gtkaction *action);

уничтожает эффект от вызова gtk_action_connect_accelerator().

action :

gtkaction

начиная с версии 2.4

gtk_action_block_activate_from ()

void        gtk_action_block_activate_from  (gtkaction *action,
                                             gtkwidget *proxy);

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

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

`action` :	объект действия
`proxy` :	уполномоченный виджет

начиная с версии 2.4

gtk_action_unblock_activate_from ()

void        gtk_action_unblock_activate_from
                                            (gtkaction *action,
                                             gtkwidget *proxy);

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

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

`action` :	объект действия
`proxy` :	уполномоченный виджет

начиная с версии 2.4

gtk_action_get_accel_path ()

const gchar* gtk_action_get_accel_path      (gtkaction *action);

возвращает путь акселератора для этого действия.

`action` :	объект действия
возвращает:	путь акселератора для этого действия, или `null` если не установлено. возвращенной строкой владеет gtk+ и она не должна освобождаться.

начиная с версии 2.6

gtk_action_set_accel_path ()

void        gtk_action_set_accel_path       (gtkaction *action,
                                             const gchar *accel_path);

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

`action` :	объект действия
`accel_path` :	путь акселератора

начиная с версии 2.4

gtk_action_get_accel_closure ()

gclosure*   gtk_action_get_accel_closure    (gtkaction *action);

возвращает завершённый акселератор для этого действия.

`action` :	объект действия
возвращает:	завершённый акселератор для этого действия. результатом владеет gtk+ и он не должен освобождаться.

начиная с версии 2.8

gtk_action_set_accel_group ()

void        gtk_action_set_accel_group      (gtkaction *action,
                                             gtkaccelgroup *accel_group);

устанавливает gtkaccelgroup в которую будет установлен акселератор для определённого действия.

`action` :	объект действия
`accel_group` :	gtkaccelgroup или `null`

начиная с версии 2.4

детали свойств

свойство "`action-group`"

  "action-group"         gtkactiongroup        : read / write

gtkactiongroup с которым связан этот gtkaction, или null (для внутреннего использования).

свойство "`hide-if-empty`"

  "hide-if-empty"        gboolean              : read / write

если true, пустое меню уполномоченное для этого действия будет скрыто.

значение по умолчанию: true

свойство "`is-important`"

  "is-important"         gboolean              : read / write

считается ли действие важным. если true, инструментальный пункт уполномоченный для этого действия показывает текст в режиме gtk_toolbar_both_horiz.

значение по умолчанию: false

свойство "`label`"

  "label"                gchararray            : read / write

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

значение по умолчанию: null

свойство "`name`"

  "name"                 gchararray            : read / write / construct only

уникальное имя для действия.

значение по умолчанию: null

свойство "`sensitive`"

  "sensitive"            gboolean              : read / write

чувствительность действия.

значение по умолчанию: true

свойство "`short-label`"

  "short-label"          gchararray            : read / write

короткий ярлык который может использоваться на кнопках инструментальной панели.

значение по умолчанию: null

свойство "`stock-id`"

  "stock-id"             gchararray            : read / write

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

значение по умолчанию: null

свойство "`tooltip`"

  "tooltip"              gchararray            : read / write

подсказка для данного действия.

значение по умолчанию: null

свойство "`visible`"

  "visible"              gboolean              : read / write

режим видимости действия.

значение по умолчанию: true

свойство "`visible-horizontal`"

  "visible-horizontal"   gboolean              : read / write

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

значение по умолчанию: true

свойство "`visible-overflown`"

  "visible-overflown"    gboolean              : read / write

когда true, уполномоченные инструментальные пункты (toolitem) для данного действия представлены в меню переполнения данной панели инструментов.

значение по умолчанию: true

начиная с версии 2.6

свойство "`visible-vertical`"

  "visible-vertical"     gboolean              : read / write

видимы ли пункты панели инструментов при вертикальной ориентации.

значение по умолчанию: true

детали сигналов

сигнал "activate"

void        user_function                  (gtkaction *action,
                                            gpointer   user_data)      : run first / no recursion

сигнал "activate" издаётся когда активируется действие.

`action` :	gtkaction
`user_data` :	пользовательские данные устанавливаемые при подключении обработчика сигнала.

начиная с версии 2.4

смотрите также

gtkactiongroup, gtkuimanager

gtkaction

краткое описание

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

свойства

сигналы

описание

детали

gtkaction

gtk_action_new ()

gtk_action_get_name ()

gtk_action_is_sensitive ()

gtk_action_get_sensitive ()

gtk_action_set_sensitive ()

gtk_action_is_visible ()

gtk_action_get_visible ()

gtk_action_set_visible ()

gtk_action_activate ()

gtk_action_create_icon ()

gtk_action_create_menu_item ()

gtk_action_create_tool_item ()

gtk_action_connect_proxy ()

gtk_action_disconnect_proxy ()

gtk_action_get_proxies ()

gtk_action_connect_accelerator ()

gtk_action_disconnect_accelerator ()

gtk_action_block_activate_from ()

gtk_action_unblock_activate_from ()

gtk_action_get_accel_path ()

gtk_action_set_accel_path ()

gtk_action_get_accel_closure ()

gtk_action_set_accel_group ()

детали свойств

свойство "action-group"

свойство "hide-if-empty"

свойство "is-important"

свойство "label"

свойство "name"

свойство "sensitive"

свойство "short-label"

свойство "stock-id"

свойство "tooltip"

свойство "visible"

свойство "visible-horizontal"

свойство "visible-overflown"

свойство "visible-vertical"

детали сигналов

сигнал "activate"

смотрите также

свойство "`action-group`"

свойство "`hide-if-empty`"

свойство "`is-important`"

свойство "`label`"

свойство "`name`"

свойство "`sensitive`"

свойство "`short-label`"

свойство "`stock-id`"

свойство "`tooltip`"

свойство "`visible`"

свойство "`visible-horizontal`"

свойство "`visible-overflown`"

свойство "`visible-vertical`"