IClipboard.h

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2012 Bolton Software Ltd.
 * Copyright (C) 2002 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file COPYING that should have accompanied this file.
 * 
 * This package 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 General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ICLIPBOARD_H
#define ICLIPBOARD_H

#include "IInterface.h"
#include "CString.h"
#include "BasicTypes.h"


class IClipboard : public IInterface {
public:

    typedef UInt32 Time;


    enum EFormat {
        kText,          
        kBitmap,        
        kHTML,          
        kNumFormats     
    };




    virtual bool        empty() = 0;


    virtual void        add(EFormat, const CString& data) = 0;





    virtual bool        open(Time time) const = 0;


    virtual void        close() const = 0;


    virtual Time        getTime() const = 0;


    virtual bool        has(EFormat) const = 0;


    virtual CString     get(EFormat) const = 0;


    static CString      marshall(const IClipboard* clipboard);


    static void         unmarshall(IClipboard* clipboard,
                            const CString& data, Time time);


    static bool         copy(IClipboard* dst, const IClipboard* src);


    static bool         copy(IClipboard* dst, const IClipboard* src, Time);


private:
    static UInt32       readUInt32(const char*);
    static void         writeUInt32(CString*, UInt32);
};

#endif