Gnome User Interface Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GnomeStock

## Name

GnomeStock -- 50% finished, API-docs not done; Default icons for toolbars, menus and buttons.

## Synopsis

    #include <gnome.h>

    struct      GnomeStock;
    #define     GNOME_STOCK_PIXMAP_NEW
    #define     GNOME_STOCK_PIXMAP_OPEN
    #define     GNOME_STOCK_PIXMAP_CLOSE
    #define     GNOME_STOCK_PIXMAP_REVERT
    #define     GNOME_STOCK_PIXMAP_SAVE
    #define     GNOME_STOCK_PIXMAP_SAVE_AS
    #define     GNOME_STOCK_PIXMAP_CUT
    #define     GNOME_STOCK_PIXMAP_COPY
    #define     GNOME_STOCK_PIXMAP_PASTE
    #define     GNOME_STOCK_PIXMAP_CLEAR
    #define     GNOME_STOCK_PIXMAP_PROPERTIES
    #define     GNOME_STOCK_PIXMAP_PREFERENCES
    #define     GNOME_STOCK_PIXMAP_HELP
    #define     GNOME_STOCK_PIXMAP_SCORES
    #define     GNOME_STOCK_PIXMAP_PRINT
    #define     GNOME_STOCK_PIXMAP_SEARCH
    #define     GNOME_STOCK_PIXMAP_SRCHRPL
    #define     GNOME_STOCK_PIXMAP_BACK
    #define     GNOME_STOCK_PIXMAP_FORWARD
    #define     GNOME_STOCK_PIXMAP_FIRST
    #define     GNOME_STOCK_PIXMAP_LAST
    #define     GNOME_STOCK_PIXMAP_HOME
    #define     GNOME_STOCK_PIXMAP_STOP
    #define     GNOME_STOCK_PIXMAP_REFRESH
    #define     GNOME_STOCK_PIXMAP_UNDO
    #define     GNOME_STOCK_PIXMAP_REDO
    #define     GNOME_STOCK_PIXMAP_TIMER
    #define     GNOME_STOCK_PIXMAP_TIMER_STOP
    #define     GNOME_STOCK_PIXMAP_MAIL
    #define     GNOME_STOCK_PIXMAP_MAIL_RCV
    #define     GNOME_STOCK_PIXMAP_MAIL_SND
    #define     GNOME_STOCK_PIXMAP_MAIL_RPL
    #define     GNOME_STOCK_PIXMAP_MAIL_FWD
    #define     GNOME_STOCK_PIXMAP_MAIL_NEW
    #define     GNOME_STOCK_PIXMAP_TRASH
    #define     GNOME_STOCK_PIXMAP_TRASH_FULL
    #define     GNOME_STOCK_PIXMAP_UNDELETE
    #define     GNOME_STOCK_PIXMAP_SPELLCHECK
    #define     GNOME_STOCK_PIXMAP_MIC
    #define     GNOME_STOCK_PIXMAP_LINE_IN
    #define     GNOME_STOCK_PIXMAP_CDROM
    #define     GNOME_STOCK_PIXMAP_VOLUME
    #define     GNOME_STOCK_PIXMAP_BOOK_RED
    #define     GNOME_STOCK_PIXMAP_BOOK_GREEN
    #define     GNOME_STOCK_PIXMAP_BOOK_BLUE
    #define     GNOME_STOCK_PIXMAP_BOOK_YELLOW
    #define     GNOME_STOCK_PIXMAP_BOOK_OPEN
    #define     GNOME_STOCK_PIXMAP_ABOUT
    #define     GNOME_STOCK_PIXMAP_QUIT
    #define     GNOME_STOCK_PIXMAP_MULTIPLE
    #define     GNOME_STOCK_PIXMAP_NOT
    #define     GNOME_STOCK_PIXMAP_CONVERT
    #define     GNOME_STOCK_PIXMAP_JUMP_TO
    #define     GNOME_STOCK_PIXMAP_UP
    #define     GNOME_STOCK_PIXMAP_DOWN
    #define     GNOME_STOCK_PIXMAP_TOP
    #define     GNOME_STOCK_PIXMAP_BOTTOM
    #define     GNOME_STOCK_PIXMAP_ATTACH
    #define     GNOME_STOCK_PIXMAP_INDEX
    #define     GNOME_STOCK_PIXMAP_FONT
    #define     GNOME_STOCK_PIXMAP_EXEC
    #define     GNOME_STOCK_PIXMAP_ALIGN_LEFT
    #define     GNOME_STOCK_PIXMAP_ALIGN_RIGHT
    #define     GNOME_STOCK_PIXMAP_ALIGN_CENTER
    #define     GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY
    #define     GNOME_STOCK_PIXMAP_TEXT_BOLD
    #define     GNOME_STOCK_PIXMAP_TEXT_ITALIC
    #define     GNOME_STOCK_PIXMAP_TEXT_UNDERLINE
    #define     GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT
    #define     GNOME_STOCK_PIXMAP_TEXT_INDENT
    #define     GNOME_STOCK_PIXMAP_TEXT_UNINDENT
    #define     GNOME_STOCK_PIXMAP_EXIT
    #define     GNOME_STOCK_PIXMAP_COLORSELECTOR
    #define     GNOME_STOCK_PIXMAP_ADD
    #define     GNOME_STOCK_PIXMAP_REMOVE
    #define     GNOME_STOCK_PIXMAP_TABLE_BORDERS
    #define     GNOME_STOCK_PIXMAP_TABLE_FILL
    #define     GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST
    #define     GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST
    #define     GNOME_STOCK_PIXMAP_REGULAR
    #define     GNOME_STOCK_PIXMAP_DISABLED
    #define     GNOME_STOCK_PIXMAP_FOCUSED
    struct      GnomeStockPixmapEntryAny;
    struct      GnomeStockPixmapEntryData;
    struct      GnomeStockPixmapEntryFile;
    struct      GnomeStockPixmapEntryPath;
    struct      GnomeStockPixmapEntryWidget;
    struct      GnomeStockPixmapEntryGPixmap;
    enum        GnomeStockPixmapType;
    struct      GnomeStockPixmapEntryImlib;
    struct      GnomeStockPixmapEntryImlibScaled;
    union       GnomeStockPixmapEntry;
    GtkWidget*  gnome_stock_new                 (void);
    GtkWidget*  gnome_stock_new_with_icon       (const char *icon);
    gboolean    gnome_stock_set_icon            (GnomeStock *stock,
                                                 const char *icon);
    GnomePixmap* gnome_stock_pixmap             (GtkWidget *window,
                                                 const char *icon,
                                                 const char *subtype);
    GtkWidget*  gnome_stock_pixmap_widget       (GtkWidget *window,
                                                 const char *icon);
    GtkWidget*  gnome_stock_pixmap_widget_at_size
                                                (GtkWidget *window,
                                                 const char *icon,
                                                 guint width,
                                                 guint height);
    void        gnome_stock_pixmap_widget_set_icon
                                                (GnomeStock *widget,
                                                 const char *icon);
    gint        gnome_stock_pixmap_register     (const char *icon,
                                                 const char *subtype,
                                                 GnomeStockPixmapEntry *entry);
    gint        gnome_stock_pixmap_change       (const char *icon,
                                                 const char *subtype,
                                                 GnomeStockPixmapEntry *entry);
    GnomeStockPixmapEntry* gnome_stock_pixmap_checkfor
                                                (const char *icon,
                                                 const char *subtype);
    GtkWidget*  gnome_pixmap_button             (GtkWidget *pixmap,
                                                 const char *text);
    void        gnome_button_can_default        (GtkButton *button,
                                                 gboolean can_default);
    #define     GNOME_STOCK_BUTTON_OK
    #define     GNOME_STOCK_BUTTON_CANCEL
    #define     GNOME_STOCK_BUTTON_YES
    #define     GNOME_STOCK_BUTTON_NO
    #define     GNOME_STOCK_BUTTON_CLOSE
    #define     GNOME_STOCK_BUTTON_APPLY
    #define     GNOME_STOCK_BUTTON_HELP
    #define     GNOME_STOCK_BUTTON_NEXT
    #define     GNOME_STOCK_BUTTON_PREV
    #define     GNOME_STOCK_BUTTON_UP
    #define     GNOME_STOCK_BUTTON_DOWN
    #define     GNOME_STOCK_BUTTON_FONT
    GtkWidget*  gnome_stock_button              (const char *type);
    GtkWidget*  gnome_stock_or_ordinary_button  (const char *type);
    #define     GNOME_STOCK_MENU_BLANK
    #define     GNOME_STOCK_MENU_NEW
    #define     GNOME_STOCK_MENU_SAVE
    #define     GNOME_STOCK_MENU_SAVE_AS
    #define     GNOME_STOCK_MENU_REVERT
    #define     GNOME_STOCK_MENU_OPEN
    #define     GNOME_STOCK_MENU_CLOSE
    #define     GNOME_STOCK_MENU_QUIT
    #define     GNOME_STOCK_MENU_CUT
    #define     GNOME_STOCK_MENU_COPY
    #define     GNOME_STOCK_MENU_PASTE
    #define     GNOME_STOCK_MENU_PROP
    #define     GNOME_STOCK_MENU_PREF
    #define     GNOME_STOCK_MENU_ABOUT
    #define     GNOME_STOCK_MENU_SCORES
    #define     GNOME_STOCK_MENU_UNDO
    #define     GNOME_STOCK_MENU_REDO
    #define     GNOME_STOCK_MENU_PRINT
    #define     GNOME_STOCK_MENU_SEARCH
    #define     GNOME_STOCK_MENU_SRCHRPL
    #define     GNOME_STOCK_MENU_BACK
    #define     GNOME_STOCK_MENU_FORWARD
    #define     GNOME_STOCK_MENU_FIRST
    #define     GNOME_STOCK_MENU_LAST
    #define     GNOME_STOCK_MENU_HOME
    #define     GNOME_STOCK_MENU_STOP
    #define     GNOME_STOCK_MENU_REFRESH
    #define     GNOME_STOCK_MENU_MAIL
    #define     GNOME_STOCK_MENU_MAIL_RCV
    #define     GNOME_STOCK_MENU_MAIL_SND
    #define     GNOME_STOCK_MENU_MAIL_RPL
    #define     GNOME_STOCK_MENU_MAIL_FWD
    #define     GNOME_STOCK_MENU_MAIL_NEW
    #define     GNOME_STOCK_MENU_TRASH
    #define     GNOME_STOCK_MENU_TRASH_FULL
    #define     GNOME_STOCK_MENU_UNDELETE
    #define     GNOME_STOCK_MENU_TIMER
    #define     GNOME_STOCK_MENU_TIMER_STOP
    #define     GNOME_STOCK_MENU_SPELLCHECK
    #define     GNOME_STOCK_MENU_MIC
    #define     GNOME_STOCK_MENU_LINE_IN
    #define     GNOME_STOCK_MENU_CDROM
    #define     GNOME_STOCK_MENU_VOLUME
    #define     GNOME_STOCK_MENU_BOOK_RED
    #define     GNOME_STOCK_MENU_BOOK_GREEN
    #define     GNOME_STOCK_MENU_BOOK_BLUE
    #define     GNOME_STOCK_MENU_BOOK_YELLOW
    #define     GNOME_STOCK_MENU_BOOK_OPEN
    #define     GNOME_STOCK_MENU_CONVERT
    #define     GNOME_STOCK_MENU_JUMP_TO
    #define     GNOME_STOCK_MENU_UP
    #define     GNOME_STOCK_MENU_DOWN
    #define     GNOME_STOCK_MENU_TOP
    #define     GNOME_STOCK_MENU_BOTTOM
    #define     GNOME_STOCK_MENU_ATTACH
    #define     GNOME_STOCK_MENU_INDEX
    #define     GNOME_STOCK_MENU_FONT
    #define     GNOME_STOCK_MENU_EXEC
    #define     GNOME_STOCK_MENU_ALIGN_LEFT
    #define     GNOME_STOCK_MENU_ALIGN_RIGHT
    #define     GNOME_STOCK_MENU_ALIGN_CENTER
    #define     GNOME_STOCK_MENU_ALIGN_JUSTIFY
    #define     GNOME_STOCK_MENU_TEXT_BOLD
    #define     GNOME_STOCK_MENU_TEXT_ITALIC
    #define     GNOME_STOCK_MENU_TEXT_UNDERLINE
    #define     GNOME_STOCK_MENU_TEXT_STRIKEOUT
    #define     GNOME_STOCK_MENU_EXIT
    GtkWidget*  gnome_stock_menu_item           (const char *type,
                                                 const char *text);
    gboolean    gnome_stock_menu_accel          (const char *type,
                                                 guchar *key,
                                                 guint8 *mod);
    void        gnome_stock_menu_accel_parse    (const char *section);
    GtkWidget*  gnome_stock_transparent_window  (const char *icon,
                                                 const char *subtype);
    void        gnome_stock_pixmap_gdk          (const char *icon,
                                                 const char *subtype,
                                                 GdkPixmap **pixmap,
                                                 GdkPixmap **mask);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GnomePixmap
                   +----GnomeStock

