.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxCaret 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxCaret \- 
  A caret (cursor) object
 
.SH DESCRIPTION

  


   A caret is a blinking cursor showing the position where the typed text will
   appear. The text controls usually have a caret but wxCaret class also allows
   to use a caret in other windows.
  
  


   Currently, the caret appears as a rectangle of the given size. In the future,
   it will be possible to specify a bitmap to be used for the caret shape.
  
  


   A caret is always associated with a window and the current caret can be
   retrieved using
   wxWindow::GetCaret
   . The same caret can't be reused in two different windows.
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/caret.h
.SH MEMBERS

  
.SS  wxCaret ()

     


      Default constructor: you must use one of Create() functions later.
     
    
.SS  wxCaret (wxWindow* windowint widthint height)

.SS  wxCaret (wxWindowBase* windowconst wxSize& size)

     


      Create the caret of given (in pixels) width and height and associates it
      with the given window.
     
    
   
  
.SS bool Create (wxWindowBase* windowint widthint height)

.SS bool Create (wxWindowBase* windowconst wxSize& size)

     


      Create the caret of given (in pixels) width and height and associates it
      with the given window (same as constructor).
     
    
   
  
.SS static int GetBlinkTime ()

     


      Returns the blink time which is measured in milliseconds and is the time
      elapsed between 2 inversions of the caret (blink time of the caret is the
      same for all carets, so this functions is static).
     
    
   
  
.SS void GetPosition (int* xint* y)

.SS wxPoint GetPosition ()

     


      Get the caret position (in pixels).
     
    
   
  
.SS void GetSize (int* widthint* height)

.SS wxSize GetSize ()

     


      Get the caret size.
     
    
   
  
.SS wxWindow* GetWindow ()

     


      Get the window the caret is associated with.
     
    
   
  
.SS void Hide ()

     


      Same as
      wxCaret::Show(false)
      .
     
    
   
  
.SS bool IsOk ()

     


      Returns true if the caret was created successfully.
     
    
   
  
.SS bool IsVisible ()

     


      Returns true if the caret is visible and false if it is permanently hidden
      (if it is is blinking and not shown currently but will be after the next
      blink, this method still returns true).
     
    
   
  
.SS void Move (int xint y)

.SS void Move (const wxPoint& pt)

     


      Move the caret to given position (in logical coordinates).
     
    
   
  
.SS static void SetBlinkTime (int milliseconds)

     


      Sets the blink time for all the carets.
     
    
   
  
.SS void SetSize (int widthint height)

.SS void SetSize (const wxSize& size)

     


      Changes the size of the caret.
     
    
   
  
.SS void Show (bool show = true)

     


      Shows or hides the caret. Notice that if the caret was hidden N times, it
      must be shown N times as well to reappear on the screen.
     
    
 
.SH "SEE ALSO"

.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.