/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIImportABDescriptor.idl
 */

#ifndef __gen_nsIImportABDescriptor_h__
#define __gen_nsIImportABDescriptor_h__


#ifndef __gen_nsISupports_h__
#include "nsISupports.h"
#endif

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class nsIFile; /* forward declaration */


/* starting interface:    nsIImportABDescriptor */
#define NS_IIMPORTABDESCRIPTOR_IID_STR "2d8983b2-cea6-4ae2-9145-eb772481fa18"

#define NS_IIMPORTABDESCRIPTOR_IID \
  {0x2d8983b2, 0xcea6, 0x4ae2, \
    { 0x91, 0x45, 0xeb, 0x77, 0x24, 0x81, 0xfa, 0x18 }}

/**
 * Implementation Note:
 *
 * The default implementation can be obtained from
 * nsIImportService::CreateNewABDescriptor();
 *
 * You should only be interested in using this class if you implement
 * the nsIImportAddressBooks interface in which case, just using the service to
 * create new ones should work fine for you.  If not, implement your
 * own.
 */
class NS_NO_VTABLE NS_SCRIPTABLE nsIImportABDescriptor : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IIMPORTABDESCRIPTOR_IID)

  /**
   *  use the following 2 attributes however you'd like to
   * refer to a specific address book
   */
  /* attribute unsigned long identifier; */
  NS_SCRIPTABLE NS_IMETHOD GetIdentifier(PRUint32 *aIdentifier) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetIdentifier(PRUint32 aIdentifier) = 0;

  /* attribute unsigned long ref; */
  NS_SCRIPTABLE NS_IMETHOD GetRef(PRUint32 *aRef) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetRef(PRUint32 aRef) = 0;

  /**
   * Doesn't have to be accurate, this is merely used to report progress.
   * If you're importing a file, using file size and reporting progress
   * as the number of bytes processed so far makes sense.  For other formats
   * returning the number of records may make more sense.
   */
  /* attribute unsigned long size; */
  NS_SCRIPTABLE NS_IMETHOD GetSize(PRUint32 *aSize) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetSize(PRUint32 aSize) = 0;

  /**
   * The preferred name for this address book.  Depending upon how the
   * user selected import, the caller of the nsIImportAddressBooks interface
   * may use this name to create the destination address book or it may
   * ignore it.  However, this must be provided in all cases as it is
   * also displayed in the UI to the user.
   */
  /* attribute AString preferredName; */
  NS_SCRIPTABLE NS_IMETHOD GetPreferredName(nsAString & aPreferredName) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetPreferredName(const nsAString & aPreferredName) = 0;

  /**
   * For address books that want a file descriptor to locate the address book.
   * For formats that do not, use identifier & ref to refer to the address book
   * OR implement your own nsIImportABDescriptor that contains additional data
   * necessary to identify specific address books,
   */
  /* attribute nsIFile abFile; */
  NS_SCRIPTABLE NS_IMETHOD GetAbFile(nsIFile **aAbFile) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetAbFile(nsIFile *aAbFile) = 0;

  /**
   * Set by the UI to indicate whether or not this address book should be imported.
   */
  /* attribute boolean import; */
  NS_SCRIPTABLE NS_IMETHOD GetImport(PRBool *aImport) = 0;
  NS_SCRIPTABLE NS_IMETHOD SetImport(PRBool aImport) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsIImportABDescriptor, NS_IIMPORTABDESCRIPTOR_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIIMPORTABDESCRIPTOR \
  NS_SCRIPTABLE NS_IMETHOD GetIdentifier(PRUint32 *aIdentifier); \
  NS_SCRIPTABLE NS_IMETHOD SetIdentifier(PRUint32 aIdentifier); \
  NS_SCRIPTABLE NS_IMETHOD GetRef(PRUint32 *aRef); \
  NS_SCRIPTABLE NS_IMETHOD SetRef(PRUint32 aRef); \
  NS_SCRIPTABLE NS_IMETHOD GetSize(PRUint32 *aSize); \
  NS_SCRIPTABLE NS_IMETHOD SetSize(PRUint32 aSize); \
  NS_SCRIPTABLE NS_IMETHOD GetPreferredName(nsAString & aPreferredName); \
  NS_SCRIPTABLE NS_IMETHOD SetPreferredName(const nsAString & aPreferredName); \
  NS_SCRIPTABLE NS_IMETHOD GetAbFile(nsIFile **aAbFile); \
  NS_SCRIPTABLE NS_IMETHOD SetAbFile(nsIFile *aAbFile); \
  NS_SCRIPTABLE NS_IMETHOD GetImport(PRBool *aImport); \
  NS_SCRIPTABLE NS_IMETHOD SetImport(PRBool aImport); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIIMPORTABDESCRIPTOR(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetIdentifier(PRUint32 *aIdentifier) { return _to GetIdentifier(aIdentifier); } \
  NS_SCRIPTABLE NS_IMETHOD SetIdentifier(PRUint32 aIdentifier) { return _to SetIdentifier(aIdentifier); } \
  NS_SCRIPTABLE NS_IMETHOD GetRef(PRUint32 *aRef) { return _to GetRef(aRef); } \
  NS_SCRIPTABLE NS_IMETHOD SetRef(PRUint32 aRef) { return _to SetRef(aRef); } \
  NS_SCRIPTABLE NS_IMETHOD GetSize(PRUint32 *aSize) { return _to GetSize(aSize); } \
  NS_SCRIPTABLE NS_IMETHOD SetSize(PRUint32 aSize) { return _to SetSize(aSize); } \
  NS_SCRIPTABLE NS_IMETHOD GetPreferredName(nsAString & aPreferredName) { return _to GetPreferredName(aPreferredName); } \
  NS_SCRIPTABLE NS_IMETHOD SetPreferredName(const nsAString & aPreferredName) { return _to SetPreferredName(aPreferredName); } \
  NS_SCRIPTABLE NS_IMETHOD GetAbFile(nsIFile **aAbFile) { return _to GetAbFile(aAbFile); } \
  NS_SCRIPTABLE NS_IMETHOD SetAbFile(nsIFile *aAbFile) { return _to SetAbFile(aAbFile); } \
  NS_SCRIPTABLE NS_IMETHOD GetImport(PRBool *aImport) { return _to GetImport(aImport); } \
  NS_SCRIPTABLE NS_IMETHOD SetImport(PRBool aImport) { return _to SetImport(aImport); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIIMPORTABDESCRIPTOR(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetIdentifier(PRUint32 *aIdentifier) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIdentifier(aIdentifier); } \
  NS_SCRIPTABLE NS_IMETHOD SetIdentifier(PRUint32 aIdentifier) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetIdentifier(aIdentifier); } \
  NS_SCRIPTABLE NS_IMETHOD GetRef(PRUint32 *aRef) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRef(aRef); } \
  NS_SCRIPTABLE NS_IMETHOD SetRef(PRUint32 aRef) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetRef(aRef); } \
  NS_SCRIPTABLE NS_IMETHOD GetSize(PRUint32 *aSize) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSize(aSize); } \
  NS_SCRIPTABLE NS_IMETHOD SetSize(PRUint32 aSize) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetSize(aSize); } \
  NS_SCRIPTABLE NS_IMETHOD GetPreferredName(nsAString & aPreferredName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPreferredName(aPreferredName); } \
  NS_SCRIPTABLE NS_IMETHOD SetPreferredName(const nsAString & aPreferredName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetPreferredName(aPreferredName); } \
  NS_SCRIPTABLE NS_IMETHOD GetAbFile(nsIFile **aAbFile) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAbFile(aAbFile); } \
  NS_SCRIPTABLE NS_IMETHOD SetAbFile(nsIFile *aAbFile) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetAbFile(aAbFile); } \
  NS_SCRIPTABLE NS_IMETHOD GetImport(PRBool *aImport) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetImport(aImport); } \
  NS_SCRIPTABLE NS_IMETHOD SetImport(PRBool aImport) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetImport(aImport); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsImportABDescriptor : public nsIImportABDescriptor
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIIMPORTABDESCRIPTOR

  nsImportABDescriptor();