## Description

These functions provide an applications programmer with default icons for toolbars, menu pixmaps and buttons.

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.

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.

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.

### GNOME_STOCK icons internals

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.

## Details

### struct GnomeStock

    struct GnomeStock;

### GNOME_STOCK_PIXMAP_NEW

    #define GNOME_STOCK_PIXMAP_NEW         "New"

Image for representing "New".

### GNOME_STOCK_PIXMAP_OPEN

    #define GNOME_STOCK_PIXMAP_OPEN        "Open"

Image for representing "Open".

### GNOME_STOCK_PIXMAP_CLOSE

    #define GNOME_STOCK_PIXMAP_CLOSE       "Close"

Image for representing "Close".

### GNOME_STOCK_PIXMAP_REVERT

    #define GNOME_STOCK_PIXMAP_REVERT      "Revert"

Image for representing "Revert".

### GNOME_STOCK_PIXMAP_SAVE

    #define GNOME_STOCK_PIXMAP_SAVE        "Save"

Image for representing "Save".

### GNOME_STOCK_PIXMAP_SAVE_AS

    #define GNOME_STOCK_PIXMAP_SAVE_AS     "Save As"

Image for representing "Save as".

### GNOME_STOCK_PIXMAP_CUT

    #define GNOME_STOCK_PIXMAP_CUT         "Cut"

