src/client-api/src/include/common/vocl/vCard/TypedProperty.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 #ifndef INCL_PIM_TYPED_PROPERTY
  38 #define INCL_PIM_TYPED_PROPERTY
  39 /** @cond DEV */
  40
  41 #include "base/util/ArrayElement.h"
  42 #include "vocl/vCard/vCardProperty.h"
  43 #include "base/globalsdef.h"
  44
  45 BEGIN_NAMESPACE
  46
  47 /**
  48  * An association between a property and a string representing the property type.
  49  *
  50  */
  51
  52 class TypedProperty : public ArrayElement {
  53     // ------------------------------------------------------------ Private data
  54
  55     protected:
  56         vCardProperty* p;
  57         WCHAR*  t;
  58
  59     // -------------------------------------------- Constructors and Destructors
  60     public:
  61
  62         /**
  63          * Creates an empty TypedProperty
  64          */
  65         TypedProperty();
  66         virtual ~TypedProperty();
  67
  68     // ---------------------------------------------------------- Public methods
  69
  70         /**
  71          * Returns the property
  72          *
  73          * @return this property content
  74          */
  75         vCardProperty* getProperty();
  76
  77         /**
  78          * Sets the property content. The given Property is cloned, so that the
  79          * caller can independently release it as needed.
  80          */
  81         void setProperty(vCardProperty& p);
  82
  83         /**
  84          * Returns the property type
  85          *
  86          * @param buf if not NULL, the value is copied in this buffer
  87          * @param size buffer size
  88          *
  89          * @return the property type for this property
  90          */
  91         WCHAR* getType(WCHAR* buf = NULL, int size = -1);
  92
  93         /**
  94          * Sets the property type
  95          *
  96          * @param type the property type
  97          */
  98         void setType(WCHAR* type);
  99
 100         /**
 101          * Creates a new instance of TypedProperty from the content of this
 102          * object. The new instance is created the the C++ new operator and
 103          * must be removed with the C++ delete operator.
 104          */
 105         ArrayElement* clone() { return NULL;}; //FIXME
 106 };
 107
 108
 109 END_NAMESPACE
 110
 111 /** @endcond */
 112 #endif