src/client-api/src/include/common/vocl/vCard/Title.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36
  37 //
  38 // @author Stefano Fornari @ Funambol
  39 // @version $Id: Title.h,v 1.7 2008-04-11 08:17:13 marco_garatti Exp $
  40 //
  41
  42
  43 #ifndef INCL_PIM_TITLE
  44 #define INCL_PIM_TITLE
  45 /** @cond DEV */
  46
  47 #include "vocl/vCard/TypedProperty.h"
  48 #include "base/globalsdef.h"
  49
  50 BEGIN_NAMESPACE
  51
  52 /**
  53  * An object representing a contact title.
  54  */
  55 class Title : public TypedProperty {
  56     // ------------------------------------------------------------ Private data
  57
  58     // -------------------------------------------- Constructors and Destructors
  59     public:
  60
  61         /**
  62          * Creates an empty telephone number
  63          */
  64         Title();
  65         ~Title();
  66
  67     // -------------------------------------------- Constructors and Destructors
  68
  69         /**
  70          * Returns the title content
  71          *
  72          * @return the title content
  73          */
  74         vCardProperty* getTitle();
  75
  76         /**
  77          * Sets the title. The given Property is cloned, so that the
  78          * caller can independently release it as needed.
  79          */
  80         void setTitle(vCardProperty& p);
  81
  82         /**
  83          * Creates a new instance of TypedProperty from the content of this
  84          * object. The new instance is created the the C++ new operator and
  85          * must be removed with the C++ delete operator.
  86          */
  87         ArrayElement* clone() ; //FIXME
  88 };
  89
  90
  91 END_NAMESPACE
  92
  93 /** @endcond */
  94 #endif