alternative to assert

[gtkD.git] / src / gtk / Timeout.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  = 
 * outPack = gtk
 * outFile = Timeout
 * strct   = 
 * realStrct=
 * ctorStrct=
 * clss    = Timeout
 * interf  = 
 * class Code: Yes
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 *      - gtk_timeout_
 * omit structs:
 * omit prefixes:
 * omit code:
 * imports:
 * structWrap:
 * local aliases:
 */

module gtk.Timeout;

private import gtk.gtktypes;

private import lib.gtk;


/**
 * Description
 * Before using GTK+, you need to initialize it; initialization connects
 * to the window system display, and parses some standard command line
 * arguments. The gtk_init() function initializes GTK+. gtk_init() exits
 * the application if errors occur; to avoid this, use gtk_init_check().
 * gtk_init_check() allows you to recover from a failed GTK+
 * initialization - you might start up your application in text mode instead.
 * Like all GUI toolkits, GTK+ uses an event-driven programming
 * model. When the user is doing nothing, GTK+ sits in the
 * main loop and waits for input. If the user
 * performs some action - say, a mouse click - then the main loop "wakes
 * up" and delivers an event to GTK+. GTK+ forwards the event to one or
 * more widgets.
 * When widgets receive an event, they frequently emit one or more
 * signals. Signals notify your program that
 * "something interesting happened" by invoking functions you've
 * connected to the signal with g_signal_connect(). Functions connected
 * to a signal are often termed callbacks.
 * When your callbacks are invoked, you would typically take some action
 * - for example, when an Open button is clicked you might display a
 * GtkFileSelectionDialog. After a callback finishes, GTK+ will return
 * to the main loop and await more user input.
 * Example1.Typical main function for a GTK+ application
 * int
 * main (int argc, char **argv)
 * {
         *  /+* Initialize i18n support +/
         *  gtk_set_locale ();
         *  /+* Initialize the widget set +/
         *  gtk_init (argc, argv);
         *  /+* Create the main window +/
         *  mainwin = gtk_window_new (GTK_WINDOW_TOPLEVEL);
         *  /+* Set up our GUI elements +/
         *  ...
         *  /+* Show the application window +/
         *  gtk_widget_show_all (mainwin);
         *  /+* Enter the main event loop, and wait for user interaction +/
         *  gtk_main ();
         *  /+* The user lost interest +/
         *  return 0;
 * }
 * It's OK to use the GLib main loop directly instead of gtk_main(),
 * though it involves slightly more typing. See GMainLoop in the GLib
 * documentation.
 */
public class Timeout
{
        
        /** Holds all timeout delegates */
        bit delegate()[] timeoutListeners;
        /** our gtk timeout ID */
        uint timeoutID;
        
        
        /**
         * Creates a new timeout cycle.
         * Params:
         *      interval =      the timeout in milieconds
         *      delegate() =    the delegate to be executed
         *      fireNow =       When true the delegate will be executed emmidiatly
         * Returns:
         */
        this(uint interval, bit delegate() dlg, bit fireNow=false)
        {
                timeoutListeners ~= dlg;
                timeoutID = gtk_timeout_add(interval, cast(GtkFunction)&timeoutCallback, this);
                if ( fireNow )
                {
                        if ( !dlg() )
                        {
                                timeoutListeners.length = 0;
                        }
                }
        }
        
        public void stop()
        {
                if ( timeoutID > 0 )
                {
                        gtk_timeout_remove(timeoutID);
                }
                timeoutListeners.length = 0;
        }
        
        /**
         * Removes the timeout from gtk
         * Returns:
         */
        ~this()
        {
                stop();
        }
        
        /**
         * Adds a new delegate to this timeout cycle
         * Params:
         *      delegate() =
         *      fireNow =
         */
        public void addListener(bit delegate() dlg, bit fireNow=false)
        {
                timeoutListeners ~= dlg;
                if ( fireNow )
                {
                        if ( !dlg() )
                        {
                                timeoutListeners.length = timeoutListeners.length - 1;
                        }
                }
        }
        
        /**
         * The callback execution from glib
         * Params:
         *      timeout =
         * Returns:
         */
        extern(C) static bit timeoutCallback(Timeout timeout)
        {
                return timeout.callAllListeners();
        }
        
        /**
         * Executes all delegates on the execution list
         * Returns:
         */
        private bit callAllListeners()
        {
                bit runAgain = false;
                
                int i = 0;
                
                while ( i<timeoutListeners.length )
                {
                        if ( !timeoutListeners[i]() )
                        {
                                timeoutListeners = timeoutListeners[0..i] ~ timeoutListeners[i+1..timeoutListeners.length];
                        }
                        else
                        {
                                runAgain = true;
                                ++i;
                        }
                }
                return runAgain;
        }
        
        /**
         */
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        /**
         * Warning
         * gtk_timeout_add_full has been deprecated since version 2.4 and should not be used in newly-written code. Use g_timeout_add_full() instead.
         * Registers a function to be called periodically. The function will be called
         * repeatedly after interval milliseconds until it returns FALSE at which
         * point the timeout is destroyed and will not be called again.
         * interval:
         * The time between calls to the function, in milliseconds
         *      (1/1000ths of a second.)
         * function:
         * The function to call periodically.
         * marshal:
         * The marshaller to use instead of the function (if non-NULL).
         * data:
         * The data to pass to the function.
         * destroy:
         * Function to call when the timeout is destroyed or NULL.
         * Returns:
         * A unique id for the event source.
         */
        public static uint addFull(uint interval, GtkFunction funct, GtkCallbackMarshal marshal, void* data, GtkDestroyNotify destroy)
        {
                // guint gtk_timeout_add_full (guint32 interval,  GtkFunction function,  GtkCallbackMarshal marshal,  gpointer data,  GtkDestroyNotify destroy);
                return gtk_timeout_add_full(interval, funct, marshal, data, destroy);
        }
        
        /**
         * Warning
         * gtk_timeout_add has been deprecated since version 2.4 and should not be used in newly-written code. Use g_timeout_add() instead.
         * Registers a function to be called periodically. The function will be called
         * repeatedly after interval milliseconds until it returns FALSE at which
         * point the timeout is destroyed and will not be called again.
         * interval:
         * The time between calls to the function, in milliseconds
         *      (1/1000ths of a second.)
         * function:
         * The function to call periodically.
         * data:
         * The data to pass to the function.
         * Returns:
         * A unique id for the event source.
         */
        public static uint add(uint interval, GtkFunction funct, void* data)
        {
                // guint gtk_timeout_add (guint32 interval,  GtkFunction function,  gpointer data);
                return gtk_timeout_add(interval, funct, data);
        }
        
        /**
         * Warning
         * gtk_timeout_remove has been deprecated since version 2.4 and should not be used in newly-written code. Use g_source_remove() instead.
         * Removes the given timeout destroying all information about it.
         * timeout_handler_id:
         * The identifier returned when installing the timeout.
         */
        public static void remove(uint timeoutHandlerId)
        {
                // void gtk_timeout_remove (guint timeout_handler_id);
                gtk_timeout_remove(timeoutHandlerId);
        }
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
}