kabc Library API Documentation

field.h

00001 /*
00002     This file is part of libkabc.
00003     Copyright (c) 2002 Cornelius Schumacher <schumacher@kde.org>
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public License
00016     along with this library; see the file COPYING.LIB.  If not, write to
00017     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018     Boston, MA 02111-1307, USA.
00019 */
00020 
00021 #ifndef KABC_FIELD_H
00022 #define KABC_FIELD_H
00023 
00024 #include <qstring.h>
00025 #include <qvaluelist.h>
00026 
00027 #include "addressee.h"
00028 
00029 class KConfig;
00030 
00031 namespace KABC {
00032 
00033 class Field
00034 {
00035   class FieldImpl;
00036   friend class FieldImpl;
00037 
00038 public:
00039   typedef QValueList<Field *> List;
00040 
00050   enum FieldCategory
00051   {
00052     All = 0x0,
00053     Frequent = 0x01,
00054     Address = 0x02,
00055     Email = 0x04,
00056     Personal = 0x08,
00057     Organization = 0x10,
00058     CustomCategory = 0x20
00059   };
00060 
00064   virtual QString label();
00065 
00069   virtual int category();
00070 
00074   static QString categoryLabel( int category );
00075 
00081   virtual QString value( const KABC::Addressee & );
00082 
00087   virtual bool setValue( KABC::Addressee &, const QString & );
00088 
00092   virtual bool isCustom();
00093 
00097   virtual bool equals( Field *field );
00098 
00102   static Field::List allFields();
00103 
00107   static Field::List defaultFields();
00108 
00117   static Field *createCustomField( const QString &label, int category,
00118                                    const QString &key, const QString &app );
00119 
00123   static void deleteFields();
00124 
00132   static void saveFields( KConfig *cfg, const QString &identifier,
00133                           const Field::List &fields );
00138   static void saveFields( const QString &identifier,
00139                           const Field::List &fields );
00140 
00147   static Field::List restoreFields( KConfig *cfg, const QString &identifier );
00148 
00153   static Field::List restoreFields( const QString &identifier );
00154 
00155 protected:
00156   static void createField( int id, int category = 0 );
00157   static void createDefaultField( int id, int category = 0 );
00158 
00159 private:
00160   Field( FieldImpl * );
00161   virtual ~Field();
00162 
00163   FieldImpl *mImpl;
00164 
00165   static Field::List mAllFields;
00166   static Field::List mDefaultFields;
00167   static Field::List mCustomFields;
00168 };
00169 
00170 }
00171 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 27 22:16:07 2005 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001