/*
 *  caja-info-provider.h - Interface for Caja extensions that
 *                             provide info about files.
 *
 *  Copyright (C) 2003 Novell, Inc.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  Author:  Dave Camp <dave@ximian.com>
 *
 */

/* This interface is implemented by Caja extensions that want to
 * provide information about files.  Extensions are called when Caja
 * needs information about a file.  They are passed a CajaFileInfo
 * object which should be filled with relevant information */

#ifndef CAJA_INFO_PROVIDER_H
#define CAJA_INFO_PROVIDER_H

#include <glib-object.h>
#include "caja-extension-types.h"
#include "caja-file-info.h"

#ifdef __cplusplus
extern "C" {
#endif

#define CAJA_TYPE_INFO_PROVIDER           (caja_info_provider_get_type ())
#define CAJA_INFO_PROVIDER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_INFO_PROVIDER, CajaInfoProvider))
#define CAJA_IS_INFO_PROVIDER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_INFO_PROVIDER))
#define CAJA_INFO_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), CAJA_TYPE_INFO_PROVIDER, CajaInfoProviderIface))

    typedef struct _CajaInfoProvider       CajaInfoProvider;
    typedef struct _CajaInfoProviderIface  CajaInfoProviderIface;

    typedef void (*CajaInfoProviderUpdateComplete) (CajaInfoProvider    *provider,
            CajaOperationHandle *handle,
            CajaOperationResult  result,
            gpointer                 user_data);

    struct _CajaInfoProviderIface
    {
        GTypeInterface g_iface;

        CajaOperationResult (*update_file_info) (CajaInfoProvider     *provider,
                CajaFileInfo         *file,
                GClosure                 *update_complete,
                CajaOperationHandle **handle);
        void                    (*cancel_update)    (CajaInfoProvider     *provider,
                CajaOperationHandle  *handle);
    };

    /* Interface Functions */
    GType                   caja_info_provider_get_type               (void);
    CajaOperationResult caja_info_provider_update_file_info       (CajaInfoProvider     *provider,
            CajaFileInfo         *file,
            GClosure                 *update_complete,
            CajaOperationHandle **handle);
    void                    caja_info_provider_cancel_update          (CajaInfoProvider     *provider,
            CajaOperationHandle  *handle);



    /* Helper functions for implementations */
    void                    caja_info_provider_update_complete_invoke (GClosure                 *update_complete,
            CajaInfoProvider     *provider,
            CajaOperationHandle  *handle,
            CajaOperationResult   result);

#ifdef __cplusplus
}
#endif

#endif
