GtkItemFactory

typedef struct _GtkItemFactory GtkItemFactory;

GtkPrintFunc ()

void                (*GtkPrintFunc)                     (gpointer func_data,
                                                         const gchar *str);

GtkTranslateFunc ()

gchar *             (*GtkTranslateFunc)                 (const gchar *path,
                                                         gpointer func_data);

The function used to translate messages in e.g. GtkIconFactory and GtkActionGroup.

GtkItemFactoryCallback ()

void                (*GtkItemFactoryCallback)           ();

GtkItemFactoryCallback1 ()

void                (*GtkItemFactoryCallback1)          (gpointer callback_data,
                                                         guint callback_action,
                                                         GtkWidget *widget);

GtkItemFactoryCallback2 ()

void                (*GtkItemFactoryCallback2)          (GtkWidget *widget,
                                                         gpointer callback_data,
                                                         guint callback_action);

GtkItemFactoryEntry

typedef struct {
  gchar *path;
  gchar *accelerator;

  GtkItemFactoryCallback callback;
  guint			 callback_action;

  /* possible values:
   * NULL		-> "<Item>"
   * ""			-> "<Item>"
   * "<Title>"		-> create a title item
   * "<Item>"		-> create a simple item
   * "<ImageItem>" -> create an item holding an image
   * "<StockItem>" -> create an item holding a stock image
   * "<CheckItem>" -> create a check item
   * "<ToggleItem>" -> create a toggle item
   * "<RadioItem>" -> create a radio item
   * <path>		-> path of a radio item to link against
   * "<Separator>" -> create a separator
   * "<Tearoff>" -> create a tearoff separator
   * "<Branch>"		-> create an item to hold sub items
   * "<LastBranch>" -> create a right justified item to hold sub items
   */
  gchar		 *item_type;

  /* Extra data for some item types:
   *  ImageItem  -> pointer to inlined pixbuf stream
   *  StockItem  -> name of stock item
   */
  gconstpointer extra_data;
} GtkItemFactoryEntry;

GtkItemFactoryItem

typedef struct {
  gchar *path;
  GSList *widgets;
} GtkItemFactoryItem;

gtk_item_factory_new ()

GtkItemFactory*     gtk_item_factory_new                (GType container_type,
                                                         const gchar *path,
                                                         GtkAccelGroup *accel_group);

Creates a new GtkItemFactory.

Beware that the returned object does not have a floating reference.

gtk_item_factory_construct ()

void                gtk_item_factory_construct          (GtkItemFactory *ifactory,
                                                         GType container_type,
                                                         const gchar *path,
                                                         GtkAccelGroup *accel_group);

Initializes an item factory.

gtk_item_factory_add_foreign ()

void                gtk_item_factory_add_foreign        (GtkWidget *accel_widget,
                                                         const gchar *full_path,
                                                         GtkAccelGroup *accel_group,
                                                         guint keyval,
                                                         GdkModifierType modifiers);

Installs an accelerator for accel_widget in accel_group, that causes the ::activate signal to be emitted if the accelerator is activated.

This function can be used to make widgets participate in the accel saving/restoring functionality provided by gtk_accel_map_save() and gtk_accel_map_load(), even if they haven't been created by an item factory.

gtk_item_factory_from_widget ()

GtkItemFactory*     gtk_item_factory_from_widget        (GtkWidget *widget);

Obtains the item factory from which a widget was created.

gtk_item_factory_path_from_widget ()

const gchar*        gtk_item_factory_path_from_widget   (GtkWidget *widget);

If widget has been created by an item factory, returns the full path to it. (The full path of a widget is the concatenation of the factory path specified in gtk_item_factory_new() with the path specified in the GtkItemFactoryEntry from which the widget was created.)

gtk_item_factory_get_item ()

GtkWidget*          gtk_item_factory_get_item           (GtkItemFactory *ifactory,
                                                         const gchar *path);

Obtains the menu item which corresponds to path.

If the widget corresponding to path is a menu item which opens a submenu, then the item is returned. If you are interested in the submenu, use gtk_item_factory_get_widget() instead.

gtk_item_factory_get_widget ()

GtkWidget*          gtk_item_factory_get_widget         (GtkItemFactory *ifactory,
                                                         const gchar *path);

Obtains the widget which corresponds to path.

If the widget corresponding to path is a menu item which opens a submenu, then the submenu is returned. If you are interested in the menu item, use gtk_item_factory_get_item() instead.

gtk_item_factory_get_widget_by_action ()

GtkWidget*          gtk_item_factory_get_widget_by_action
                                                        (GtkItemFactory *ifactory,
                                                         guint action);

