Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added docstrings

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25939 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2004-02-25 00:42:30 +00:00
parent cf636c4555
commit 4c42683a5c
2 changed files with 320 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
wxPython/src/_cursor.i
View File

@@ -15,58 +15,167 @@
//---------------------------------------------------------------------------
DocStr(wxCursor,
"A cursor is a small bitmap usually used for denoting where the
mouse pointer is, with a picture that might indicate the
interpretation of a mouse click.
A single cursor object may be used in many windows (any subwindow
type). The wxWindows convention is to set the cursor for a
window, as in X, rather than to set it globally as in MS Windows,
although a global wx.SetCursor function is also available for use
on MS Windows.");
RefDoc(wxCursor::wxCursor(int id),
"
Stock Cursor IDs
wx.CURSOR_ARROW A standard arrow cursor.
wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right.
wx.CURSOR_BLANK Transparent cursor.
wx.CURSOR_BULLSEYE Bullseye cursor.
wx.CURSOR_CHAR Rectangular character cursor.
wx.CURSOR_CROSS A cross cursor.
wx.CURSOR_HAND A hand cursor.
wx.CURSOR_IBEAM An I-beam cursor (vertical line).
wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed.
wx.CURSOR_MAGNIFIER A magnifier icon.
wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed.
wx.CURSOR_NO_ENTRY A no-entry sign cursor.
wx.CURSOR_PAINT_BRUSH A paintbrush cursor.
wx.CURSOR_PENCIL A pencil cursor.
wx.CURSOR_POINT_LEFT A cursor that points left.
wx.CURSOR_POINT_RIGHT A cursor that points right.
wx.CURSOR_QUESTION_ARROW An arrow and question mark.
wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed.
wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW.
wx.CURSOR_SIZENS A sizing cursor pointing N-S.
wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE.
wx.CURSOR_SIZEWE A sizing cursor pointing W-E.
wx.CURSOR_SIZING A general sizing cursor.
wx.CURSOR_SPRAYCAN A spraycan cursor.
wx.CURSOR_WAIT A wait cursor.
wx.CURSOR_WATCH A watch cursor.
wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.)
");
class wxCursor : public wxGDIObject
{
public:
%extend {
wxCursor(const wxString* cursorName, long flags, int hotSpotX=0, int hotSpotY=0) {
#ifdef __WXGTK__
DocStr(wxCursor,
"Construct a Cursor from a file. Specify the type of file using\n"
"wx.BITAMP_TYPE* constants, and specify the hotspot if not using a\n"
".cur file.\n"
"\n"
"This cursor is not available on wxGTK, use wx.StockCursor,\n"
"wx.CursorFromImage, or wx.CursorFromBits instead.");
wxCursor(const wxString* cursorName, long type, int hotSpotX=0, int hotSpotY=0) {
%#ifdef __WXGTK__
wxCHECK_MSG(False, NULL,
wxT("wxCursor constructor not implemented for wxGTK, use wxStockCursor, wxCursorFromImage, or wxCursorFromBits instead."));
#else
wxT("wx.Cursor constructor not implemented for wxGTK, use wx.StockCursor, wx.CursorFromImage, or wx.CursorFromBits instead."));
%#else
return new wxCursor(*cursorName, flags, hotSpotX, hotSpotY);
#endif
%#endif
}
}
~wxCursor();
// alternate constructors
%name(StockCursor) wxCursor(int id);
%name(CursorFromImage) wxCursor(const wxImage& image);
%extend {
%name(CursorFromBits) wxCursor(PyObject* bits, int width, int height,
int hotSpotX=-1, int hotSpotY=-1,
PyObject* maskBits=0) {
char* bitsbuf;
char* maskbuf = NULL;
int length;
PyString_AsStringAndSize(bits, &bitsbuf, &length);
if (maskBits)
PyString_AsStringAndSize(maskBits, &maskbuf, &length);
return new wxCursor(bitsbuf, width, height, hotSpotX, hotSpotY, maskbuf);
}
}
DocCtorStrName(
wxCursor(int id),
"Create a cursor using one of the stock cursors. Note that not\n"
"all cursors are available on all platforms.",
StockCursor);
// wxGDIImage methods
#ifdef __WXMSW__
long GetHandle();
void SetHandle(long handle);
#endif
DocCtorStrName(
wxCursor(const wxImage& image),
"Constructs a cursor from a wxImage. The cursor is monochrome,\n"
"colors with the RGB elements all greater than 127 will be\n"
"foreground, colors less than this background. The mask (if any)\n"
"will be used as transparent.\n"
"\n"
"In MSW the foreground will be white and the background black. The\n"
"cursor is resized to 32x32 In GTK, the two most frequent colors\n"
"will be used for foreground and background. The cursor will be\n"
"displayed at the size of the image. On MacOS the cursor is\n"
"resized to 16x16 and currently only shown as black/white (mask\n"
"respected).",
CursorFromImage);
// %extend {
// DocStr(wxCursor,
// "");
// %name(CursorFromBits) wxCursor(PyObject* bits, int width, int height,
// int hotSpotX=-1, int hotSpotY=-1,
// PyObject* maskBits=NULL) {
// char* bitsbuf;
// char* maskbuf = NULL;
// int length;
// PyString_AsStringAndSize(bits, &bitsbuf, &length);
// if (maskBits)
// PyString_AsStringAndSize(maskBits, &maskbuf, &length);
// return new wxCursor(bitsbuf, width, height, hotSpotX, hotSpotY, maskbuf);
// }
// }
bool Ok();
#ifdef __WXMSW__
int GetWidth();
int GetHeight();
int GetDepth();
void SetWidth(int w);
void SetHeight(int h);
void SetDepth(int d);
void SetSize(const wxSize& size);
DocDeclStr(
long , GetHandle(),
"Get the MS Windows handle for the cursor");
DocDeclStr(
void , SetHandle(long handle),
"Set the MS WIndows handle for the cursor");
#endif
DocDeclStr(
bool , Ok(),
"");
%pythoncode { def __nonzero__(self): return self.Ok() }
#ifdef __WXMSW__
DocDeclStr(
int , GetWidth(),
"");
DocDeclStr(
int , GetHeight(),
"");
DocDeclStr(
int , GetDepth(),
"");
DocDeclStr(
void , SetWidth(int w),
"");
DocDeclStr(
void , SetHeight(int h),
"");
DocDeclStr(
void , SetDepth(int d),
"");
DocDeclStr(
void , SetSize(const wxSize& size),
"");
#endif
};