winnote.h

来自「funambol window mobile客户端源代码」· C头文件 代码 · 共 111 行

/*
 * Funambol is a mobile platform developed by Funambol, Inc. 
 * Copyright (C) 2003 - 2007 Funambol, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission 
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License 
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
 * 305, Redwood City, CA 94063, USA, or at email address [e-mail].
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably 
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */

#ifndef INCL_WINNOTE
#define INCL_WINNOTE

/** @cond API */
/** @addtogroup win_adapter */
/** @{ */

#include "vocl/WinItem.h"
#include "vocl/constants.h"
#include "vocl/VObject.h"
#include "base/globalsdef.h"

BEGIN_NAMESPACE


/**
 * Rapresents a note object for Windows Clients.
 * The object can be filled passing a vNote, or filling
 * directly the map. Calling 'toString()' a vNote is formatted and returned.
 */
class WinNote : public WinItem {

private:

    /// Internal string formatted (VNOTE).
    wstring vNote;

    /**
     * Checks the productID and version of VObject passed for vNote.
     * - 'productID' MUST be "VNOTE"
     * - 'version' is only checked to be the one supported (log info if wrong)
     *
     * @param  vo         the VObject to check
     * @return            true if productID is correct
     */
    bool checkVNoteTypeAndVersion(VObject* vo);


public:

    /// Default Constructor
    WinNote();

    /// Constructor: fills propertyMap parsing the passed vNote string
    WinNote(const wstring dataString);

    /// Destructor
    ~WinNote();


    /**
     * Parse a vNote string and fills the propertyMap.
     * The map is cleared and will contain only found properties
     * at the end of the parsing.
     * @param dataString  input vNote string to be parsed
     * @return            0 if no errors
     */
    virtual int parse(const wstring dataString);

    /**
     * Format and return a vNote string from the propertyMap.
     * Not supported properties are ignored and so not formatted 
     * as they don't have a correspondence in propertyMap.
     * @return  the vNote string formatted, reference to internal wstring
     */
    virtual wstring& toString();
};



END_NAMESPACE

/** @} */
/** @endcond */
#endif