]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_clipbrd.i
warning fix
[wxWidgets.git] / wxPython / src / _clipbrd.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _clipbrd.i
3// Purpose: SWIG definitions for the Clipboard
4//
5// Author: Robin Dunn
6//
7// Created: 31-October-1999
8// RCS-ID: $Id$
9// Copyright: (c) 2003 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13// Not a %module
14
15
16//---------------------------------------------------------------------------
17%newgroup
18
19%{
20%}
21
fcafa8a9 22DocStr(wxClipboard,
dce2bd22
RD
23"wx.Clipboard represents the system clipboard and provides methods to
24copy data to it or paste data from it. Normally, you should only use
25``wx.TheClipboard`` which is a reference to a global wx.Clipboard
26instance.
27
28Call ``wx.TheClipboard``'s `Open` method to get ownership of the
29clipboard. If this operation returns True, you now own the
30clipboard. Call `SetData` to put data on the clipboard, or `GetData`
31to retrieve data from the clipboard. Call `Close` to close the
32clipboard and relinquish ownership. You should keep the clipboard open
33only momentarily.
34
35:see: `wx.DataObject`
d07d2bc9 36", "");
fcafa8a9 37
d14a1e28
RD
38
39
d14a1e28
RD
40class wxClipboard : public wxObject {
41public:
dce2bd22
RD
42 DocCtorStr(
43 wxClipboard(),
d07d2bc9 44 "", "");
fcafa8a9 45
d14a1e28
RD
46 ~wxClipboard();
47
d14a1e28 48
fcafa8a9
RD
49 DocDeclStr(
50 virtual bool , Open(),
dce2bd22
RD
51 "Call this function to open the clipboard before calling SetData and
52GetData. Call Close when you have finished with the clipboard. You
53should keep the clipboard open for only a very short time. Returns
d07d2bc9 54True on success.", "");
fcafa8a9
RD
55
56
57 DocDeclStr(
58 virtual void , Close(),
d07d2bc9 59 "Closes the clipboard.", "");
fcafa8a9 60
d14a1e28 61
fcafa8a9
RD
62 DocDeclStr(
63 virtual bool , IsOpened() const,
d07d2bc9 64 "Query whether the clipboard is opened", "");
fcafa8a9 65
d14a1e28 66
8668c242
RD
67
68 %apply SWIGTYPE *DISOWN { wxDataObject *data };
69
fcafa8a9
RD
70 DocDeclStr(
71 virtual bool , AddData( wxDataObject *data ),
dce2bd22
RD
72 "Call this function to add the data object to the clipboard. You may
73call this function repeatedly after having cleared the clipboard.
74After this function has been called, the clipboard owns the data, so
75do not delete the data explicitly.
76
d07d2bc9 77:see: `wx.DataObject`", "");
fcafa8a9 78
d14a1e28 79
fcafa8a9
RD
80 DocDeclStr(
81 virtual bool , SetData( wxDataObject *data ),
dce2bd22
RD
82 "Set the clipboard data, this is the same as `Clear` followed by
83`AddData`.
84
d07d2bc9 85:see: `wx.DataObject`", "");
fcafa8a9 86
d14a1e28 87
8668c242
RD
88 %clear wxDataObject *data;
89
fcafa8a9
RD
90 DocDeclStr(
91 virtual bool , IsSupported( const wxDataFormat& format ),
dce2bd22 92 "Returns True if the given format is available in the data object(s) on
d07d2bc9 93the clipboard.", "");
fcafa8a9
RD
94
95 DocDeclStr(
96 virtual bool , GetData( wxDataObject& data ),
dce2bd22 97 "Call this function to fill data with data on the clipboard, if
d07d2bc9 98available in the required format. Returns true on success.", "");
fcafa8a9
RD
99
100
101 DocDeclStr(
102 virtual void , Clear(),
dce2bd22 103 "Clears data from the clipboard object and also the system's clipboard
d07d2bc9 104if possible.", "");
d14a1e28 105
d14a1e28 106
fcafa8a9
RD
107 DocDeclStr(
108 virtual bool , Flush(),
dce2bd22
RD
109 "Flushes the clipboard: this means that the data which is currently on
110clipboard will stay available even after the application exits,
111possibly eating memory, otherwise the clipboard will be emptied on
d07d2bc9 112exit. Returns False if the operation is unsuccesful for any reason.", "");
fcafa8a9 113
d14a1e28 114
fcafa8a9 115 DocDeclStr(
a72f4631 116 virtual void , UsePrimarySelection( bool primary = true ),
dce2bd22
RD
117 "On platforms supporting it (the X11 based platforms), selects the
118so called PRIMARY SELECTION as the clipboard as opposed to the
d07d2bc9 119normal clipboard, if primary is True.", "");
d14a1e28
RD
120
121
fe5e444a
RD
122 DocDeclStr(
123 static wxClipboard *, Get(),
124 "Returns global instance (wxTheClipboard) of the object.", "");
125
126};
127
d14a1e28 128
fe5e444a
RD
129// Previously we just declared wxTheClipboard as a global, but in C++
130// is has been changed to be a macro for wxClipboard::Get, but the
131// swig generated code will try to evaluate it when it assigns to the
132// swig wrapper var so this causes Get to be called too early on
133// wxGTK. So instead we'll create a Python class that can delay the
134// Get until it is really needed, which is similar in effect to what
135// is really happening on the C++ side too.
136%pythoncode {
137 class _wxPyDelayedInitWrapper(object):
138 def __init__(self, initfunc, *args, **kwargs):
139 self._initfunc = initfunc
140 self._args = args
141 self._kwargs = kwargs
142 self._instance = None
143 def _checkInstance(self):
144 if self._instance is None:
145 self._instance = self._initfunc(*self._args, **self._kwargs)
146 def __getattr__(self, name):
147 self._checkInstance()
148 return getattr(self._instance, name)
149 def __repr__(self):
150 self._checkInstance()
151 return repr(self._instance)
152 TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
153}
d14a1e28
RD
154
155
156//---------------------------------------------------------------------------
157
158
fcafa8a9 159DocStr(wxClipboardLocker,
dce2bd22 160"A helpful class for opening the clipboard and automatically
d07d2bc9 161closing it when the locker is destroyed.", "");
fcafa8a9 162
d14a1e28
RD
163class wxClipboardLocker
164{
165public:
166 wxClipboardLocker(wxClipboard *clipboard = NULL);
167 ~wxClipboardLocker();
168
fcafa8a9 169 DocStr(__nonzero__,
dce2bd22 170 "A ClipboardLocker instance evaluates to True if the clipboard was
d07d2bc9 171successfully opened.", "");
d14a1e28
RD
172 %extend {
173 bool __nonzero__() { return !!(*self); }
174 }
175};
176
177
178//---------------------------------------------------------------------------