/usr/include/cegui-0.8.4/CEGUI/Clipboard.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | /***********************************************************************
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
{
/*!
\brief
Lightweight interface providing access to the system-wide native clipboard
*/
class CEGUIEXPORT NativeClipboardProvider :
public AllocatedObject<NativeClipboardProvider>
{
public:
virtual ~NativeClipboardProvider();
/*!
\brief sends given data to native clipboard
*/
virtual void sendToClipboard(const String& mimeType, void* buffer, size_t size) = 0;
/*!
\brief retrieves given data from native clipboard
*/
virtual void retrieveFromClipboard(String& mimeType, void*& buffer, size_t& size) = 0;
};
/*!
\brief
Defines a clipboard handling class
\par
Usually, there is just one instance of this class, owned by CEGUI::System,
it contains internal CEGUI clipboard that may be (optionally) synchronised
with native clipboard if user sets NativeClipboardProvider with:
\code
CEGUI::System::getSingleton()->getClipboard()->setNativeProvider(customProvider)
\endcode
Where customProvider is of course user implemented clipboard provider.
\internal
We may provide native clipboard providers automatically for some platforms
in the future, however for X11 this is really hard and would introduce
dependency -lX11 to CEGUIBase which is something we would really hate.
*/
class CEGUIEXPORT Clipboard :
public AllocatedObject<NativeClipboardProvider>
{
public:
/*!
\brief constructor
*/
Clipboard();
/*!
\brief destructor
*/
~Clipboard();
/*!
\brief sets native clipboard provider
\param provider the native clipboard provider to set
\see NativeClipboardProvider
You are required to deallocate given provider, this class doesn't take ownership!)
*/
void setNativeProvider(NativeClipboardProvider* provider);
/*!
\brief retrieves currently set native clipboard provider
\see NativeClipboardProvider
*/
NativeClipboardProvider* getNativeProvider() const;
/*!
\brief sets contents of this clipboard to given raw data
\param mimeType describes type of the data in the clipboard
\param buffer raw buffer containing data to push into the clipboard
\param size size (in bytes) of given data
*/
void setData(const String& mimeType, const void* buffer, size_t size);
/*!
\brief retrieves contents of this clipboard as raw data
\param mimeType current mime type
\param buffer the raw data buffer (can be 0 if size == 0!)
\param size size of the returned buffer
You shan't change the buffer contents, only read from it!
*/
void getData(String& mimeType, const void*& buffer, size_t& size);
/*!
\brief convenience method that sets contents to given string
*/
void setText(const String& text);
/*!
\brief convenience method that retrieves contents as a string
*/
String getText();
private:
/// mime type of the current content
String d_mimeType;
// just implementation specific
typedef char BufferElement;
/// raw data buffer containing current clipboard contents
BufferElement* d_buffer;
/// size (in bytes) of the raw buffer
size_t d_bufferSize;
/// native clipboard provider if any
NativeClipboardProvider* d_nativeProvider;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIClipboard_h_
|