'[1219035] cleanup: miscellaneous' and minor source cleaning.

[wxWidgets.git] / wxPython / src / _cursor.i

diff --git a/wxPython/src/_cursor.i b/wxPython/src/_cursor.i
index 6ce76d4cf1811707337692ddfcb18ee6cd87e462..bb51a4dd8336df3d60e1afda030cf150d9fcc12b 100644 (file)
--- a/wxPython/src/_cursor.i
+++ b/wxPython/src/_cursor.i
@@ -17,21 +17,19 @@
 
 
 DocStr(wxCursor,
 
 
 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 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
 
 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
-
+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.
+","
+
+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_ARROW             A standard arrow cursor.
     wx.CURSOR_RIGHT_ARROW       A standard arrow cursor pointing to the right.
     wx.CURSOR_BLANK             Transparent cursor.


@@ -59,27 +57,30 @@ RefDoc(wxCursor::wxCursor(int id),
     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.)
     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.)

+    ========================    ======================================

 
 ");
 
 
 ");
 

+MustHaveApp(wxCursor);
+

 class wxCursor : public wxGDIObject
 {
 public:
     
     %extend {
         DocStr(wxCursor,
 class wxCursor : public wxGDIObject
 {
 public:
     
     %extend {
         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) {
+               "Construct a Cursor from a file.  Specify the type of file using
+wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
+file.","
+:see: Alternate constructors `wx.StockCursor`,`wx.CursorFromImage`");
+        wxCursor(const wxString& cursorName, long type, int hotSpotX=0, int hotSpotY=0) {

 %#ifdef __WXGTK__
 %#ifdef __WXGTK__

-            wxCHECK_MSG(False, NULL,
-                        wxT("wx.Cursor constructor not implemented for wxGTK, use wx.StockCursor, wx.CursorFromImage, or wx.CursorFromBits instead."));
+            wxImage img(cursorName, type);
+            img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX);
+            img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotSpotY);
+            return new wxCursor(img);

 %#else
 %#else

-            return new wxCursor(*cursorName, type, hotSpotX, hotSpotY);
+            return new wxCursor(cursorName, type, hotSpotX, hotSpotY);

 %#endif
         }
     }
 %#endif
         }
     }


@@ -88,33 +89,31 @@ public:
 
     DocCtorStrName(
         wxCursor(int id),
 
     DocCtorStrName(
         wxCursor(int id),

-        "Create a cursor using one of the stock cursors.  Note that not\n"
-        "all cursors are available on all platforms.",
+        "Create a cursor using one of the stock cursors.  Note that not all
+stock cursors are available on all platforms.", "",

         StockCursor);
 
     
     DocCtorStrName(
         wxCursor(const wxImage& image),
         StockCursor);
 
     
     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).",
+        "Constructs a cursor from a `wx.Image`. The mask (if any) will be used
+for setting the transparent portions of the cursor.",
+"
+In MSW the cursor is resized to 32x32 if it was larger.
+
+In GTK the cursor will be displayed at the size of the image.
+
+On MacOS the cursor is resized to 16x16 if it was larger.",

         CursorFromImage);
     
     
 //     %extend {
 //         DocStr(wxCursor,
 //                "");
         CursorFromImage);
     
     
 //     %extend {
 //         DocStr(wxCursor,
 //                "");

-//         %name(CursorFromBits) wxCursor(PyObject* bits, int width, int  height,
+//         %RenameCtor(CursorFromBits,  wxCursor(PyObject* bits, int width, int  height,

 //                                          int hotSpotX=-1, int hotSpotY=-1,
 //                                          int hotSpotX=-1, int hotSpotY=-1,

-//                                          PyObject* maskBits=NULL) {
+//                                          PyObject* maskBits=NULL))
+//         {

 //             char* bitsbuf;
 //             char* maskbuf = NULL;
 //             int   length;
 //             char* bitsbuf;
 //             char* maskbuf = NULL;
 //             int   length;


@@ -130,11 +129,11 @@ public:
 #ifdef __WXMSW__
     DocDeclStr(
         long , GetHandle(),
 #ifdef __WXMSW__
     DocDeclStr(
         long , GetHandle(),

-        "Get the MS Windows handle for the cursor");
+        "Get the MS Windows handle for the cursor", "");

     
     %extend {
     DocStr(SetHandle,
     
     %extend {
     DocStr(SetHandle,

-        "Set the MS Windows handle to use for the cursor");
+        "Set the MS Windows handle to use for the cursor", "");

         void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }
     }
     
         void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }
     }
     


@@ -142,7 +141,7 @@ public:
     
     DocDeclStr(
         bool , Ok(),
     
     DocDeclStr(
         bool , Ok(),

-        "");
+        "", "");

 
     %pythoncode { def __nonzero__(self): return self.Ok() }
 
 
     %pythoncode { def __nonzero__(self): return self.Ok() }
 


@@ -150,31 +149,31 @@ public:
 #ifdef __WXMSW__
     DocDeclStr(
         int , GetWidth(),
 #ifdef __WXMSW__
     DocDeclStr(
         int , GetWidth(),

-        "");
+        "", "");

     
     DocDeclStr(
         int , GetHeight(),
     
     DocDeclStr(
         int , GetHeight(),

-        "");
+        "", "");

     
     DocDeclStr(
         int , GetDepth(),
     
     DocDeclStr(
         int , GetDepth(),

-        "");
+        "", "");

     
     DocDeclStr(
         void , SetWidth(int w),
     
     DocDeclStr(
         void , SetWidth(int w),

-        "");
+        "", "");

     
     DocDeclStr(
         void , SetHeight(int h),
     
     DocDeclStr(
         void , SetHeight(int h),

-        "");
+        "", "");

     
     DocDeclStr(
         void , SetDepth(int d),
     
     DocDeclStr(
         void , SetDepth(int d),

-        "");
+        "", "");

     
     DocDeclStr(
         void , SetSize(const wxSize& size),
     
     DocDeclStr(
         void , SetSize(const wxSize& size),

-        "");
+        "", "");

     
 #endif
     
     
 #endif