kaddressbook/contactfields.h

   1 /*
   2     This file is part of KAddressBook.
   3
   4     Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License along
  17     with this program; if not, write to the Free Software Foundation, Inc.,
  18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19 */
  20
  21 #ifndef CONTACTFIELDS_H
  22 #define CONTACTFIELDS_H
  23
  24 #include <kabc/addressee.h>
  25
  26 class ContactFields
  27 {
  28   public:
  29
  30     /**
  31      * Describes the standard fields that are available for every contact
  32      */
  33     enum Field {
  34       Undefined = 0,
  35
  36       FormattedName,
  37       Prefix,
  38       GivenName,
  39       AdditionalName,
  40       FamilyName,
  41       Suffix,
  42       NickName,
  43
  44       Birthday,
  45       Anniversary,
  46
  47       HomeAddressStreet,
  48       HomeAddressPostOfficeBox,
  49       HomeAddressLocality,
  50       HomeAddressRegion,
  51       HomeAddressPostalCode,
  52       HomeAddressCountry,
  53       HomeAddressLabel,
  54
  55       BusinessAddressStreet,
  56       BusinessAddressPostOfficeBox,
  57       BusinessAddressLocality,
  58       BusinessAddressRegion,
  59       BusinessAddressPostalCode,
  60       BusinessAddressCountry,
  61       BusinessAddressLabel,
  62
  63       HomePhone,
  64       BusinessPhone,
  65       MobilePhone,
  66       HomeFax,
  67       BusinessFax,
  68       CarPhone,
  69       Isdn,
  70       Pager,
  71
  72       PreferredEmail,
  73       Email2,
  74       Email3,
  75       Email4,
  76
  77       Mailer,
  78       Title,
  79       Role,
  80       Organization,
  81       Note,
  82       Homepage,
  83
  84       BlogFeed,
  85       Profession,
  86       Office,
  87       Manager,
  88       Assistant,
  89       Spouse
  90     };
  91
  92     /**
  93      * Defines a list of Field enums.
  94      */
  95     typedef QVector<Field> Fields;
  96
  97     /**
  98      * Returns the i18n label for the @p field.
  99      */
 100     static QString label( Field field );
 101
 102     /**
 103      * Returns a list of all available fields.
 104      */
 105     static Fields allFields();
 106
 107     /**
 108      * Sets the @p value of the @p field for the @p contact.
 109      */
 110     static void setValue( Field field, const QString &value, KABC::Addressee &contact );
 111
 112     /**
 113      * Returns the value for the @p field of the @p contact.
 114      */
 115     static QString value( Field field, const KABC::Addressee &contact );
 116 };
 117
 118 #endif