Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / cursor.h

diff --git a/include/wx/cursor.h b/include/wx/cursor.h
index f4f90abd40b7794b3905ce911678a6425b729c77..66d88994193af05e0bc1cf03ebdc6edb23fbf43a 100644 (file)
--- a/include/wx/cursor.h
+++ b/include/wx/cursor.h
@@ -1,22 +1,70 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/cursor.h
+// Purpose:     wxCursor base header
+// Author:      Julian Smart
+// Modified by:
+// Created:
+// Copyright:   (c) Julian Smart
+// RCS-ID:      $Id$
+// Licence:     wxWindows Licence
+/////////////////////////////////////////////////////////////////////////////
+
 #ifndef _WX_CURSOR_H_BASE_
 #define _WX_CURSOR_H_BASE_
 
+#include "wx/defs.h"
+
+/*
+    wxCursor classes should have the following public API:
+
+class WXDLLIMPEXP_CORE wxCursor : public wxGDIObject
+{
+public:
+    wxCursor();
+    wxCursor(const wxImage& image);
+    wxCursor(const wxString& name,
+             wxBitmapType type = wxCURSOR_DEFAULT_TYPE,
+             int hotSpotX = 0, int hotSpotY = 0);
+    wxCursor(wxStockCursor id) { InitFromStock(id); }
+#if WXWIN_COMPATIBILITY_2_8
+    wxCursor(int id) { InitFromStock((wxStockCursor)id); }
+#endif
+    virtual ~wxCursor();
+};
+
+*/
+
 #if defined(__WXMSW__)
-#include "wx/msw/cursor.h"
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_CUR_RESOURCE
+    #include "wx/msw/cursor.h"
 #elif defined(__WXMOTIF__)
-#include "wx/motif/cursor.h"
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_XBM
+    #include "wx/motif/cursor.h"
+#elif defined(__WXGTK20__)
+    #ifdef __WINDOWS__
+        #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_CUR_RESOURCE
+    #else
+        #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_XPM
+    #endif
+    #include "wx/gtk/cursor.h"
 #elif defined(__WXGTK__)
-#include "wx/gtk/cursor.h"
-#elif defined(__WXMGL__)
-#include "wx/mgl/cursor.h"
-#elif defined(__WXQT__)
-#include "wx/qt/cursor.h"
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_XPM
+    #include "wx/gtk1/cursor.h"
+#elif defined(__WXX11__)
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_XPM
+    #include "wx/x11/cursor.h"
+#elif defined(__WXDFB__)
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_CUR_RESOURCE
+    #include "wx/dfb/cursor.h"
 #elif defined(__WXMAC__)
-#include "wx/mac/cursor.h"
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_MACCURSOR_RESOURCE
+    #include "wx/osx/cursor.h"
+#elif defined(__WXCOCOA__)
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_MACCURSOR_RESOURCE
+    #include "wx/cocoa/cursor.h"
 #elif defined(__WXPM__)
-#include "wx/os2/cursor.h"
-#elif defined(__WXSTUBS__)
-#include "wx/stubs/cursor.h"
+    #define wxCURSOR_DEFAULT_TYPE   wxBITMAP_TYPE_CUR_RESOURCE
+    #include "wx/os2/cursor.h"
 #endif
 
 #include "wx/utils.h"
@@ -46,7 +94,6 @@ public:
         if( wxIsBusy() )
         {
             wxSetCursor( wxBusyCursor::GetStoredCursor() );
-            wxYield();
         }
     }
     ~wxBusyCursorSuspender()
@@ -54,7 +101,6 @@ public:
         if( wxIsBusy() )
         {
             wxSetCursor( wxBusyCursor::GetBusyCursor() );
-            wxYield();
         }
     }
 };