00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 00037 // 00038 // @author Stefano Fornari @ Funambol 00039 // @version $Id: vCardProperty.h,v 1.8 2008-04-11 08:17:13 marco_garatti Exp $ 00040 // 00041 #include <string.h> 00042 00043 #ifndef INCL_PIM_PROPERTY 00044 #define INCL_PIM_PROPERTY 00045 /** @cond DEV */ 00046 00047 #include "base/fscapi.h" 00048 #include "base/globalsdef.h" 00049 00050 BEGIN_NAMESPACE 00051 00052 /** 00053 * This object represents a property for VCard and ICalendar object 00054 * (i.e. its value and its parameters) 00055 */ 00056 class vCardProperty { 00057 00058 // ------------------------------------------------------------ Private data 00059 00060 private: 00061 WCHAR* encoding ; 00062 WCHAR* language ; 00063 WCHAR* value ; 00064 WCHAR* chrset ; 00065 00066 /** 00067 * Sets internal members releasing the currently allocated memory (if 00068 * any was allocate). The passed value is duplicated so that the caller 00069 * can independently release it. 00070 * 00071 * @param property the address of the pointer to set to the new 00072 * allocated memory 00073 * @param v the value to set into the property 00074 */ 00075 void set(WCHAR** property, WCHAR* v); 00076 00077 // -------------------------------------------- Constructors and Destructors 00078 public: 00079 /** 00080 * Creates property without parameters but with the specified value 00081 */ 00082 vCardProperty (WCHAR* v = NULL); 00083 00084 ~vCardProperty(); 00085 00086 // ---------------------------------------------------------- Public methods 00087 00088 /** 00089 * Returns the encoding parameter of this property 00090 * 00091 * @param buf if not NULL, the value is copied in this buffer 00092 * @param size buffer size 00093 * 00094 * @return the encoding parameter of this property 00095 */ 00096 WCHAR* getEncoding (WCHAR* buf = NULL, int size = -1); 00097 00098 /** 00099 * Returns the language parameter of this property 00100 * 00101 * @param buf if not NULL, the value is copied in this buffer 00102 * @param size buffer size 00103 * 00104 * @return the language parameter of this property 00105 */ 00106 WCHAR* getLanguage (WCHAR* buf = NULL, int size = -1); 00107 00108 /** 00109 * Returns the value parameter of this property 00110 * 00111 * @param buf if not NULL, the value is copied in this buffer 00112 * @param size buffer size 00113 * 00114 * @return the value parameter of this property 00115 */ 00116 WCHAR* getValue (WCHAR* buf = NULL, int size = -1); 00117 00118 /** 00119 * Returns the charset parameter of this property 00120 * 00121 * @param buf if not NULL, the value is copied in this buffer 00122 * @param size buffer size 00123 * 00124 * @return the charset parameter of this property 00125 */ 00126 WCHAR* getCharset (WCHAR* buf = NULL, int size = -1); 00127 00128 /** 00129 * Sets the encoding parameter of this property 00130 * 00131 * @param encoding the encoding to set 00132 */ 00133 void setEncoding (WCHAR* encoding); 00134 00135 /** 00136 * Sets the language parameter of this property 00137 * 00138 * @param language the language to set 00139 */ 00140 void setLanguage (WCHAR* language); 00141 00142 /** 00143 * Sets the value parameter of this property 00144 * 00145 * @param value the value to set 00146 */ 00147 void setValue (WCHAR* value); 00148 00149 /** 00150 * Sets the charset parameter of this property 00151 * 00152 * @param chrset the charset to set 00153 */ 00154 void setCharset (WCHAR* chrset); 00155 00156 00157 /** 00158 * Creates and returns a new Property object. The object is created with 00159 * the C++ new operator and must be deallocated with the delete C++ 00160 * operator 00161 */ 00162 vCardProperty* clone(); 00163 }; 00164 00165 00166 END_NAMESPACE 00167 00168 /** @endcond */ 00169 #endif