X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..49d37022125686b42877f0a5a971e13fb1381e87:/interface/caret.h?ds=sidebyside diff --git a/interface/caret.h b/interface/caret.h index cc9b5aec58..3b386e6e9a 100644 --- a/interface/caret.h +++ b/interface/caret.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: caret.h -// Purpose: documentation for wxCaret class +// Purpose: interface of wxCaret // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxcore} @category{misc} - @seealso - wxCaret::GetBlinkTime + @see wxCaret::GetBlinkTime */ class wxCaret { @@ -59,13 +58,13 @@ public: //@{ /** Get the caret position (in pixels). - + @b GetPosition() - + Returns a Wx::Point - + @b GetPositionXY() - + Returns a 2-element list @c ( x, y ) */ @@ -76,13 +75,13 @@ public: //@{ /** Get the caret size. - + @b GetSize() - + Returns a Wx::Size - + @b GetSizeWH() - + Returns a 2-element list @c ( width, height ) */ @@ -122,11 +121,11 @@ public: /** Sets the blink time for all the carets. - + @remarks Under Windows, this function will change the blink time for all carets permanently (until the next time it is called), even for the carets in other applications. - + @see GetBlinkTime() */ static void SetBlinkTime(int milliseconds); @@ -145,3 +144,4 @@ public: */ void Show(bool show = true); }; +