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 QString sortKey( const KABC::Addressee & ); 00093 00097 virtual bool isCustom(); 00098 00102 virtual bool equals( Field *field ); 00103 00107 static Field::List allFields(); 00108 00112 static Field::List defaultFields(); 00113 00122 static Field *createCustomField( const QString &label, int category, 00123 const QString &key, const QString &app ); 00124 00128 static void deleteFields(); 00129 00137 static void saveFields( KConfig *cfg, const QString &identifier, 00138 const Field::List &fields ); 00143 static void saveFields( const QString &identifier, 00144 const Field::List &fields ); 00145 00152 static Field::List restoreFields( KConfig *cfg, const QString &identifier ); 00153 00158 static Field::List restoreFields( const QString &identifier ); 00159 00160 protected: 00161 static void createField( int id, int category = 0 ); 00162 static void createDefaultField( int id, int category = 0 ); 00163 00164 private: 00165 Field( FieldImpl * ); 00166 virtual ~Field(); 00167 00168 FieldImpl *mImpl; 00169 00170 static Field::List mAllFields; 00171 static Field::List mDefaultFields; 00172 static Field::List mCustomFields; 00173 }; 00174 00175 } 00176 #endif
KDE Logo
This file is part of the documentation for kabc Library Version 3.3.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 17 11:33:00 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003