<!-- ##### SECTION Title ##### --> GnomeStock <!-- ##### SECTION Short_Description ##### --> 50% finished, API-docs not done; Default icons for toolbars, menus and buttons. <!-- ##### SECTION Long_Description ##### --> <para> These functions provide an applications programmer with default icons for toolbars, menu pixmaps and buttons. </para> <para> To support themability, we use (char *) to call those functions. A new theme might register new icons by calling gnome_stock_pixmap_register(), or may change existing icons by calling gnome_stock_pixmap_change(). An application should check (by calling gnome_stock_pixmap_checkfor)(), if the current theme supports an uncommon icon, before using it. The only icons an app can rely on, are those defined in this header file. </para> <para> We have stock buttons too. To use them, use the gnome_stock_button() function with a GNOME_STOCK constant. This function returns a #GtkButton with a gettexted default text and an icon. </para> <para> There is an additional feature, which might be interesting. If an application calls gnome_stock_pixmap_register() and uses it by calling gnome_stock_pixmap_widget(), it doesn't have to care about the state_changed signal to display the appropriate pixmap itself. Additionally gnome-stock generates a disabled version of a pixmap automatically, when no pixmap for a disabled state is provided. </para> <refsect2> <title>GNOME_STOCK icons internals</title> <para> One such `icon' should have at least three pixmaps to reflect its state. There is a `regular' pixmap, a `disabled' pixmap and a `focused' pixmap. You can get either each of these pixmaps by calling gnome_stock_pixmap or you can get a widget by calling gnome_stock_pixmap_widget. This widget is a container which gtk_widget_shows the pixmap, that is reflecting the current state of the widget. If for example you gtk_container_add this widget to a button, which is currently not sensitive, the widget will just show the `disabled' pixmap. If the state of the button changes to sensitive, the widget will change to the `regular' pixmap. The `focused' pixmap will be shown, when the mouse pointer enters the widget. </para> </refsect2> <!-- ##### SECTION See_Also ##### --> <para> #GtkButton, #GnomePixmap </para> <!-- ##### STRUCT GnomeStock ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_NEW ##### --> <para> Image for representing "New". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_OPEN ##### --> <para> Image for representing "Open". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_CLOSE ##### --> <para> Image for representing "Close". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_REVERT ##### --> <para> Image for representing "Revert". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SAVE ##### --> <para> Image for representing "Save". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SAVE_AS ##### --> <para> Image for representing "Save as". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_CUT ##### --> <para> Image for representing "Cut". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_COPY ##### --> <para> Image for representing "Copy". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_PASTE ##### --> <para> Image for representing "Paste". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_CLEAR ##### --> <para> Image for representing "Clear". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_PROPERTIES ##### --> <para> Image for representing "Properties". Please note the difference between "Properties" and "Preferences". "Properties" should be used when editing the properties of a specific object, such as a file or a database. "Preferences" should be used when editing user preferences application-wide, such as display colors or default servers. </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_PREFERENCES ##### --> <para> Image for representing "Preferences". Please see note for "Properties" above. </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_HELP ##### --> <para> Image for representing "Help". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SCORES ##### --> <para> Image for representing "Scores". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_PRINT ##### --> <para> Image for representing "Print". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SEARCH ##### --> <para> Image for representing "Search". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SRCHRPL ##### --> <para> Image for representing "Search and replace". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BACK ##### --> <para> Image for representing "Back". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_FORWARD ##### --> <para> Image for representing "Forward". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_FIRST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_LAST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_HOME ##### --> <para> Image for representing "Home". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_STOP ##### --> <para> Image for representing "Stop". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_REFRESH ##### --> <para> Image for representing "Refresh". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_UNDO ##### --> <para> Image for representing "Undo". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_REDO ##### --> <para> Image for representing "Redo". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TIMER ##### --> <para> Image for representing "Timer". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TIMER_STOP ##### --> <para> Image for representing "Timer stop". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL ##### --> <para> Image for representing "Mail". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL_RCV ##### --> <para> Image for representing "Mail get". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL_SND ##### --> <para> Image for representing "Mail send". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL_RPL ##### --> <para> Image for representing "Mail reply". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL_FWD ##### --> <para> Image for representing "Timer". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MAIL_NEW ##### --> <para> Image for representing "Mail new". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TRASH ##### --> <para> Image for representing "Trashcan". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TRASH_FULL ##### --> <para> Image for representing "Trashcan is full". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_UNDELETE ##### --> <para> Image for representing "Undelete". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_SPELLCHECK ##### --> <para> Image for representing "Spellcheck". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MIC ##### --> <para> Image for representing "Microphone". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_LINE_IN ##### --> <para> Image for representing "Line in". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_CDROM ##### --> <para> Image for representing "CD-ROM". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_VOLUME ##### --> <para> Image for representing "Volume". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOOK_RED ##### --> <para> Image for representing "A red book". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOOK_GREEN ##### --> <para> Image for representing "A green book". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOOK_BLUE ##### --> <para> Image for representing "A blue book". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOOK_YELLOW ##### --> <para> Image for representing "A yellow book". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOOK_OPEN ##### --> <para> Image for representing "An open book". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ABOUT ##### --> <para> Image for representing "About". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_QUIT ##### --> <para> Image for representing "Quit". </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_MULTIPLE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_NOT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_CONVERT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_JUMP_TO ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_UP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_DOWN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TOP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_BOTTOM ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ATTACH ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_INDEX ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_FONT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_EXEC ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ALIGN_LEFT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ALIGN_RIGHT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ALIGN_CENTER ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_BOLD ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_ITALIC ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_UNDERLINE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_INDENT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_UNINDENT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_EXIT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_COLORSELECTOR ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_ADD ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_REMOVE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TABLE_BORDERS ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TABLE_FILL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_REGULAR ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_DISABLED ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_PIXMAP_FOCUSED ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryAny ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryData ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryFile ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryPath ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryWidget ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryGPixmap ##### --> <para> </para> <!-- ##### ENUM GnomeStockPixmapType ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryImlib ##### --> <para> </para> <!-- ##### STRUCT GnomeStockPixmapEntryImlibScaled ##### --> <para> </para> <!-- ##### UNION GnomeStockPixmapEntry ##### --> <para> </para> <!-- ##### FUNCTION gnome_stock_new ##### --> <para> </para> @Returns: <!-- ##### FUNCTION gnome_stock_new_with_icon ##### --> <para> </para> @icon: @Returns: <!-- ##### FUNCTION gnome_stock_set_icon ##### --> <para> </para> @stock: @icon: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap ##### --> <para> </para> @window: @icon: @subtype: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_widget ##### --> <para> </para> @window: @icon: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_widget_at_size ##### --> <para> </para> @window: @icon: @width: @height: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_widget_set_icon ##### --> <para> </para> @widget: @icon: <!-- ##### FUNCTION gnome_stock_pixmap_register ##### --> <para> </para> @icon: @subtype: @entry: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_change ##### --> <para> </para> @icon: @subtype: @entry: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_checkfor ##### --> <para> </para> @icon: @subtype: @Returns: <!-- ##### FUNCTION gnome_pixmap_button ##### --> <para> </para> @pixmap: @text: @Returns: <!-- ##### FUNCTION gnome_button_can_default ##### --> <para> </para> @button: @can_default: <!-- ##### MACRO GNOME_STOCK_BUTTON_OK ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_CANCEL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_YES ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_NO ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_CLOSE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_APPLY ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_HELP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_NEXT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_PREV ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_UP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_DOWN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_BUTTON_FONT ##### --> <para> </para> <!-- ##### FUNCTION gnome_stock_button ##### --> <para> </para> @type: @Returns: <!-- ##### FUNCTION gnome_stock_or_ordinary_button ##### --> <para> </para> @type: @Returns: <!-- ##### MACRO GNOME_STOCK_MENU_BLANK ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_NEW ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SAVE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SAVE_AS ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_REVERT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_OPEN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_CLOSE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_QUIT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_CUT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_COPY ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_PASTE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_PROP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_PREF ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ABOUT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SCORES ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_UNDO ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_REDO ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_PRINT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SEARCH ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SRCHRPL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BACK ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_FORWARD ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_FIRST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_LAST ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_HOME ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_STOP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_REFRESH ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL_RCV ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL_SND ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL_RPL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL_FWD ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MAIL_NEW ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TRASH ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TRASH_FULL ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_UNDELETE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TIMER ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TIMER_STOP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_SPELLCHECK ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_MIC ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_LINE_IN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_CDROM ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_VOLUME ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOOK_RED ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOOK_GREEN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOOK_BLUE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOOK_YELLOW ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOOK_OPEN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_CONVERT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_JUMP_TO ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_UP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_DOWN ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TOP ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_BOTTOM ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ATTACH ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_INDEX ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_FONT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_EXEC ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ALIGN_LEFT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ALIGN_RIGHT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ALIGN_CENTER ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_ALIGN_JUSTIFY ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TEXT_BOLD ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TEXT_ITALIC ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TEXT_UNDERLINE ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_TEXT_STRIKEOUT ##### --> <para> </para> <!-- ##### MACRO GNOME_STOCK_MENU_EXIT ##### --> <para> </para> <!-- ##### FUNCTION gnome_stock_menu_item ##### --> <para> </para> @type: @text: @Returns: <!-- ##### FUNCTION gnome_stock_menu_accel ##### --> <para> </para> @type: @key: @mod: @Returns: <!-- ##### FUNCTION gnome_stock_menu_accel_parse ##### --> <para> </para> @section: <!-- ##### FUNCTION gnome_stock_transparent_window ##### --> <para> </para> @icon: @subtype: @Returns: <!-- ##### FUNCTION gnome_stock_pixmap_gdk ##### --> <para> </para> @icon: @subtype: @pixmap: @mask: <!-- Local variables: mode: sgml sgml-parent-document: ("../gnomeui-docs.sgml" "book" "sect1" "") End: -->