]> git.saurik.com Git - wxWidgets.git/blame - include/wx/clipbrd.h
remove the badle defined and apparently unnecessary wxSocketImpl::m_detected field
[wxWidgets.git] / include / wx / clipbrd.h
CommitLineData
e1ee679c
VZ
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/clipbrd.h
3// Purpose: wxClipboad class and clipboard functions
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 19.10.99
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) wxWidgets Team
65571936 9// Licence: wxWindows licence
e1ee679c
VZ
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_CLIPBRD_H_BASE_
13#define _WX_CLIPBRD_H_BASE_
c801d85f 14
e1ee679c
VZ
15#include "wx/defs.h"
16
17#if wxUSE_CLIPBOARD
18
b068c4e8 19
01fc4932 20#include "wx/event.h"
e3f6cbd9 21#include "wx/chartype.h"
c220de0b 22#include "wx/vector.h"
e1ee679c 23
b5dbe15d
VS
24class WXDLLIMPEXP_FWD_CORE wxDataFormat;
25class WXDLLIMPEXP_FWD_CORE wxDataObject;
26class WXDLLIMPEXP_FWD_CORE wxClipboard;
e1ee679c
VZ
27
28// ----------------------------------------------------------------------------
29// wxClipboard represents the system clipboard. Normally, you should use
30// wxTheClipboard which is a global pointer to the (unique) clipboard.
31//
32// Clipboard can be used to copy data to/paste data from. It works together
33// with wxDataObject.
34// ----------------------------------------------------------------------------
35
53a2db12 36class WXDLLIMPEXP_CORE wxClipboardBase : public wxObject
e1ee679c
VZ
37{
38public:
9005f2ed 39 wxClipboardBase() { m_usePrimary = false; }
b068c4e8 40
e1ee679c 41 // open the clipboard before Add/SetData() and GetData()
b068c4e8 42 virtual bool Open() = 0;
e1ee679c
VZ
43
44 // close the clipboard after Add/SetData() and GetData()
b068c4e8 45 virtual void Close() = 0;
e1ee679c 46
f536e0f2
VZ
47 // query whether the clipboard is opened
48 virtual bool IsOpened() const = 0;
49
e1ee679c
VZ
50 // add to the clipboard data
51 //
52 // NB: the clipboard owns the pointer and will delete it, so data must be
53 // allocated on the heap
b068c4e8 54 virtual bool AddData( wxDataObject *data ) = 0;
e1ee679c
VZ
55
56 // set the clipboard data, this is the same as Clear() followed by
57 // AddData()
b068c4e8 58 virtual bool SetData( wxDataObject *data ) = 0;
e1ee679c
VZ
59
60 // ask if data in correct format is available
b068c4e8 61 virtual bool IsSupported( const wxDataFormat& format ) = 0;
e1ee679c 62
311c1be9
RR
63 // ask if data in correct format is available
64 virtual bool IsSupportedAsync( wxEvtHandler *sink );
65
e1ee679c 66 // fill data with data on the clipboard (if available)
b068c4e8 67 virtual bool GetData( wxDataObject& data ) = 0;
68379eaf 68
e1ee679c 69 // clears wxTheClipboard and the system's clipboard if possible
b068c4e8 70 virtual void Clear() = 0;
e1ee679c
VZ
71
72 // flushes the clipboard: this means that the data which is currently on
73 // clipboard will stay available even after the application exits (possibly
74 // eating memory), otherwise the clipboard will be emptied on exit
68379eaf 75 virtual bool Flush() { return false; }
e1ee679c 76
9005f2ed
VZ
77 // this allows to choose whether we work with CLIPBOARD (default) or
78 // PRIMARY selection on X11-based systems
79 //
80 // on the other ones, working with primary selection does nothing: this
81 // allows to write code which sets the primary selection when something is
82 // selected without any ill effects (i.e. without overwriting the
83 // clipboard which would be wrong on the platforms without X11 PRIMARY)
84 virtual void UsePrimarySelection(bool usePrimary = false)
85 {
86 m_usePrimary = usePrimary;
87 }
88
89 // return true if we're using primary selection
90 bool IsUsingPrimarySelection() const { return m_usePrimary; }
e1ee679c 91
5dc43d1f
VS
92 // Returns global instance (wxTheClipboard) of the object:
93 static wxClipboard *Get();
9005f2ed
VZ
94
95
96 // don't use this directly, it is public for compatibility with some ports
97 // (wxX11, wxMotif, ...) only
98 bool m_usePrimary;
e1ee679c
VZ
99};
100
c220de0b
RR
101// ----------------------------------------------------------------------------
102// asynchronous clipboard event
103// ----------------------------------------------------------------------------
104
105class WXDLLIMPEXP_CORE wxClipboardEvent : public wxEvent
106{
107public:
108 wxClipboardEvent(wxEventType commandType = wxEVT_NULL)
109 : wxEvent(0,commandType)
110 { }
111
112 wxClipboardEvent(const wxClipboardEvent& event)
113 : wxEvent(event),
114 m_formats(event.m_formats)
115 { }
116
117 bool SupportsFormat( const wxDataFormat &format ) const;
118 void AddFormat( const wxDataFormat &format );
119
120 virtual wxEvent *Clone() const { return new wxClipboardEvent(*this); }
121
122protected:
123 wxVector<wxDataFormat> m_formats;
124
125private:
126 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardEvent)
127};
128
129extern WXDLLIMPEXP_CORE const wxEventType wxEVT_CLIPBOARD_CHANGED;
130
131typedef void (wxEvtHandler::*wxClipboardEventFunction)(wxClipboardEvent&);
132
133#define wxClipboardEventHandler(func) \
134 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardEventFunction, &func)
135
136#define EVT_CLIPBOARD_CHANGED(func) wx__DECLARE_EVT0(wxEVT_CLIPBOARD_CHANGED, wxClipboardEventHandler(func))
137
5dc43d1f
VS
138// ----------------------------------------------------------------------------
139// globals
140// ----------------------------------------------------------------------------
141
142// The global clipboard object - backward compatible access macro:
143#define wxTheClipboard (wxClipboard::Get())
144
e1ee679c
VZ
145// ----------------------------------------------------------------------------
146// include platform-specific class declaration
147// ----------------------------------------------------------------------------
148
2049ba38 149#if defined(__WXMSW__)
e1ee679c 150 #include "wx/msw/clipbrd.h"
2049ba38 151#elif defined(__WXMOTIF__)
e1ee679c 152 #include "wx/motif/clipbrd.h"
1be7a35c 153#elif defined(__WXGTK20__)
e1ee679c 154 #include "wx/gtk/clipbrd.h"
1be7a35c
MR
155#elif defined(__WXGTK__)
156 #include "wx/gtk1/clipbrd.h"
83df96d6
JS
157#elif defined(__WXX11__)
158 #include "wx/x11/clipbrd.h"
1e6feb95
VZ
159#elif defined(__WXMGL__)
160 #include "wx/mgl/clipbrd.h"
34138703 161#elif defined(__WXMAC__)
ef0e9220 162 #include "wx/osx/clipbrd.h"
aa3d0277
DE
163#elif defined(__WXCOCOA__)
164 #include "wx/cocoa/clipbrd.h"
1777b9bb 165#elif defined(__WXPM__)
e1ee679c 166 #include "wx/os2/clipbrd.h"
c801d85f
KB
167#endif
168
f536e0f2
VZ
169// ----------------------------------------------------------------------------
170// helpful class for opening the clipboard and automatically closing it
171// ----------------------------------------------------------------------------
172
53a2db12 173class WXDLLIMPEXP_CORE wxClipboardLocker
f536e0f2
VZ
174{
175public:
176 wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL)
177 {
178 m_clipboard = clipboard ? clipboard : wxTheClipboard;
179 if ( m_clipboard )
180 {
181 m_clipboard->Open();
182 }
183 }
184
ffd56fbc 185 bool operator!() const { return !m_clipboard->IsOpened(); }
f536e0f2
VZ
186
187 ~wxClipboardLocker()
188 {
189 if ( m_clipboard )
190 {
191 m_clipboard->Close();
192 }
193 }
194
195private:
196 wxClipboard *m_clipboard;
22f3361e
VZ
197
198 DECLARE_NO_COPY_CLASS(wxClipboardLocker)
f536e0f2
VZ
199};
200
e1ee679c
VZ
201#endif // wxUSE_CLIPBOARD
202
203#endif // _WX_CLIPBRD_H_BASE_