private:
  ~nsImportABDescriptor();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(nsImportABDescriptor, nsIImportABDescriptor)

nsImportABDescriptor::nsImportABDescriptor()
{
  /* member initializers and constructor code */
}

nsImportABDescriptor::~nsImportABDescriptor()
{
  /* destructor code */
}

/* attribute unsigned long identifier; */
NS_IMETHODIMP nsImportABDescriptor::GetIdentifier(PRUint32 *aIdentifier)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetIdentifier(PRUint32 aIdentifier)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute unsigned long ref; */
NS_IMETHODIMP nsImportABDescriptor::GetRef(PRUint32 *aRef)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetRef(PRUint32 aRef)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute unsigned long size; */
NS_IMETHODIMP nsImportABDescriptor::GetSize(PRUint32 *aSize)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetSize(PRUint32 aSize)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute AString preferredName; */
NS_IMETHODIMP nsImportABDescriptor::GetPreferredName(nsAString & aPreferredName)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetPreferredName(const nsAString & aPreferredName)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute nsIFile abFile; */
NS_IMETHODIMP nsImportABDescriptor::GetAbFile(nsIFile **aAbFile)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetAbFile(nsIFile *aAbFile)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute boolean import; */
NS_IMETHODIMP nsImportABDescriptor::GetImport(PRBool *aImport)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsImportABDescriptor::SetImport(PRBool aImport)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif


#endif /* __gen_nsIImportABDescriptor_h__ */
