]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_cursor.i
Allow for Cmd-click on wxMac
[wxWidgets.git] / wxPython / src / _cursor.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _cursor.i
3// Purpose: SWIG interface for wxCursor
4//
5// Author: Robin Dunn
6//
7// Created: 7-July-1997
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
4c42683a
RD
18
19DocStr(wxCursor,
d07d2bc9
RD
20"A cursor is a small bitmap usually used for denoting where the mouse
21pointer is, with a picture that might indicate the interpretation of a
22mouse click.
4c42683a
RD
23
24A single cursor object may be used in many windows (any subwindow
d07d2bc9
RD
25type). The wxWindows convention is to set the cursor for a window, as
26in X, rather than to set it globally as in MS Windows, although a
27global `wx.SetCursor` function is also available for use on MS Windows.
28","
29
30Stock Cursor IDs
31-----------------
32 ======================== ======================================
4c42683a
RD
33 wx.CURSOR_ARROW A standard arrow cursor.
34 wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right.
35 wx.CURSOR_BLANK Transparent cursor.
36 wx.CURSOR_BULLSEYE Bullseye cursor.
37 wx.CURSOR_CHAR Rectangular character cursor.
38 wx.CURSOR_CROSS A cross cursor.
39 wx.CURSOR_HAND A hand cursor.
40 wx.CURSOR_IBEAM An I-beam cursor (vertical line).
41 wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed.
42 wx.CURSOR_MAGNIFIER A magnifier icon.
43 wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed.
44 wx.CURSOR_NO_ENTRY A no-entry sign cursor.
45 wx.CURSOR_PAINT_BRUSH A paintbrush cursor.
46 wx.CURSOR_PENCIL A pencil cursor.
47 wx.CURSOR_POINT_LEFT A cursor that points left.
48 wx.CURSOR_POINT_RIGHT A cursor that points right.
49 wx.CURSOR_QUESTION_ARROW An arrow and question mark.
50 wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed.
51 wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW.
52 wx.CURSOR_SIZENS A sizing cursor pointing N-S.
53 wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE.
54 wx.CURSOR_SIZEWE A sizing cursor pointing W-E.
55 wx.CURSOR_SIZING A general sizing cursor.
56 wx.CURSOR_SPRAYCAN A spraycan cursor.
57 wx.CURSOR_WAIT A wait cursor.
58 wx.CURSOR_WATCH A watch cursor.
59 wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.)
d07d2bc9 60 ======================== ======================================
4c42683a
RD
61
62");
63
ab1f7d2a
RD
64MustHaveApp(wxCursor);
65
d14a1e28
RD
66class wxCursor : public wxGDIObject
67{
68public:
4c42683a 69
d14a1e28 70 %extend {
4c42683a 71 DocStr(wxCursor,
d07d2bc9
RD
72 "Construct a Cursor from a file. Specify the type of file using
73wx.BITAMP_TYPE* constants, and specify the hotspot if not using a cur
74file.
75
76This constructor is not available on wxGTK, use ``wx.StockCursor``,
77``wx.CursorFromImage``, or ``wx.CursorFromBits`` instead.", "");
4c42683a
RD
78 wxCursor(const wxString* cursorName, long type, int hotSpotX=0, int hotSpotY=0) {
79%#ifdef __WXGTK__
dd9f7fea 80 wxCHECK_MSG(False, NULL,
4c42683a
RD
81 wxT("wx.Cursor constructor not implemented for wxGTK, use wx.StockCursor, wx.CursorFromImage, or wx.CursorFromBits instead."));
82%#else
1cee36ad 83 return new wxCursor(*cursorName, type, hotSpotX, hotSpotY);
4c42683a 84%#endif
d14a1e28
RD
85 }
86 }
87
88 ~wxCursor();
89
4c42683a
RD
90 DocCtorStrName(
91 wxCursor(int id),
d07d2bc9
RD
92 "Create a cursor using one of the stock cursors. Note that not all
93cursors are available on all platforms.", "",
4c42683a
RD
94 StockCursor);
95
96
97 DocCtorStrName(
98 wxCursor(const wxImage& image),
d07d2bc9
RD
99 "Constructs a cursor from a wxImage. The cursor is monochrome, colors
100with the RGB elements all greater than 127 will be foreground, colors
101less than this background. The mask (if any) will be used as
102transparent.",
103"
104In MSW the foreground will be white and the background
105black. The cursor is resized to 32x32.
106
107In GTK, the two most frequent colors will be used for foreground and
108background. The cursor will be displayed at the size of the image.
109
110On MacOS the cursor is resized to 16x16 and currently only shown as
111black/white (mask respected).",
4c42683a
RD
112 CursorFromImage);
113
114
115// %extend {
116// DocStr(wxCursor,
117// "");
118// %name(CursorFromBits) wxCursor(PyObject* bits, int width, int height,
119// int hotSpotX=-1, int hotSpotY=-1,
120// PyObject* maskBits=NULL) {
121// char* bitsbuf;
122// char* maskbuf = NULL;
123// int length;
124// PyString_AsStringAndSize(bits, &bitsbuf, &length);
125// if (maskBits)
126// PyString_AsStringAndSize(maskBits, &maskbuf, &length);
127// return new wxCursor(bitsbuf, width, height, hotSpotX, hotSpotY, maskbuf);
128// }
129// }
130
131
d14a1e28 132
d14a1e28 133#ifdef __WXMSW__
4c42683a
RD
134 DocDeclStr(
135 long , GetHandle(),
d07d2bc9 136 "Get the MS Windows handle for the cursor", "");
4c42683a 137
a0c956e8
RD
138 %extend {
139 DocStr(SetHandle,
d07d2bc9 140 "Set the MS Windows handle to use for the cursor", "");
a0c956e8
RD
141 void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }
142 }
4c42683a 143
d14a1e28
RD
144#endif
145
4c42683a
RD
146 DocDeclStr(
147 bool , Ok(),
d07d2bc9 148 "", "");
4c42683a
RD
149
150 %pythoncode { def __nonzero__(self): return self.Ok() }
151
d14a1e28
RD
152
153#ifdef __WXMSW__
4c42683a
RD
154 DocDeclStr(
155 int , GetWidth(),
d07d2bc9 156 "", "");
4c42683a
RD
157
158 DocDeclStr(
159 int , GetHeight(),
d07d2bc9 160 "", "");
4c42683a
RD
161
162 DocDeclStr(
163 int , GetDepth(),
d07d2bc9 164 "", "");
4c42683a
RD
165
166 DocDeclStr(
167 void , SetWidth(int w),
d07d2bc9 168 "", "");
4c42683a
RD
169
170 DocDeclStr(
171 void , SetHeight(int h),
d07d2bc9 172 "", "");
4c42683a
RD
173
174 DocDeclStr(
175 void , SetDepth(int d),
d07d2bc9 176 "", "");
4c42683a
RD
177
178 DocDeclStr(
179 void , SetSize(const wxSize& size),
d07d2bc9 180 "", "");
4c42683a 181
d14a1e28
RD
182#endif
183
d14a1e28
RD
184};
185
186
187//---------------------------------------------------------------------------
188//---------------------------------------------------------------------------