Image for representing "Cut".

### GNOME_STOCK_PIXMAP_COPY

    #define GNOME_STOCK_PIXMAP_COPY        "Copy"

Image for representing "Copy".

### GNOME_STOCK_PIXMAP_PASTE

    #define GNOME_STOCK_PIXMAP_PASTE       "Paste"

Image for representing "Paste".

### GNOME_STOCK_PIXMAP_CLEAR

    #define GNOME_STOCK_PIXMAP_CLEAR       "Clear"

Image for representing "Clear".

### GNOME_STOCK_PIXMAP_PROPERTIES

    #define GNOME_STOCK_PIXMAP_PROPERTIES  "Properties"

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.

### GNOME_STOCK_PIXMAP_PREFERENCES

    #define GNOME_STOCK_PIXMAP_PREFERENCES "Preferences"

Image for representing "Preferences". Please see note for "Properties" above.

### GNOME_STOCK_PIXMAP_HELP

    #define GNOME_STOCK_PIXMAP_HELP        "Help"

Image for representing "Help".

### GNOME_STOCK_PIXMAP_SCORES

    #define GNOME_STOCK_PIXMAP_SCORES      "Scores"

Image for representing "Scores".

### GNOME_STOCK_PIXMAP_PRINT

    #define GNOME_STOCK_PIXMAP_PRINT       "Print"

Image for representing "Print".

### GNOME_STOCK_PIXMAP_SEARCH

    #define GNOME_STOCK_PIXMAP_SEARCH      "Search"

Image for representing "Search".

### GNOME_STOCK_PIXMAP_SRCHRPL

    #define GNOME_STOCK_PIXMAP_SRCHRPL     "Search/Replace"

Image for representing "Search and replace".

### GNOME_STOCK_PIXMAP_BACK

    #define GNOME_STOCK_PIXMAP_BACK        "Back"

Image for representing "Back".

### GNOME_STOCK_PIXMAP_FORWARD

    #define GNOME_STOCK_PIXMAP_FORWARD     "Forward"

Image for representing "Forward".

