libedataserver/e-proxy.h

   1 /*
   2  * This program is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU Lesser General Public
   4  * License as published by the Free Software Foundation; either
   5  * version 2 of the License, or (at your option) version 3.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  * Lesser General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU Lesser General Public
  13  * License along with the program; if not, see <http://www.gnu.org/licenses/>
  14  *
  15  *
  16  * Authors:
  17  *              Jeffrey Stedfast <fejj@ximian.com>
  18  *              Veerapuram Varadhan <vvaradhan@novell.com>
  19  *
  20  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
  21  *
  22  */
  23
  24 #if !defined (__LIBEDATASERVER_H_INSIDE__) && !defined (LIBEDATASERVER_COMPILATION)
  25 #error "Only <libedataserver/libedataserver.h> should be included directly."
  26 #endif
  27
  28 #ifndef E_PROXY_H
  29 #define E_PROXY_H
  30
  31 #include <libsoup/soup-uri.h>
  32
  33 /* Standard GObject macros */
  34 #define E_TYPE_PROXY \
  35         (e_proxy_get_type ())
  36 #define E_PROXY(obj) \
  37         (G_TYPE_CHECK_INSTANCE_CAST \
  38         ((obj), E_TYPE_PROXY, EProxy))
  39 #define E_PROXY_CLASS(cls) \
  40         (G_TYPE_CHECK_CLASS_CAST \
  41         ((cls), E_TYPE_PROXY, EProxyClass))
  42 #define E_IS_PROXY(obj) \
  43         (G_TYPE_CHECK_INSTANCE_TYPE \
  44         ((obj), E_TYPE_PROXY))
  45 #define E_IS_PROXY_CLASS(cls) \
  46         (G_TYPE_CHECK_CLASS_TYPE \
  47         ((cls), E_TYPE_PROXY))
  48 #define E_PROXY_GET_CLASS(obj) \
  49         (G_TYPE_INSTANCE_GET_CLASS \
  50         ((obj), E_TYPE_PROXY, EProxyClass))
  51
  52 G_BEGIN_DECLS
  53
  54 typedef struct _EProxy EProxy;
  55 typedef struct _EProxyClass EProxyClass;
  56 typedef struct _EProxyPrivate EProxyPrivate;
  57
  58 /**
  59  * EProxy:
  60  *
  61  * Contains only private data that should be read and manipulated using the
  62  * function below.
  63  *
  64  * Since: 2.24
  65  **/
  66 struct _EProxy {
  67         GObject parent;
  68         EProxyPrivate *priv;
  69 };
  70
  71 struct _EProxyClass {
  72         GObjectClass parent_class;
  73
  74         /* Signals  */
  75         void (*changed) (EProxy *proxy);
  76 };
  77
  78 GType           e_proxy_get_type                (void) G_GNUC_CONST;
  79 EProxy *        e_proxy_new                     (void);
  80 void            e_proxy_setup_proxy             (EProxy *proxy);
  81 SoupURI *       e_proxy_peek_uri_for            (EProxy *proxy,
  82                                                  const gchar *uri);
  83 gboolean        e_proxy_require_proxy_for_uri   (EProxy *proxy,
  84                                                  const gchar *uri);
  85
  86 G_END_DECLS
  87
  88 #endif /* E_PROXY_H */