Source: stdaddressbook.h

/*
    This file is part of libkabc.
    Copyright (c) 2001 Cornelius Schumacher 

    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; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/

#ifndef KABC_STDADDRESSBOOK_H
#define KABC_STDADDRESSBOOK_H

#include "addressbook.h"

namespace KABC {

/**
  Standard KDE address book
 
  This class provides access to the standard KDE address book shared by all
  applications.
 
  It's implemented as a singleton. Use @ref self() to get the address book
  object.
  
  Example:
 
  
  KABC::AddressBook *ab = KABC::StdAddressBook::self();
 
  if ( !ab->load() ) {
    // error
  }
 
  KABC::AddressBook::Iterator it;
  for ( it = ab->begin(); it != ab->end(); ++it ) {
    kdDebug() << "UID=" << (*it).uid() << endl;
 
    // do some other stuff
  }
 
  KABC::StdAddressBook::save();
  
*/
class StdAddressBook : public AddressBook
{
  public:
    /**
      Return the standard addressbook object.
    */
    static AddressBook *self();

    /**
      This is the same as above, but with specified
      behaviour of resource loading.

      @param onlyFastResource Only resources marked as 'fast' should be loaded
    */
    static AddressBook *self( bool onlyFastResources );

    /**
      Save the standard address book to disk.
    */
    static bool save();

    /**
      Returns the default file name for vcard-based addressbook
    */
    static QString fileName();

    /**
      Returns the default directory name for vcard-based addressbook
    */
    static QString directoryName();
    
    /**
      Set the automatic save property of the address book.
      If @p enable is TRUE (default) the address book is saved at
      destruction time otherwise you have to call @ref save() to
      explicitely save it.
     */
    static void setAutomaticSave( bool enable );

    /**
      Closes the address book. Depending on @ref automaticSave() it will
      save the address book first.
    */
    static void close();

    /**
      Returns whether the address book is saved at destruction time.
      See also @ref setAutomaticSave().
     */
    static bool automaticSave();

  protected:
    StdAddressBook();
    StdAddressBook( bool onlyFastResources );
    ~StdAddressBook();

    void init( bool onlyFastResources );

  private:
    static AddressBook *mSelf;
    static bool mAutomaticSave;
};

}
#endif