path: root/e-util/e-client-selector.h

/*
 * e-client-selector.h
 *
 * This program 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 of the License, or (at your option) version 3.
 *
 * This program 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 the program; if not, see <http://www.gnu.org/licenses/>
 *
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef E_CLIENT_SELECTOR_H
#define E_CLIENT_SELECTOR_H

#include <e-util/e-client-cache.h>
#include <e-util/e-source-selector.h>

/* Standard GObject macros */
#define E_TYPE_CLIENT_SELECTOR \
    (e_client_selector_get_type ())
#define E_CLIENT_SELECTOR(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_CLIENT_SELECTOR, EClientSelector))
#define E_CLIENT_SELECTOR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_CLIENT_SELECTOR, EClientSelectorClass))
#define E_IS_CLIENT_SELECTOR(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_CLIENT_SELECTOR))
#define E_IS_CLIENT_SELECTOR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_CLIENT_SELECTOR))
#define E_CLIENT_SELECTOR_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_CLIENT_SELECTOR, EClientSelectorClass))

G_BEGIN_DECLS

typedef struct _EClientSelector EClientSelector;
typedef struct _EClientSelectorClass EClientSelectorClass;
typedef struct _EClientSelectorPrivate EClientSelectorPrivate;

struct _EClientSelector {
    ESourceSelector parent;
    EClientSelectorPrivate *priv;
};

struct _EClientSelectorClass {
    ESourceSelectorClass parent_class;
};

GType       e_client_selector_get_type  (void) G_GNUC_CONST;
GtkWidget * e_client_selector_new       (EClientCache *client_cache,
                         const gchar *extension_name);
EClientCache *  e_client_selector_ref_client_cache
                        (EClientSelector *selector);
EClient *   e_client_selector_get_client_sync
                        (EClientSelector *selector,
                         ESource *source,
                         GCancellable *cancellable,
                         GError **error);
void        e_client_selector_get_client    (EClientSelector *selector,
                         ESource *source,
                         GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data);
EClient *   e_client_selector_get_client_finish
                        (EClientSelector *selector,
                         GAsyncResult *result,
                         GError **error);
EClient *   e_client_selector_ref_cached_client
                        (EClientSelector *selector,
                         ESource *source);
EClient *   e_client_selector_ref_cached_client_by_iter
                        (EClientSelector *selector,
                         GtkTreeIter *iter);
gboolean    e_client_selector_is_backend_dead
                        (EClientSelector *selector,
                         ESource *source);

G_END_DECLS

#endif /* E_CLIENT_SELECTOR_H */