### GNOME_STOCK_PIXMAP_FIRST

    #define GNOME_STOCK_PIXMAP_FIRST       "First"

### GNOME_STOCK_PIXMAP_LAST

    #define GNOME_STOCK_PIXMAP_LAST        "Last"

### GNOME_STOCK_PIXMAP_HOME

    #define GNOME_STOCK_PIXMAP_HOME        "Home"

Image for representing "Home".

### GNOME_STOCK_PIXMAP_STOP

    #define GNOME_STOCK_PIXMAP_STOP        "Stop"

Image for representing "Stop".

### GNOME_STOCK_PIXMAP_REFRESH

    #define GNOME_STOCK_PIXMAP_REFRESH     "Refresh"

Image for representing "Refresh".

### GNOME_STOCK_PIXMAP_UNDO

    #define GNOME_STOCK_PIXMAP_UNDO        "Undo"

Image for representing "Undo".

### GNOME_STOCK_PIXMAP_REDO

    #define GNOME_STOCK_PIXMAP_REDO        "Redo"

Image for representing "Redo".

### GNOME_STOCK_PIXMAP_TIMER

    #define GNOME_STOCK_PIXMAP_TIMER       "Timer"

Image for representing "Timer".

### GNOME_STOCK_PIXMAP_TIMER_STOP

    #define GNOME_STOCK_PIXMAP_TIMER_STOP  "Timer Stopped"

Image for representing "Timer stop".

### GNOME_STOCK_PIXMAP_MAIL

    #define GNOME_STOCK_PIXMAP_MAIL	       "Mail"

Image for representing "Mail".

### GNOME_STOCK_PIXMAP_MAIL_RCV

    #define GNOME_STOCK_PIXMAP_MAIL_RCV    "Receive Mail"

Image for representing "Mail get".

### GNOME_STOCK_PIXMAP_MAIL_SND

    #define GNOME_STOCK_PIXMAP_MAIL_SND    "Send Mail"

Image for representing "Mail send".

### GNOME_STOCK_PIXMAP_MAIL_RPL

    #define GNOME_STOCK_PIXMAP_MAIL_RPL    "Reply to Mail"

Image for representing "Mail reply".

### GNOME_STOCK_PIXMAP_MAIL_FWD

    #define GNOME_STOCK_PIXMAP_MAIL_FWD    "Forward Mail"

Image for representing "Timer".

### GNOME_STOCK_PIXMAP_MAIL_NEW

    #define GNOME_STOCK_PIXMAP_MAIL_NEW    "New Mail"

Image for representing "Mail new".

### GNOME_STOCK_PIXMAP_TRASH

    #define GNOME_STOCK_PIXMAP_TRASH       "Trash"

Image for representing "Trashcan".

### GNOME_STOCK_PIXMAP_TRASH_FULL

    #define GNOME_STOCK_PIXMAP_TRASH_FULL  "Trash Full"

Image for representing "Trashcan is full".

### GNOME_STOCK_PIXMAP_UNDELETE

    #define GNOME_STOCK_PIXMAP_UNDELETE    "Undelete"

Image for representing "Undelete".

### GNOME_STOCK_PIXMAP_SPELLCHECK

    #define GNOME_STOCK_PIXMAP_SPELLCHECK  "Spellchecker"

Image for representing "Spellcheck".

### GNOME_STOCK_PIXMAP_MIC

    #define GNOME_STOCK_PIXMAP_MIC         "Microphone"

Image for representing "Microphone".

### GNOME_STOCK_PIXMAP_LINE_IN

    #define GNOME_STOCK_PIXMAP_LINE_IN     "Line In"

Image for representing "Line in".

### GNOME_STOCK_PIXMAP_CDROM

    #define GNOME_STOCK_PIXMAP_CDROM       "Cdrom"

Image for representing "CD-ROM".

### GNOME_STOCK_PIXMAP_VOLUME

    #define GNOME_STOCK_PIXMAP_VOLUME      "Volume"

Image for representing "Volume".

### GNOME_STOCK_PIXMAP_BOOK_RED

    #define GNOME_STOCK_PIXMAP_BOOK_RED    "Book Red"

Image for representing "A red book".

### GNOME_STOCK_PIXMAP_BOOK_GREEN

    #define GNOME_STOCK_PIXMAP_BOOK_GREEN  "Book Green"

Image for representing "A green book".

### GNOME_STOCK_PIXMAP_BOOK_BLUE

    #define GNOME_STOCK_PIXMAP_BOOK_BLUE   "Book Blue"

Image for representing "A blue book".

### GNOME_STOCK_PIXMAP_BOOK_YELLOW

    #define GNOME_STOCK_PIXMAP_BOOK_YELLOW "Book Yellow"

Image for representing "A yellow book".

### GNOME_STOCK_PIXMAP_BOOK_OPEN

    #define GNOME_STOCK_PIXMAP_BOOK_OPEN   "Book Open"

Image for representing "An open book".

### GNOME_STOCK_PIXMAP_ABOUT

    #define GNOME_STOCK_PIXMAP_ABOUT       "About"

Image for representing "About".

### GNOME_STOCK_PIXMAP_QUIT

    #define GNOME_STOCK_PIXMAP_QUIT        "Quit"

Image for representing "Quit".

### GNOME_STOCK_PIXMAP_MULTIPLE

    #define GNOME_STOCK_PIXMAP_MULTIPLE    "Multiple"

### GNOME_STOCK_PIXMAP_NOT

    #define GNOME_STOCK_PIXMAP_NOT         "Not"

### GNOME_STOCK_PIXMAP_CONVERT

    #define GNOME_STOCK_PIXMAP_CONVERT     "Convert"

