1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _core.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13class wxDragImage : wxObject
14{
15    %Docstring
16        DragImage()
17        DragImage(image, cursor=NullCursor)
18        DragImage(image, cursor=NullCursor)
19        DragImage(text, cursor=NullCursor)
20        DragImage(treeCtrl, id)
21        DragImage(listCtrl, id)
22
23        This class is used when you wish to drag an object on the screen, and
24        a simple cursor is not enough.
25    %End
26    %TypeHeaderCode
27        #include <wx/dragimag.h>
28    %End
29
30public:
31    wxDragImage();
32    %PreMethodCode
33        if (!wxPyCheckForApp()) return NULL;
34    %End
35
36    wxDragImage(
37        const wxBitmap & image,
38        const wxCursor & cursor = wxNullCursor
39    );
40    %PreMethodCode
41        if (!wxPyCheckForApp()) return NULL;
42    %End
43
44    wxDragImage(
45        const wxIcon & image,
46        const wxCursor & cursor = wxNullCursor
47    );
48    %PreMethodCode
49        if (!wxPyCheckForApp()) return NULL;
50    %End
51
52    wxDragImage(
53        const wxString & text,
54        const wxCursor & cursor = wxNullCursor
55    );
56    %PreMethodCode
57        if (!wxPyCheckForApp()) return NULL;
58    %End
59
60    wxDragImage(
61        const wxTreeCtrl & treeCtrl,
62        wxTreeItemId & id
63    );
64    %PreMethodCode
65        if (!wxPyCheckForApp()) return NULL;
66    %End
67
68    wxDragImage(
69        const wxListCtrl & listCtrl,
70        long id
71    );
72    %PreMethodCode
73        if (!wxPyCheckForApp()) return NULL;
74    %End
75
76    bool BeginDrag(
77        const wxPoint & hotspot,
78        wxWindow * window,
79        bool fullScreen = false,
80        wxRect * rect = NULL
81    );
82    %Docstring
83        BeginDrag(hotspot, window, fullScreen=False, rect=None) -> bool
84        BeginDrag(hotspot, window, boundingWindow) -> bool
85
86        Start dragging the image, in a window or full screen.
87    %End
88
89    bool BeginDrag(
90        const wxPoint & hotspot,
91        wxWindow * window,
92        wxWindow * boundingWindow
93    );
94
95    bool EndDrag();
96    %Docstring
97        EndDrag() -> bool
98
99        Call this when the drag has finished.
100    %End
101
102    bool Hide();
103    %Docstring
104        Hide() -> bool
105
106        Hides the image.
107    %End
108
109    bool Move(
110        const wxPoint & pt
111    );
112    %Docstring
113        Move(pt) -> bool
114
115        Call this to move the image to a new position.
116    %End
117
118    bool Show();
119    %Docstring
120        Show() -> bool
121
122        Shows the image.
123    %End
124
125    private:
126        wxDragImage(const wxDragImage&);
127
128
129};  // end of class wxDragImage
130
131
132class wxGenericDragImage : wxObject
133{
134    %Docstring
135        GenericDragImage()
136        GenericDragImage(image, cursor=NullCursor)
137        GenericDragImage(image, cursor=NullCursor)
138        GenericDragImage(text, cursor=NullCursor)
139        GenericDragImage(treeCtrl, id)
140        GenericDragImage(listCtrl, id)
141
142        This class is used when you wish to drag an object on the screen, and
143        a simple cursor is not enough.
144    %End
145    %TypeHeaderCode
146        #include <wx/dragimag.h>
147    %End
148
149    %TypeHeaderCode
150        #include <wx/generic/dragimgg.h>
151    %End
152public:
153    wxGenericDragImage();
154    %PreMethodCode
155        if (!wxPyCheckForApp()) return NULL;
156    %End
157
158    wxGenericDragImage(
159        const wxBitmap & image,
160        const wxCursor & cursor = wxNullCursor
161    );
162    %PreMethodCode
163        if (!wxPyCheckForApp()) return NULL;
164    %End
165
166    wxGenericDragImage(
167        const wxIcon & image,
168        const wxCursor & cursor = wxNullCursor
169    );
170    %PreMethodCode
171        if (!wxPyCheckForApp()) return NULL;
172    %End
173
174    wxGenericDragImage(
175        const wxString & text,
176        const wxCursor & cursor = wxNullCursor
177    );
178    %PreMethodCode
179        if (!wxPyCheckForApp()) return NULL;
180    %End
181
182    wxGenericDragImage(
183        const wxTreeCtrl & treeCtrl,
184        wxTreeItemId & id
185    );
186    %PreMethodCode
187        if (!wxPyCheckForApp()) return NULL;
188    %End
189
190    wxGenericDragImage(
191        const wxListCtrl & listCtrl,
192        long id
193    );
194    %PreMethodCode
195        if (!wxPyCheckForApp()) return NULL;
196    %End
197
198    bool BeginDrag(
199        const wxPoint & hotspot,
200        wxWindow * window,
201        bool fullScreen = false,
202        wxRect * rect = NULL
203    );
204    %Docstring
205        BeginDrag(hotspot, window, fullScreen=False, rect=None) -> bool
206        BeginDrag(hotspot, window, boundingWindow) -> bool
207
208        Start dragging the image, in a window or full screen.
209    %End
210
211    bool BeginDrag(
212        const wxPoint & hotspot,
213        wxWindow * window,
214        wxWindow * boundingWindow
215    );
216
217    virtual
218    bool DoDrawImage(
219        wxDC & dc,
220        const wxPoint & pos
221    ) const;
222    %Docstring
223        DoDrawImage(dc, pos) -> bool
224
225        Draws the image on the device context with top-left corner at the
226        given position.
227    %End
228
229    bool EndDrag();
230    %Docstring
231        EndDrag() -> bool
232
233        Call this when the drag has finished.
234    %End
235
236    virtual
237    wxRect GetImageRect(
238        const wxPoint & pos
239    ) const;
240    %Docstring
241        GetImageRect(pos) -> Rect
242
243        Returns the rectangle enclosing the image, assuming that the image is
244        drawn with its top-left corner at the given point.
245    %End
246
247    bool Hide();
248    %Docstring
249        Hide() -> bool
250
251        Hides the image.
252    %End
253
254    bool Move(
255        const wxPoint & pt
256    );
257    %Docstring
258        Move(pt) -> bool
259
260        Call this to move the image to a new position.
261    %End
262
263    bool Show();
264    %Docstring
265        Show() -> bool
266
267        Shows the image.
268    %End
269
270    virtual
271    bool UpdateBackingFromWindow(
272        wxDC & windowDC,
273        wxMemoryDC & destDC,
274        const wxRect & sourceRect,
275        const wxRect & destRect
276    ) const;
277    %Docstring
278        UpdateBackingFromWindow(windowDC, destDC, sourceRect, destRect) -> bool
279
280        Override this if you wish to draw the window contents to the backing
281        bitmap yourself.
282    %End
283
284    private:
285        wxGenericDragImage(const wxGenericDragImage&);
286
287
288};  // end of class wxGenericDragImage
289
290
291
292//---------------------------------------------------------------------------
293
294