alternative to assert

[gtkD.git] / src / gtk / StockItem.d

/*
 * This file is part of duit.
 *
 * duit is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * duit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with duit; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = gtk-Stock-Items.html
 * outPack = gtk
 * outFile = StockItem
 * strct   = GtkStockItem
 * realStrct=
 * ctorStrct=
 * clss    = StockItem
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 *      - gtk_stock_
 *      - gtk_
 * omit structs:
 * omit prefixes:
 * omit code:
 * imports:
 *      - glib.Str
 *      - gtk.StockItem
 *      - glib.ListSG
 * structWrap:
 *      - GSList* -> ListSG
 *      - GtkStockItem* -> StockItem
 * local aliases:
 */

module gtk.StockItem;

private import gtk.gtktypes;

private import lib.gtk;

private import glib.Str;
private import gtk.StockItem;
private import glib.ListSG;

/**
 * Description
 * 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. Stock icons may have a RTL variant which gets
 * used for right-to-left locales.
 */
public class StockItem
{
        
        /** the main Gtk struct */
        protected GtkStockItem* gtkStockItem;
        
        
        public GtkStockItem* getStockItemStruct()
        {
                return gtkStockItem;
        }
        
        
        /** the main Gtk struct as a void* */
        protected void* getStruct()
        {
                return cast(void*)gtkStockItem;
        }
        
        /**
         * Sets our main struct and passes it to the parent class
         */
        public this (GtkStockItem* gtkStockItem)
        {
                this.gtkStockItem = gtkStockItem;
        }
        
        /**
         */
        
        
        /**
         * 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
         */
        public void add(uint nItems)
        {
                // void gtk_stock_add (const GtkStockItem *items,  guint n_items);
                gtk_stock_add(gtkStockItem, nItems);
        }
        
        /**
         * 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
         */
        public void addStatic(uint nItems)
        {
                // void gtk_stock_add_static (const GtkStockItem *items,  guint n_items);
                gtk_stock_add_static(gtkStockItem, nItems);
        }
        
        /**
         * Copies a stock item, mostly useful for language bindings and not in applications.
         * item:
         *  a GtkStockItem
         * Returns:
         *  a new GtkStockItem
         */
        public StockItem itemCopy()
        {
                // GtkStockItem* gtk_stock_item_copy (const GtkStockItem *item);
                return new StockItem( gtk_stock_item_copy(gtkStockItem) );
        }
        
        /**
         * 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
         */
        public void itemFree()
        {
                // void gtk_stock_item_free (GtkStockItem *item);
                gtk_stock_item_free(gtkStockItem);
        }
        
        /**
         * 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
         */
        public static ListSG listIds()
        {
                // GSList* gtk_stock_list_ids (void);
                return new ListSG( gtk_stock_list_ids() );
        }
        
        /**
         * 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
         */
        public static int lookup(char[] stockId, StockItem item)
        {
                // gboolean gtk_stock_lookup (const gchar *stock_id,  GtkStockItem *item);
                return gtk_stock_lookup(Str.toStringz(stockId), (item is null) ? null : item.getStockItemStruct());
        }
        
        /**
         * Sets a function to be used for translating the label of
         * a stock item.
         * If no function is registered for a translation domain,
         * dgettext() is used.
         * domain:
         *  the translation domain for which func shall be used
         * func:
         *  a GtkTranslateFunc
         * data:
         *  data to pass to func
         * notify:
         *  a GtkDestroyNotify that is called when data is
         *  no longer needed
         * Since 2.8
         */
        public static void setTranslateFunc(char[] domain, GtkTranslateFunc func, void* data, GtkDestroyNotify notify)
        {
                // void gtk_stock_set_translate_func (const gchar *domain,  GtkTranslateFunc func,  gpointer data,  GtkDestroyNotify notify);
                gtk_stock_set_translate_func(Str.toStringz(domain), func, data, notify);
        }
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
}