GXK Interface Reference

/opt/src/beast/beast-gtk/gxk/gxkstock.h

SYNOPSIS

struct  GxkStockIcon;
struct  GxkStockItem;
   
guint  gxk_size_height  (icon_size);
guint  gxk_size_width  (icon_size);
GtkWidget*  gxk_stock_button  (stock_id, label);
GtkWidget*  gxk_stock_button_child  (stock_id, label);
GdkPixbuf*  gxk_stock_fallback_pixbuf  (stock_id);
GtkWidget*  gxk_stock_icon_window  (stock_id);
GtkWidget*  gxk_stock_image  (stock_icon_id, icon_size);
const gchar*  gxk_stock_item  (stock_id);
void  gxk_stock_register_icon  (icon);
void  gxk_stock_register_icons  (n_icons, icons);
void  gxk_stock_register_item  (item);
void  gxk_stock_register_items  (n_items, items);

DESCRIPTION

GxkStockIcon

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:50
struct GxkStockIcon
{
  const gchar  *stock_id;
  const guint8 *inlined_pixbuf;
};

GxkStockItem

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:54
struct GxkStockItem
{
  const gchar *stock_id;
  const gchar *label;
  const gchar *stock_fallback;
};

gxk_size_height

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:34
guint  gxk_size_height  
(GtkIconSize icon_size);
Return the height of a specific image size.
icon_size: image size id
RETURNS: image size height

gxk_size_width

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:33
guint  gxk_size_width  
(GtkIconSize icon_size);
Return the width of a specific image size.
icon_size: image size id
RETURNS: image size width

gxk_stock_button

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:41
GtkWidget*  gxk_stock_button  
(const gchar *stock_id,
 const gchar *label);
Create a GtkButton widget with a stock image and custom label text.
stock_id: stock name
label: button text
RETURNS: a visible GtkButton widget

gxk_stock_button_child

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:43
GtkWidget*  gxk_stock_button_child  
(const gchar *stock_id,
 const gchar *label);
This function does the same as gxk_stock_button() except for creating the actual button. The button's child is instead returned to the caller, this might e.g. be useful if a button is created containing multiple children which are shown only selectively during runtime.
stock_id: stock name
label: button text
RETURNS: a visible widget suitable as GtkButton child

gxk_stock_fallback_pixbuf

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:45
GdkPixbuf*  gxk_stock_fallback_pixbuf  
(const gchar *stock_id);
Return the pixbuf associated with stock_id, the pixbuf is owned by the stock system and persists throughout runtime. To display stock icons in widgets use gxk_stock_image() and not this pixbuf.
stock_id: stock name
RETURNS: this stock_id's pixbuf (or NULL for invalid stock ids)

gxk_stock_icon_window

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:46
GtkWidget*  gxk_stock_icon_window  
(const gchar *stock_id);
Create a window displaying a stock icon which is transparent according to the icon's alpha mask. Such windows are mostly useful to implement drag-and-drop operations with stock icons.
stock_id: a valid stock icon name
RETURNS: a window showing the stock icon

gxk_stock_image

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:39
GtkWidget*  gxk_stock_image  
(const gchar *stock_icon_id,
 GtkIconSize  icon_size);
Create a GtkImage widget with a stock image of a certain size, or return NULL if the image doesn't exist. The returned image widget correctly displays the stock icon, honouring prelight and sensitivity state of the widget.
stock_icon_id: stock name
icon_size: image size
RETURNS: a visible GtkImage widget or NULL

gxk_stock_item

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:44
const gchar*  gxk_stock_item  
(const gchar *stock_id);

gxk_stock_register_icon

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:59
void  gxk_stock_register_icon  
(const GxkStockIcon *icon);
Register a new stock icon from an inlined pixbuf. The inlined pixbuf pixels are not copied, so the caller must make sure for the data to remain valid.
icon: a validly filled out GxkStockIcon

gxk_stock_register_icons

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:61
void  gxk_stock_register_icons  
(guint               n_icons,
 const GxkStockIcon *icons);
For all n_icons contained in icons, call gxk_stock_register_icon().
n_icons: number of icons to register
icons: a validly filled out array of GxkStockIcon

gxk_stock_register_item

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:62
void  gxk_stock_register_item  
(const GxkStockItem *item);
Register a new stock item. The new stock item item->stock_id is registered with an item label of item->label and the stock icon item->stock_fallback. If item->label is NULL, item->stock_fallback must not be NULL, and item->stock_id becomes merely an alias of item->stock_fallback.
item: a validly filled out GxkStockItem

gxk_stock_register_items

 /opt/src/beast/beast-gtk/gxk/gxkstock.h:64
void  gxk_stock_register_items  
(guint               n_items,
 const GxkStockItem *items);
For all n_items contained in items, call gxk_stock_register_item().
n_items: number of items to register
items: a validly filled out array of GxkStockItem