1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/clipboard.h
3 // Purpose: wxClipboard for wxGTK
4 // Author: Robert Roebling, Vadim Zeitlin
6 // Copyright: (c) 1998 Robert Roebling
7 // (c) 2007 Vadim Zeitlin
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 #ifndef _WX_GTK_CLIPBOARD_H_
12 #define _WX_GTK_CLIPBOARD_H_
14 // ----------------------------------------------------------------------------
16 // ----------------------------------------------------------------------------
18 class WXDLLIMPEXP_CORE wxClipboard
: public wxClipboardBase
21 // there are several clipboards in X11 (and in GDK)
29 virtual ~wxClipboard();
31 // open the clipboard before SetData() and GetData()
34 // close the clipboard after SetData() and GetData()
37 // query whether the clipboard is opened
38 virtual bool IsOpened() const;
40 // set the clipboard data. all other formats will be deleted.
41 virtual bool SetData( wxDataObject
*data
);
43 // add to the clipboard data.
44 virtual bool AddData( wxDataObject
*data
);
46 // ask if data in correct format is available
47 virtual bool IsSupported( const wxDataFormat
& format
);
49 // fill data with data on the clipboard (if available)
50 virtual bool GetData( wxDataObject
& data
);
52 // clears wxTheClipboard and the system's clipboard if possible
55 // If primary == TRUE, use primary selection in all further ops,
56 // primary == FALSE resets it.
57 virtual void UsePrimarySelection(bool primary
= TRUE
)
58 { m_usePrimary
= primary
; }
61 // implementation from now on
62 // --------------------------
64 // get our clipboard item (depending on m_usePrimary value)
65 GdkAtom
GTKGetClipboardAtom() const;
67 // get the data object currently being used
68 wxDataObject
*GTKGetDataObject() { return Data(); }
70 // clear the data for the given clipboard kind
71 void GTKClearData(Kind kind
);
73 // called when selection data is received
74 void GTKOnSelectionReceived(const GtkSelectionData
& sel
);
76 // called when available target information is received
77 bool GTKOnTargetReceived(const wxDataFormat
& format
);
80 // the data object we're currently using
81 wxDataObject
*& Data()
83 return m_usePrimary
? m_dataPrimary
: m_dataClipboard
;
86 // set or unset selection ownership
87 bool SetSelectionOwner(bool set
= true);
89 // add atom to the list of supported targets
90 void AddSupportedTarget(GdkAtom atom
);
92 // check if the given format is supported
93 bool DoIsSupported(const wxDataFormat
& format
);
96 // both of these pointers can be non-NULL simultaneously but we only use
97 // one of them at any moment depending on m_usePrimary value, use Data()
98 // (from inside) or GTKGetDataObject() (from outside) accessors
99 wxDataObject
*m_dataPrimary
,
102 // this is used to temporarily hold the object passed to our GetData() so
103 // that GTK callbacks could access it
104 wxDataObject
*m_receivedData
;
106 // used to pass information about the format we need from DoIsSupported()
107 // to GTKOnTargetReceived()
108 GdkAtom m_targetRequested
;
110 GtkWidget
*m_clipboardWidget
; // for getting and offering data
111 GtkWidget
*m_targetsWidget
; // for getting list of supported formats
115 bool m_formatSupported
;
118 DECLARE_DYNAMIC_CLASS(wxClipboard
)
121 #endif // _WX_GTK_CLIPBOARD_H_