Clipboard.h

/***********************************************************************
    filename:   CEGUIClipboard.h
    created:    28/5/2011
    author:     Martin Preisler

    purpose:    Defines the interface for the Clipboard static class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIClipboard_h_
#define _CEGUIClipboard_h_

#include "CEGUI/String.h"

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT NativeClipboardProvider :
    public AllocatedObject<NativeClipboardProvider>
{
public:
    virtual ~NativeClipboardProvider();

    virtual void sendToClipboard(const String& mimeType, void* buffer, size_t size) = 0;

    virtual void retrieveFromClipboard(String& mimeType, void*& buffer, size_t& size) = 0;
};

class CEGUIEXPORT Clipboard :
    public AllocatedObject<NativeClipboardProvider>
{
public:
    Clipboard();

    ~Clipboard();

    void setNativeProvider(NativeClipboardProvider* provider);

    NativeClipboardProvider* getNativeProvider() const;

    void setData(const String& mimeType, const void* buffer, size_t size);

    void getData(String& mimeType, const void*& buffer, size_t& size);

    void setText(const String& text);

    String getText();

private:
    String d_mimeType;
    // just implementation specific
    typedef char BufferElement;
    BufferElement* d_buffer;
    size_t d_bufferSize;

    NativeClipboardProvider* d_nativeProvider;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUIClipboard_h_