### GNOME_STOCK_PIXMAP_JUMP_TO

    #define GNOME_STOCK_PIXMAP_JUMP_TO     "Jump To"

### GNOME_STOCK_PIXMAP_UP

    #define GNOME_STOCK_PIXMAP_UP          "Up"

### GNOME_STOCK_PIXMAP_DOWN

    #define GNOME_STOCK_PIXMAP_DOWN        "Down"

### GNOME_STOCK_PIXMAP_TOP

    #define GNOME_STOCK_PIXMAP_TOP         "Top"

### GNOME_STOCK_PIXMAP_BOTTOM

    #define GNOME_STOCK_PIXMAP_BOTTOM      "Bottom"

### GNOME_STOCK_PIXMAP_ATTACH

    #define GNOME_STOCK_PIXMAP_ATTACH      "Attach"

### GNOME_STOCK_PIXMAP_INDEX

    #define GNOME_STOCK_PIXMAP_INDEX       "Index"

### GNOME_STOCK_PIXMAP_FONT

    #define GNOME_STOCK_PIXMAP_FONT        "Font"

### GNOME_STOCK_PIXMAP_EXEC

    #define GNOME_STOCK_PIXMAP_EXEC        "Exec"

### GNOME_STOCK_PIXMAP_ALIGN_LEFT

    #define GNOME_STOCK_PIXMAP_ALIGN_LEFT    "Left"

### GNOME_STOCK_PIXMAP_ALIGN_RIGHT

    #define GNOME_STOCK_PIXMAP_ALIGN_RIGHT   "Right"

### GNOME_STOCK_PIXMAP_ALIGN_CENTER

    #define GNOME_STOCK_PIXMAP_ALIGN_CENTER  "Center"

### GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY

    #define GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY "Justify"

### GNOME_STOCK_PIXMAP_TEXT_BOLD

    #define GNOME_STOCK_PIXMAP_TEXT_BOLD      "Bold"

### GNOME_STOCK_PIXMAP_TEXT_ITALIC

    #define GNOME_STOCK_PIXMAP_TEXT_ITALIC    "Italic"

### GNOME_STOCK_PIXMAP_TEXT_UNDERLINE

    #define GNOME_STOCK_PIXMAP_TEXT_UNDERLINE "Underline"

### GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT

    #define GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT "Strikeout"

### GNOME_STOCK_PIXMAP_TEXT_INDENT

    #define GNOME_STOCK_PIXMAP_TEXT_INDENT "Text Indent"

### GNOME_STOCK_PIXMAP_TEXT_UNINDENT

    #define GNOME_STOCK_PIXMAP_TEXT_UNINDENT "Text Unindent"

### GNOME_STOCK_PIXMAP_EXIT

    #define GNOME_STOCK_PIXMAP_EXIT        GNOME_STOCK_PIXMAP_QUIT

### GNOME_STOCK_PIXMAP_COLORSELECTOR

    #define GNOME_STOCK_PIXMAP_COLORSELECTOR "Color Select"

### GNOME_STOCK_PIXMAP_ADD

    #define GNOME_STOCK_PIXMAP_ADD    "Add"

### GNOME_STOCK_PIXMAP_REMOVE

    #define GNOME_STOCK_PIXMAP_REMOVE "Remove"

### GNOME_STOCK_PIXMAP_TABLE_BORDERS

    #define GNOME_STOCK_PIXMAP_TABLE_BORDERS "Table Borders"

### GNOME_STOCK_PIXMAP_TABLE_FILL

    #define GNOME_STOCK_PIXMAP_TABLE_FILL "Table Fill"

### GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST

    #define GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST "Text Bulleted List"

### GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST

    #define GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST "Text Numbered List"

### GNOME_STOCK_PIXMAP_REGULAR

    #define GNOME_STOCK_PIXMAP_REGULAR     "regular"

### GNOME_STOCK_PIXMAP_DISABLED

    #define GNOME_STOCK_PIXMAP_DISABLED    "disabled"

### GNOME_STOCK_PIXMAP_FOCUSED

    #define GNOME_STOCK_PIXMAP_FOCUSED     "focused"

### struct GnomeStockPixmapEntryAny

    struct GnomeStockPixmapEntryAny {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
    };

### struct GnomeStockPixmapEntryData

    struct GnomeStockPixmapEntryData {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            gchar **xpm_data;
    };

### struct GnomeStockPixmapEntryFile

    struct GnomeStockPixmapEntryFile {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            gchar *filename;
    };

### struct GnomeStockPixmapEntryPath

    struct GnomeStockPixmapEntryPath {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            gchar *pathname;
    };

### struct GnomeStockPixmapEntryWidget

    struct GnomeStockPixmapEntryWidget {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            GtkWidget *widget;
    };

### struct GnomeStockPixmapEntryGPixmap

    struct GnomeStockPixmapEntryGPixmap {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            GnomePixmap *pixmap;
    };

### enum GnomeStockPixmapType

    typedef enum {
            GNOME_STOCK_PIXMAP_TYPE_NONE,
            GNOME_STOCK_PIXMAP_TYPE_DATA,
            GNOME_STOCK_PIXMAP_TYPE_FILE,
            GNOME_STOCK_PIXMAP_TYPE_PATH,
            GNOME_STOCK_PIXMAP_TYPE_WIDGET,
    	GNOME_STOCK_PIXMAP_TYPE_IMLIB,
    	GNOME_STOCK_PIXMAP_TYPE_IMLIB_SCALED,
    	GNOME_STOCK_PIXMAP_TYPE_GPIXMAP
    } GnomeStockPixmapType;

