]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/tooltip.h
use wxHAS_RAW_BITMAP instead of wxHAVE_RAW_BITMAP
[wxWidgets.git] / interface / tooltip.h
index 20635ad5689388c1c3e3077054e2090baba84500..6d6779198ac9e939e748853c3c0157c9cbe906c7 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tooltip.h
-// Purpose:     documentation for wxToolTip class
+// Purpose:     interface of wxToolTip
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     @class wxToolTip
     @wxheader{tooltip.h}
 
-    This class holds information about a tooltip associated with a window
-    (see wxWindow::SetToolTip).
+    This class holds information about a tooltip associated with a window (see
+    wxWindow::SetToolTip()).
 
-    The four static methods, wxToolTip::Enable,
-    wxToolTip::SetDelay
-    wxToolTip::SetAutoPop and
-    wxToolTip::SetReshow can be used to globally
+    The four static methods, wxToolTip::Enable(), wxToolTip::SetDelay()
+    wxToolTip::SetAutoPop() and wxToolTip::SetReshow() can be used to globally
     alter tooltips behaviour.
 
     @library{wxcore}
@@ -32,36 +30,40 @@ public:
 
     /**
         Enable or disable tooltips globally.
-        May not be supported on all platforms (eg. wxCocoa).
+
+        @note May not be supported on all platforms (eg. wxCocoa).
     */
     static void Enable(bool flag);
 
     /**
         Get the tooltip text.
     */
-    wxString GetTip();
+    wxString GetTip() const;
 
     /**
         Get the associated window.
     */
-    wxWindow* GetWindow();
+    wxWindow* GetWindow() const;
 
     /**
-        Set the delay after which the tooltip disappears or how long a
-        tooltip remains visible.
-        May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
+        Set the delay after which the tooltip disappears or how long a tooltip
+        remains visible.
+
+        @note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
     */
     static void SetAutoPop(long msecs);
 
     /**
         Set the delay after which the tooltip appears.
-        May not be supported on all platforms (eg. wxCocoa).
+
+        @note May not be supported on all platforms (eg. wxCocoa).
     */
     static void SetDelay(long msecs);
 
     /**
         Set the delay between subsequent tooltips to appear.
-        May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
+
+        @note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
     */
     static void SetReshow(long msecs);
 
@@ -70,3 +72,4 @@ public:
     */
     void SetTip(const wxString& tip);
 };
+