Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Clipboard.h
1 /***********************************************************************
2  filename: CEGUIClipboard.h
3  created: 28/5/2011
4  author: Martin Preisler
5 
6  purpose: Defines the interface for the Clipboard static class
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIClipboard_h_
31 #define _CEGUIClipboard_h_
32 
33 #include "CEGUI/String.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
43 
48 class CEGUIEXPORT NativeClipboardProvider :
49  public AllocatedObject<NativeClipboardProvider>
50 {
51 public:
52  virtual ~NativeClipboardProvider();
53 
57  virtual void sendToClipboard(const String& mimeType, void* buffer, size_t size) = 0;
58 
62  virtual void retrieveFromClipboard(String& mimeType, void*& buffer, size_t& size) = 0;
63 };
64 
83 class CEGUIEXPORT Clipboard :
84  public AllocatedObject<NativeClipboardProvider>
85 {
86 public:
90  Clipboard();
91 
95  ~Clipboard();
96 
104  void setNativeProvider(NativeClipboardProvider* provider);
105 
110  NativeClipboardProvider* getNativeProvider() const;
111 
119  void setData(const String& mimeType, const void* buffer, size_t size);
120 
130  void getData(String& mimeType, const void*& buffer, size_t& size);
131 
135  void setText(const String& text);
136 
140  String getText();
141 
142 private:
144  String d_mimeType;
145  // just implementation specific
146  typedef char BufferElement;
148  BufferElement* d_buffer;
150  size_t d_bufferSize;
151 
153  NativeClipboardProvider* d_nativeProvider;
154 };
155 
156 } // End of CEGUI namespace section
157 
158 #if defined(_MSC_VER)
159 # pragma warning(pop)
160 #endif
161 
162 #endif // end of guard _CEGUIClipboard_h_
163