### struct GnomeStockPixmapEntryImlib

    struct GnomeStockPixmapEntryImlib {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            const gchar *rgb_data;
    	GdkImlibColor shape;
    };

### struct GnomeStockPixmapEntryImlibScaled

    struct GnomeStockPixmapEntryImlibScaled {
            GnomeStockPixmapType type;
    	int width, height;
    	char *label;
            const gchar *rgb_data;
    	GdkImlibColor shape;
    	int scaled_width, scaled_height;
    };

### union GnomeStockPixmapEntry

    union GnomeStockPixmapEntry {
            GnomeStockPixmapType type;
            GnomeStockPixmapEntryAny any;
            GnomeStockPixmapEntryData data;
            GnomeStockPixmapEntryFile file;
            GnomeStockPixmapEntryPath path;
            GnomeStockPixmapEntryWidget widget;
    	GnomeStockPixmapEntryImlib imlib;
    	GnomeStockPixmapEntryImlibScaled imlib_s;
            GnomeStockPixmapEntryGPixmap gpixmap;
    };

### gnome_stock_new ()

    GtkWidget*  gnome_stock_new                 (void);

Returns : | a new empty GnomeStock widget

### gnome_stock_new_with_icon ()

    GtkWidget*  gnome_stock_new_with_icon       (const char *icon);

`icon` : | icon code.
Returns : | A GnomeStock widget created with the initial icon code set to `icon`.

### gnome_stock_set_icon ()

    gboolean    gnome_stock_set_icon            (GnomeStock *stock,
                                                 const char *icon);

Sets the `stock` object icon to be the one whose code is `icon`.

`stock` : | The GnomeStock object on which to operate
`icon` : | Icon code to set
Returns : | TRUE if the icon was set successfully.

### gnome_stock_pixmap ()

    GnomePixmap* gnome_stock_pixmap             (GtkWidget *window,
                                                 const char *icon,
                                                 const char *subtype);

`window` : |
`icon` : |
`subtype` : |
Returns : |

### gnome_stock_pixmap_widget ()

    GtkWidget*  gnome_stock_pixmap_widget       (GtkWidget *window,
                                                 const char *icon);

`window` : |
`icon` : |
Returns : |

### gnome_stock_pixmap_widget_at_size ()

    GtkWidget*  gnome_stock_pixmap_widget_at_size
                                                (GtkWidget *window,
                                                 const char *icon,
                                                 guint width,
                                                 guint height);

`window` : |
`icon` : |
`width` : |
`height` : |
Returns : |

### gnome_stock_pixmap_widget_set_icon ()

    void        gnome_stock_pixmap_widget_set_icon
                                                (GnomeStock *widget,
                                                 const char *icon);

`widget` : |
`icon` : |

### gnome_stock_pixmap_register ()

    gint        gnome_stock_pixmap_register     (const char *icon,
                                                 const char *subtype,
                                                 GnomeStockPixmapEntry *entry);

`icon` : |
`subtype` : |
`entry` : |
Returns : |

### gnome_stock_pixmap_change ()

    gint        gnome_stock_pixmap_change       (const char *icon,
                                                 const char *subtype,
                                                 GnomeStockPixmapEntry *entry);

`icon` : |
`subtype` : |
`entry` : |
Returns : |

### gnome_stock_pixmap_checkfor ()

    GnomeStockPixmapEntry* gnome_stock_pixmap_checkfor
                                                (const char *icon,
                                                 const char *subtype);

`icon` : |
`subtype` : |
Returns : |

### gnome_pixmap_button ()

    GtkWidget*  gnome_pixmap_button             (GtkWidget *pixmap,
                                                 const char *text);

`pixmap` : |
`text` : |
Returns : |

### gnome_button_can_default ()

    void        gnome_button_can_default        (GtkButton *button,
                                                 gboolean can_default);

`button` : |
`can_default` : |

### GNOME_STOCK_BUTTON_OK

    #define GNOME_STOCK_BUTTON_OK     "Button_Ok"

### GNOME_STOCK_BUTTON_CANCEL

    #define GNOME_STOCK_BUTTON_CANCEL "Button_Cancel"

### GNOME_STOCK_BUTTON_YES

    #define GNOME_STOCK_BUTTON_YES    "Button_Yes"

### GNOME_STOCK_BUTTON_NO

    #define GNOME_STOCK_BUTTON_NO     "Button_No"

### GNOME_STOCK_BUTTON_CLOSE

    #define GNOME_STOCK_BUTTON_CLOSE  "Button_Close"

### GNOME_STOCK_BUTTON_APPLY

    #define GNOME_STOCK_BUTTON_APPLY  "Button_Apply"

### GNOME_STOCK_BUTTON_HELP

    #define GNOME_STOCK_BUTTON_HELP   "Button_Help"

### GNOME_STOCK_BUTTON_NEXT

    #define GNOME_STOCK_BUTTON_NEXT   "Button_Next"

### GNOME_STOCK_BUTTON_PREV

    #define GNOME_STOCK_BUTTON_PREV   "Button_Prev"

### GNOME_STOCK_BUTTON_UP

    #define GNOME_STOCK_BUTTON_UP     "Button_Up"

### GNOME_STOCK_BUTTON_DOWN

    #define GNOME_STOCK_BUTTON_DOWN   "Button_Down"

### GNOME_STOCK_BUTTON_FONT

    #define GNOME_STOCK_BUTTON_FONT   "Button_Font"

### gnome_stock_button ()

    GtkWidget*  gnome_stock_button              (const char *type);

