| | | GTK+ Reference Manual | |
|---|
Stock Items — Prebuilt common menu/toolbar items and corresponding icons
#include <gtk/gtk.h> struct GtkStockItem; void gtk_stock_add (const GtkStockItem *items, guint n_items); void gtk_stock_add_static (const GtkStockItem *items, guint n_items); GtkStockItem* gtk_stock_item_copy (const GtkStockItem *item); void gtk_stock_item_free (GtkStockItem *item); GSList* gtk_stock_list_ids (void); gboolean gtk_stock_lookup (const gchar *stock_id, GtkStockItem *item); #define GTK_STOCK_ADD #define GTK_STOCK_APPLY #define GTK_STOCK_BOLD #define GTK_STOCK_CANCEL #define GTK_STOCK_CDROM #define GTK_STOCK_CLEAR #define GTK_STOCK_CLOSE #define GTK_STOCK_COLOR_PICKER #define GTK_STOCK_CONVERT #define GTK_STOCK_COPY #define GTK_STOCK_CUT #define GTK_STOCK_DELETE #define GTK_STOCK_DIALOG_ERROR #define GTK_STOCK_DIALOG_INFO #define GTK_STOCK_DIALOG_QUESTION #define GTK_STOCK_DIALOG_WARNING #define GTK_STOCK_DND #define GTK_STOCK_DND_MULTIPLE #define GTK_STOCK_EXECUTE #define GTK_STOCK_FIND #define GTK_STOCK_FIND_AND_REPLACE #define GTK_STOCK_FLOPPY #define GTK_STOCK_GOTO_BOTTOM #define GTK_STOCK_GOTO_FIRST #define GTK_STOCK_GOTO_LAST #define GTK_STOCK_GOTO_TOP #define GTK_STOCK_GO_BACK #define GTK_STOCK_GO_DOWN #define GTK_STOCK_GO_FORWARD #define GTK_STOCK_GO_UP #define GTK_STOCK_HELP #define GTK_STOCK_HOME #define GTK_STOCK_INDEX #define GTK_STOCK_ITALIC #define GTK_STOCK_JUMP_TO #define GTK_STOCK_JUSTIFY_CENTER #define GTK_STOCK_JUSTIFY_FILL #define GTK_STOCK_JUSTIFY_LEFT #define GTK_STOCK_JUSTIFY_RIGHT #define GTK_STOCK_MISSING_IMAGE #define GTK_STOCK_NEW #define GTK_STOCK_NO #define GTK_STOCK_OK #define GTK_STOCK_OPEN #define GTK_STOCK_PASTE #define GTK_STOCK_PREFERENCES #define GTK_STOCK_PRINT #define GTK_STOCK_PRINT_PREVIEW #define GTK_STOCK_PROPERTIES #define GTK_STOCK_QUIT #define GTK_STOCK_REDO #define GTK_STOCK_REFRESH #define GTK_STOCK_REMOVE #define GTK_STOCK_REVERT_TO_SAVED #define GTK_STOCK_SAVE #define GTK_STOCK_SAVE_AS #define GTK_STOCK_SELECT_COLOR #define GTK_STOCK_SELECT_FONT #define GTK_STOCK_SORT_ASCENDING #define GTK_STOCK_SORT_DESCENDING #define GTK_STOCK_SPELL_CHECK #define GTK_STOCK_STOP #define GTK_STOCK_STRIKETHROUGH #define GTK_STOCK_UNDELETE #define GTK_STOCK_UNDERLINE #define GTK_STOCK_UNDO #define GTK_STOCK_YES #define GTK_STOCK_ZOOM_100 #define GTK_STOCK_ZOOM_FIT #define GTK_STOCK_ZOOM_IN #define GTK_STOCK_ZOOM_OUT
Stock items represent commonly-used menu or toolbar items such as "Open" or "Exit". Each stock item is identified by a stock ID; stock IDs are just strings, but macros such as GTK_STOCK_OPEN are provided to avoid typing mistakes in the strings. Applications can register their own stock items in addition to those built-in to GTK+.
Each stock ID can be associated with a GtkStockItem, which contains the user-visible label, keyboard accelerator, and translation domain of the menu or toolbar item; and/or with an icon stored in a GtkIconFactory. See GtkIconFactory for more information on stock icons. The connection between a GtkStockItem and stock icons is purely conventional (by virtue of using the same stock ID); it's possible to register a stock item but no icon, and vice versa.
struct GtkStockItem {
gchar *stock_id;
gchar *label;
GdkModifierType modifier;
guint keyval;
gchar *translation_domain;
};
void gtk_stock_add (const GtkStockItem *items, guint n_items);
Registers each of the stock items in items. If an item already exists with the same stock ID as one of the items, the old item gets replaced. The stock items are copied, so GTK+ does not hold any pointer into items and items can be freed. Use gtk_stock_add_static() if items is persistent and GTK+ need not copy the array.
| items : | a GtkStockItem or array of items |
| n_items : | number of GtkStockItem in items |
void gtk_stock_add_static (const GtkStockItem *items, guint n_items);
Same as gtk_stock_add(), but doesn't copy items, so items must persist until application exit.
| items : | a GtkStockItem or array of GtkStockItem |
| n_items : | number of items |
GtkStockItem* gtk_stock_item_copy (const GtkStockItem *item);
Copies a stock item, mostly useful for language bindings and not in applications.
| item : | a GtkStockItem |
| Returns : | a new GtkStockItem |
void gtk_stock_item_free (GtkStockItem *item);
Frees a stock item allocated on the heap, such as one returned by gtk_stock_item_copy(). Also frees the fields inside the stock item, if they are not NULL.
| item : | a GtkStockItem |
GSList* gtk_stock_list_ids (void);
Retrieves a list of all known stock IDs added to a GtkIconFactory or registered with gtk_stock_add(). The list must be freed with g_slist_free(), and each string in the list must be freed with g_free().
| Returns : | a list of known stock IDs |
gboolean gtk_stock_lookup (const gchar *stock_id, GtkStockItem *item);
Fills item with the registered values for stock_id, returning TRUE if stock_id was known.
| stock_id : | a stock item name |
| item : | stock item to initialize with values |
| Returns : | TRUE if item was initialized |
#define GTK_STOCK_COLOR_PICKER "gtk-color-picker"
The "Color Picker" item.
Since 2.2
#define GTK_STOCK_DIALOG_QUESTION "gtk-dialog-question"
The "Question" item.
#define GTK_STOCK_DND_MULTIPLE "gtk-dnd-multiple"
The "Drag-And-Drop multiple" icon.
#define GTK_STOCK_FIND_AND_REPLACE "gtk-find-and-replace"
The "Find and Replace" item.
#define GTK_STOCK_MISSING_IMAGE "gtk-missing-image"
The "Missing image" icon.
#define GTK_STOCK_PRINT_PREVIEW "gtk-print-preview"
The "Print Preview" item.
#define GTK_STOCK_SORT_DESCENDING "gtk-sort-descending"
The "Descending" item.
#define GTK_STOCK_STRIKETHROUGH "gtk-strikethrough"
The "Strikethrough" item.
| << Drag and Drop | Themeable Stock Images >> |
