/usr/include/wx-3.0/wx/wxPython/i_files/_clipbrd.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-4.
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | /////////////////////////////////////////////////////////////////////////////
// Name: _clipbrd.i
// Purpose: SWIG definitions for the Clipboard
//
// Author: Robin Dunn
//
// Created: 31-October-1999
// RCS-ID: $Id$
// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%newgroup
%{
%}
MustHaveApp(wxClipboard);
MustHaveApp(wxClipboard::Get);
DocStr(wxClipboard,
"wx.Clipboard represents the system clipboard and provides methods to
copy data to it or paste data from it. Normally, you should only use
``wx.TheClipboard`` which is a reference to a global wx.Clipboard
instance.
Call ``wx.TheClipboard``'s `Open` method to get ownership of the
clipboard. If this operation returns True, you now own the
clipboard. Call `SetData` to put data on the clipboard, or `GetData`
to retrieve data from the clipboard. Call `Close` to close the
clipboard and relinquish ownership. You should keep the clipboard open
only momentarily.
:see: `wx.DataObject`
", "");
class wxClipboard : public wxObject {
public:
DocCtorStr(
wxClipboard(),
"", "");
~wxClipboard();
DocDeclStr(
virtual bool , Open(),
"Call this function to open the clipboard before calling SetData and
GetData. Call Close when you have finished with the clipboard. You
should keep the clipboard open for only a very short time. Returns
True on success.", "");
DocDeclStr(
virtual void , Close(),
"Closes the clipboard.", "");
DocDeclStr(
virtual bool , IsOpened() const,
"Query whether the clipboard is opened", "");
%disownarg( wxDataObject *data );
DocDeclStr(
virtual bool , AddData( wxDataObject *data ),
"Call this function to add the data object to the clipboard. You may
call this function repeatedly after having cleared the clipboard.
After this function has been called, the clipboard owns the data, so
do not delete the data explicitly.
:see: `wx.DataObject`", "");
DocDeclStr(
virtual bool , SetData( wxDataObject *data ),
"Set the clipboard data, this is the same as `Clear` followed by
`AddData`.
:see: `wx.DataObject`", "");
%cleardisown( wxDataObject *data );
DocDeclStr(
virtual bool , IsSupported( const wxDataFormat& format ),
"Returns True if the given format is available in the data object(s) on
the clipboard.", "");
virtual bool IsSupportedAsync( wxEvtHandler *sink );
DocDeclStr(
virtual bool , GetData( wxDataObject& data ),
"Call this function to fill data with data on the clipboard, if
available in the required format. Returns true on success.", "");
DocDeclStr(
virtual void , Clear(),
"Clears data from the clipboard object and also the system's clipboard
if possible.", "");
DocDeclStr(
virtual bool , Flush(),
"Flushes the clipboard: this means that the data which is currently on
clipboard will stay available even after the application exits,
possibly eating memory, otherwise the clipboard will be emptied on
exit. Returns False if the operation is unsuccesful for any reason.", "");
DocDeclStr(
virtual void , UsePrimarySelection( bool primary = true ),
"On platforms supporting it (the X11 based platforms), selects the so
called PRIMARY SELECTION as the clipboard as opposed to the normal
clipboard, if primary is True. On other platforms all clipboard
operations fail when using the primary selection. This allows code
supporting the primary selection to be written without ill effects on
the other platforms.", "");
DocDeclStr(
bool , IsUsingPrimarySelection() const,
"Return true if we're using primary selection", "");
DocDeclStr(
static wxClipboard *, Get(),
"Returns global instance (wxTheClipboard) of the object.", "");
// for the 'with' statement
%pythoncode {
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.Close()
}
};
// Previously we just declared wxTheClipboard as a global, but in C++
// is has been changed to be a macro for wxClipboard::Get, but the
// swig generated code will try to evaluate it when it assigns to the
// swig wrapper var so this causes Get to be called too early on
// wxGTK. So instead we'll create a Python class that can delay the
// Get until it is really needed, which is similar in effect to what
// is really happening on the C++ side too.
%pythoncode {
class _wxPyDelayedInitWrapper(object):
def __init__(self, initfunc, *args, **kwargs):
self._initfunc = initfunc
self._args = args
self._kwargs = kwargs
self._instance = None
def _checkInstance(self):
if self._instance is None:
if wx.GetApp():
self._instance = self._initfunc(*self._args, **self._kwargs)
def __getattr__(self, name):
self._checkInstance()
return getattr(self._instance, name)
def __repr__(self):
self._checkInstance()
return repr(self._instance)
TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
}
//---------------------------------------------------------------------------
DocStr(wxClipboardLocker,
"A helpful class for opening the clipboard and automatically
closing it when the locker is destroyed.", "");
class wxClipboardLocker
{
public:
wxClipboardLocker(wxClipboard *clipboard = NULL);
~wxClipboardLocker();
DocStr(__nonzero__,
"A ClipboardLocker instance evaluates to True if the clipboard was
successfully opened.", "");
%extend {
bool __nonzero__() { return !!(*self); }
}
};
//---------------------------------------------------------------------------
class wxClipboardEvent : public wxEvent
{
public:
wxClipboardEvent(wxEventType evtType = wxEVT_NULL);
//wxClipboardEvent(const wxClipboardEvent& event);
bool SupportsFormat(const wxDataFormat& format) const;
void AddFormat(const wxDataFormat& format);
};
%constant wxEventType wxEVT_CLIPBOARD_CHANGED;
%pythoncode {
EVT_CLIPBOARD_CHANGED = wx.PyEventBinder( wxEVT_CLIPBOARD_CHANGED )
}
//---------------------------------------------------------------------------
|