Constructs a new GtkButton which contains a stock icon and text whose type is `type`.

`type` : | gnome stock type code.
Returns : | A configured GtkButton widget

### gnome_stock_or_ordinary_button ()

    GtkWidget*  gnome_stock_or_ordinary_button  (const char *type);

It `type` contains a valid GNOME stock code, it constructs a new GtkButton which contains a stock icon and text for the matching type, or if the type does not exist, it creates a button with the label being the same as "type".

The use of this routine is discouraged, given that on international setups it might break subtly.

`type` : | gnome stock type code.
Returns : | A GtkButton.

### GNOME_STOCK_MENU_BLANK

    #define GNOME_STOCK_MENU_BLANK        "Menu_"

### GNOME_STOCK_MENU_NEW

    #define GNOME_STOCK_MENU_NEW          "Menu_New"

### GNOME_STOCK_MENU_SAVE

    #define GNOME_STOCK_MENU_SAVE         "Menu_Save"

### GNOME_STOCK_MENU_SAVE_AS

    #define GNOME_STOCK_MENU_SAVE_AS      "Menu_Save As"

### GNOME_STOCK_MENU_REVERT

    #define GNOME_STOCK_MENU_REVERT       "Menu_Revert"

### GNOME_STOCK_MENU_OPEN

    #define GNOME_STOCK_MENU_OPEN         "Menu_Open"

### GNOME_STOCK_MENU_CLOSE

    #define GNOME_STOCK_MENU_CLOSE        "Menu_Close"

### GNOME_STOCK_MENU_QUIT

    #define GNOME_STOCK_MENU_QUIT         "Menu_Quit"

### GNOME_STOCK_MENU_CUT

    #define GNOME_STOCK_MENU_CUT          "Menu_Cut"

### GNOME_STOCK_MENU_COPY

    #define GNOME_STOCK_MENU_COPY         "Menu_Copy"

### GNOME_STOCK_MENU_PASTE

    #define GNOME_STOCK_MENU_PASTE        "Menu_Paste"

### GNOME_STOCK_MENU_PROP

    #define GNOME_STOCK_MENU_PROP         "Menu_Properties"

### GNOME_STOCK_MENU_PREF

    #define GNOME_STOCK_MENU_PREF         "Menu_Preferences"

### GNOME_STOCK_MENU_ABOUT

    #define GNOME_STOCK_MENU_ABOUT        "Menu_About"

### GNOME_STOCK_MENU_SCORES

    #define GNOME_STOCK_MENU_SCORES       "Menu_Scores"

### GNOME_STOCK_MENU_UNDO

    #define GNOME_STOCK_MENU_UNDO         "Menu_Undo"

### GNOME_STOCK_MENU_REDO

    #define GNOME_STOCK_MENU_REDO         "Menu_Redo"

### GNOME_STOCK_MENU_PRINT

    #define GNOME_STOCK_MENU_PRINT        "Menu_Print"

### GNOME_STOCK_MENU_SEARCH

    #define GNOME_STOCK_MENU_SEARCH       "Menu_Search"

### GNOME_STOCK_MENU_SRCHRPL

    #define GNOME_STOCK_MENU_SRCHRPL      "Menu_Search/Replace"

### GNOME_STOCK_MENU_BACK

    #define GNOME_STOCK_MENU_BACK         "Menu_Back"

### GNOME_STOCK_MENU_FORWARD

    #define GNOME_STOCK_MENU_FORWARD      "Menu_Forward"

### GNOME_STOCK_MENU_FIRST

    #define GNOME_STOCK_MENU_FIRST        "Menu_First"

### GNOME_STOCK_MENU_LAST

    #define GNOME_STOCK_MENU_LAST         "Menu_Last"

### GNOME_STOCK_MENU_HOME

    #define GNOME_STOCK_MENU_HOME         "Menu_Home"

### GNOME_STOCK_MENU_STOP

    #define GNOME_STOCK_MENU_STOP         "Menu_Stop"

### GNOME_STOCK_MENU_REFRESH

    #define GNOME_STOCK_MENU_REFRESH      "Menu_Refresh"

### GNOME_STOCK_MENU_MAIL

    #define GNOME_STOCK_MENU_MAIL         "Menu_Mail"

### GNOME_STOCK_MENU_MAIL_RCV

    #define GNOME_STOCK_MENU_MAIL_RCV     "Menu_Receive Mail"

### GNOME_STOCK_MENU_MAIL_SND

    #define GNOME_STOCK_MENU_MAIL_SND     "Menu_Send Mail"

### GNOME_STOCK_MENU_MAIL_RPL

    #define GNOME_STOCK_MENU_MAIL_RPL     "Menu_Reply to Mail"

### GNOME_STOCK_MENU_MAIL_FWD

    #define GNOME_STOCK_MENU_MAIL_FWD     "Menu_Forward Mail"

### GNOME_STOCK_MENU_MAIL_NEW

    #define GNOME_STOCK_MENU_MAIL_NEW     "Menu_New Mail"

### GNOME_STOCK_MENU_TRASH

    #define GNOME_STOCK_MENU_TRASH        "Menu_Trash"

### GNOME_STOCK_MENU_TRASH_FULL

    #define GNOME_STOCK_MENU_TRASH_FULL   "Menu_Trash Full"

### GNOME_STOCK_MENU_UNDELETE

    #define GNOME_STOCK_MENU_UNDELETE     "Menu_Undelete"

### GNOME_STOCK_MENU_TIMER

    #define GNOME_STOCK_MENU_TIMER        "Menu_Timer"

