git.maemo.org Git - modest/blob - src/modest-signal-mgr.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_SIGNAL_MGR_H__
  31 #define __MODEST_SIGNAL_MGR_H__
  32
  33 #include <glib-object.h>
  34
  35 G_BEGIN_DECLS
  36
  37 /**
  38  * modest_signal_mgr_connect:
  39  *
  40  * do a g_signal_connect, and add the handler data to the list
  41  * @lst: a GSList
  42  *
  43  * TRUE if this succeeded, FALSE otherwise.
  44  */
  45 GSList *  modest_signal_mgr_connect               (GSList *lst,
  46                                                    GObject *instance,
  47                                                    const gchar *signal_name,
  48                                                    GCallback handler,
  49                                                    gpointer data);
  50
  51 /**
  52  * modest_signal_mgr_disconnect:
  53  * @list:
  54  * @instance:
  55  *
  56  * disconnect the handler for a particular object for a particular signal
  57  *
  58  * Returns:
  59  **/
  60 GSList *  modest_signal_mgr_disconnect            (GSList *list,
  61                                                    GObject *instance,
  62                                                    const gchar *signal_name);
  63
  64
  65 /**
  66  * modest_signal_mgr_disconnect_all_and_destroy:
  67  * @lst: the list of signal handlers
  68  *
  69  * disconnect all signals in the list, and destroy the list
  70  */
  71 void      modest_signal_mgr_disconnect_all_and_destroy (GSList *lst);
  72
  73 /**
  74  * modest_signal_mgr_disconnect:
  75  * @list:
  76  * @instance:
  77  *
  78  * disconnect the handler for a particular object for a particular signal
  79  *
  80  * Returns:
  81  **/
  82 gboolean  modest_signal_mgr_is_connected               (GSList *list,
  83                                                         GObject *instance,
  84                                                         const gchar *signal_name);
  85
  86
  87 G_END_DECLS
  88 #endif /*__MODEST_SIGNAL_MGR__*/