kaddressbookview.h

/*
    This file is part of KAddressBook.
    Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
    As a special exception, permission is given to link this program
    with any edition of TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/
 
#ifndef KADDRESSBOOKVIEW_H
#define KADDRESSBOOKVIEW_H
 
#define KAB_VIEW_PLUGIN_VERSION 1
 
#include <tqstringlist.h>
#include <tqwidget.h>
 
#include <tdeabc/field.h>
#include <klibloader.h>
#include <tdemacros.h>
 
#include "filter.h"
#include "viewconfigurewidget.h"
 
class TDEConfig;
class KXMLGUIClient;
 
class TQDropEvent;
 
namespace KAB { class Core; }
namespace TDEABC { class AddressBook; }

class TDE_EXPORT KAddressBookView : public TQWidget
{
  TQ_OBJECT
  
 
  public:
    enum DefaultFilterType { None = 0, Active = 1, Specific = 2 };
 
    KAddressBookView( KAB::Core *core, TQWidget *parent, const char *name );
    virtual ~KAddressBookView();

    virtual TQStringList selectedUids() = 0;

    virtual void readConfig( TDEConfig *config );

    // The TDEConfig object is unused so we do not document it
    // else doxygen will complain.
    virtual void writeConfig( TDEConfig * );

    virtual TQString selectedEmails();

    virtual TQString type() const = 0;

    TDEABC::Field::List fields() const;

    void setFilter( const Filter& );

    DefaultFilterType defaultFilterType() const;

    const TQString &defaultFilterName() const;

    KAB::Core *core() const;

    virtual TDEABC::Field *sortField() const = 0;
 
    virtual void scrollUp() = 0;
    virtual void scrollDown() = 0;
 
  public slots:
    virtual void refresh( const TQString &uid = TQString() ) = 0;

    virtual void setSelected( const TQString &uid = TQString(), bool selected = true ) = 0;

    virtual void setFirstSelected( bool selected = true ) = 0;

    void popup( const TQPoint &point );
 
  signals:
    void modified();

    void selected( const TQString &uid );

    void executed( const TQString &uid );

    void startDrag();

    void dropped( TQDropEvent* );

    void sortFieldChanged();

    void viewFieldsChanged();
 
  protected:
    TDEABC::Addressee::List addressees();

    TQWidget *viewWidget();
 
  private slots:
    void updateView();
 
  private:
    void initGUI();
 
    DefaultFilterType mDefaultFilterType;
    Filter mFilter;
    TQString mDefaultFilterName;
    KAB::Core *mCore;
    TDEABC::Field::List mFieldList;
 
    TQWidget *mViewWidget;
};
 
class TDE_EXPORT ViewFactory : public KLibFactory
{
  public:
    virtual KAddressBookView *view( KAB::Core *core, TQWidget *parent,
                                    const char *name = 0 ) = 0;
    virtual TQString type() const = 0;

    virtual TQString description() const = 0;

    virtual ViewConfigureWidget *configureWidget( TDEABC::AddressBook *ab,
                                                  TQWidget *parent,
                                                  const char *name = 0 );
 
  protected:
    virtual TQObject* createObject( TQObject*, const char*, const char*,
                                   const TQStringList & )
    {
      return 0;
    }
};
 
#endif