### GNOME_STOCK_MENU_TIMER_STOP

    #define GNOME_STOCK_MENU_TIMER_STOP   "Menu_Timer Stopped"

### GNOME_STOCK_MENU_SPELLCHECK

    #define GNOME_STOCK_MENU_SPELLCHECK   "Menu_Spellchecker"

### GNOME_STOCK_MENU_MIC

    #define GNOME_STOCK_MENU_MIC          "Menu_Microphone"

### GNOME_STOCK_MENU_LINE_IN

    #define GNOME_STOCK_MENU_LINE_IN      "Menu_Line In"

### GNOME_STOCK_MENU_CDROM

    #define GNOME_STOCK_MENU_CDROM	     "Menu_Cdrom"

### GNOME_STOCK_MENU_VOLUME

    #define GNOME_STOCK_MENU_VOLUME       "Menu_Volume"

### GNOME_STOCK_MENU_BOOK_RED

    #define GNOME_STOCK_MENU_BOOK_RED     "Menu_Book Red"

### GNOME_STOCK_MENU_BOOK_GREEN

    #define GNOME_STOCK_MENU_BOOK_GREEN   "Menu_Book Green"

### GNOME_STOCK_MENU_BOOK_BLUE

    #define GNOME_STOCK_MENU_BOOK_BLUE    "Menu_Book Blue"

### GNOME_STOCK_MENU_BOOK_YELLOW

    #define GNOME_STOCK_MENU_BOOK_YELLOW  "Menu_Book Yellow"

### GNOME_STOCK_MENU_BOOK_OPEN

    #define GNOME_STOCK_MENU_BOOK_OPEN    "Menu_Book Open"

### GNOME_STOCK_MENU_CONVERT

    #define GNOME_STOCK_MENU_CONVERT      "Menu_Convert"

### GNOME_STOCK_MENU_JUMP_TO

    #define GNOME_STOCK_MENU_JUMP_TO      "Menu_Jump To"

### GNOME_STOCK_MENU_UP

    #define GNOME_STOCK_MENU_UP           "Menu_Up"

### GNOME_STOCK_MENU_DOWN

    #define GNOME_STOCK_MENU_DOWN         "Menu_Down"

### GNOME_STOCK_MENU_TOP

    #define GNOME_STOCK_MENU_TOP          "Menu_Top"

### GNOME_STOCK_MENU_BOTTOM

    #define GNOME_STOCK_MENU_BOTTOM       "Menu_Bottom"

### GNOME_STOCK_MENU_ATTACH

    #define GNOME_STOCK_MENU_ATTACH       "Menu_Attach"

### GNOME_STOCK_MENU_INDEX

    #define GNOME_STOCK_MENU_INDEX        "Menu_Index"

### GNOME_STOCK_MENU_FONT

    #define GNOME_STOCK_MENU_FONT         "Menu_Font"

### GNOME_STOCK_MENU_EXEC

    #define GNOME_STOCK_MENU_EXEC         "Menu_Exec"

### GNOME_STOCK_MENU_ALIGN_LEFT

    #define GNOME_STOCK_MENU_ALIGN_LEFT     "Menu_Left"

### GNOME_STOCK_MENU_ALIGN_RIGHT

    #define GNOME_STOCK_MENU_ALIGN_RIGHT    "Menu_Right"

### GNOME_STOCK_MENU_ALIGN_CENTER

    #define GNOME_STOCK_MENU_ALIGN_CENTER   "Menu_Center"

### GNOME_STOCK_MENU_ALIGN_JUSTIFY

    #define GNOME_STOCK_MENU_ALIGN_JUSTIFY  "Menu_Justify"

### GNOME_STOCK_MENU_TEXT_BOLD

    #define GNOME_STOCK_MENU_TEXT_BOLD      "Menu_Bold"

### GNOME_STOCK_MENU_TEXT_ITALIC

    #define GNOME_STOCK_MENU_TEXT_ITALIC    "Menu_Italic"

### GNOME_STOCK_MENU_TEXT_UNDERLINE

    #define GNOME_STOCK_MENU_TEXT_UNDERLINE "Menu_Underline"

### GNOME_STOCK_MENU_TEXT_STRIKEOUT

    #define GNOME_STOCK_MENU_TEXT_STRIKEOUT "Menu_Strikeout"

### GNOME_STOCK_MENU_EXIT

    #define GNOME_STOCK_MENU_EXIT     GNOME_STOCK_MENU_QUIT

### gnome_stock_menu_item ()

    GtkWidget*  gnome_stock_menu_item           (const char *type,
                                                 const char *text);

`type` : |
`text` : |
Returns : |

### gnome_stock_menu_accel ()

    gboolean    gnome_stock_menu_accel          (const char *type,
                                                 guchar *key,
                                                 guint8 *mod);

`type` : |
`key` : |
`mod` : |
Returns : |

### gnome_stock_menu_accel_parse ()

    void        gnome_stock_menu_accel_parse    (const char *section);

`section` : |

### gnome_stock_transparent_window ()

    GtkWidget*  gnome_stock_transparent_window  (const char *icon,
                                                 const char *subtype);

`icon` : |
`subtype` : |
Returns : |

### gnome_stock_pixmap_gdk ()

    void        gnome_stock_pixmap_gdk          (const char *icon,
                                                 const char *subtype,
                                                 GdkPixmap **pixmap,
                                                 GdkPixmap **mask);

`icon` : |
`subtype` : |
`pixmap` : |
`mask` : |

## See Also

GtkButton, GnomePixmap

<<< Previous Page | Home | Up | Next Page >>>
GnomeScores | GtkClock