Obtains the widget which was constructed from the GtkItemFactoryEntry with the given action.

If there are multiple items with the same action, the result is undefined.

gtk_item_factory_get_item_by_action ()

GtkWidget*          gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
                                                         guint action);

Obtains the menu item which was constructed from the first GtkItemFactoryEntry with the given action.

gtk_item_factory_create_item ()

void                gtk_item_factory_create_item        (GtkItemFactory *ifactory,
                                                         GtkItemFactoryEntry *entry,
                                                         gpointer callback_data,
                                                         guint callback_type);

Creates an item for entry.

gtk_item_factory_create_items ()

void                gtk_item_factory_create_items       (GtkItemFactory *ifactory,
                                                         guint n_entries,
                                                         GtkItemFactoryEntry *entries,
                                                         gpointer callback_data);

Creates the menu items from the entries.

gtk_item_factory_create_items_ac ()

void                gtk_item_factory_create_items_ac    (GtkItemFactory *ifactory,
                                                         guint n_entries,
                                                         GtkItemFactoryEntry *entries,
                                                         gpointer callback_data,
                                                         guint callback_type);

Creates the menu items from the entries.

gtk_item_factory_delete_item ()

void                gtk_item_factory_delete_item        (GtkItemFactory *ifactory,
                                                         const gchar *path);

Deletes the menu item which was created for path by the given item factory.

gtk_item_factory_delete_entry ()

void                gtk_item_factory_delete_entry       (GtkItemFactory *ifactory,
                                                         GtkItemFactoryEntry *entry);

Deletes the menu item which was created from entry by the given item factory.

gtk_item_factory_delete_entries ()

void                gtk_item_factory_delete_entries     (GtkItemFactory *ifactory,
                                                         guint n_entries,
                                                         GtkItemFactoryEntry *entries);

Deletes the menu items which were created from the entries by the given item factory.

gtk_item_factory_popup ()

void                gtk_item_factory_popup              (GtkItemFactory *ifactory,
                                                         guint x,
                                                         guint y,
                                                         guint mouse_button,
                                                         guint32 time_);

Pops up the menu constructed from the item factory at (x, y).

The mouse_button parameter should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, mouse_button should be 0.

The time_ parameter should be the time stamp of the event that initiated the popup. If such an event is not available, use gtk_get_current_event_time() instead.

The operation of the mouse_button and the time_ parameter is the same as the button and activation_time parameters for gtk_menu_popup().

gtk_item_factory_popup_with_data ()

void                gtk_item_factory_popup_with_data    (GtkItemFactory *ifactory,
                                                         gpointer popup_data,
                                                         GDestroyNotify destroy,
                                                         guint x,
                                                         guint y,
                                                         guint mouse_button,
                                                         guint32 time_);

Pops up the menu constructed from the item factory at (x, y). Callbacks can access the popup_data while the menu is posted via gtk_item_factory_popup_data() and gtk_item_factory_popup_data_from_widget().

The mouse_button parameter should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, mouse_button should be 0.

The time_ parameter should be the time stamp of the event that initiated the popup. If such an event is not available, use gtk_get_current_event_time() instead.

The operation of the mouse_button and the time_ parameters is the same as the button and activation_time parameters for gtk_menu_popup().

gtk_item_factory_popup_data ()

gpointer            gtk_item_factory_popup_data         (GtkItemFactory *ifactory);

Obtains the popup_data which was passed to gtk_item_factory_popup_with_data(). This data is available until the menu is popped down again.

gtk_item_factory_popup_data_from_widget ()

gpointer            gtk_item_factory_popup_data_from_widget
                                                        (GtkWidget *widget);

Obtains the popup_data which was passed to gtk_item_factory_popup_with_data(). This data is available until the menu is popped down again.

gtk_item_factory_from_path ()

GtkItemFactory*     gtk_item_factory_from_path          (const gchar *path);

Finds an item factory which has been constructed using the "<name>" prefix of path as the path argument for gtk_item_factory_new().

gtk_item_factory_create_menu_entries ()

void                gtk_item_factory_create_menu_entries
                                                        (guint n_entries,
                                                         GtkMenuEntry *entries);

Creates the menu items from the entries.

gtk_item_factories_path_delete ()

void                gtk_item_factories_path_delete      (const gchar *ifactory_path,
                                                         const gchar *path);

Deletes all widgets constructed from the specified path.

gtk_item_factory_set_translate_func ()

void                gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
                                                         GtkTranslateFunc func,
                                                         gpointer data,
                                                         GDestroyNotify notify);

Sets a function to be used for translating the path elements before they are displayed.