Caret operations
[Windowing functions]

Functions

• MG_EXPORT BOOL GUIAPI CreateCaret (HWND hWnd, PBITMAP pBitmap, int nWidth, int nHeight)

  Creates a new shape for the system caret and assigns ownership of the caret to the specified window.
  

• MG_EXPORT BOOL GUIAPI ChangeCaretSize (HWND hWnd, int newWidth, int newHeight)

  Changes the size of the caret.
  

• MG_EXPORT BOOL GUIAPI ActiveCaret (HWND hWnd)

  Activates the caret owned by a window.
  

• MG_EXPORT UINT GUIAPI GetCaretBlinkTime (HWND hWnd)

  Returns the elapsed time, in milliseconds, required to invert the caret's pixels.
  

• MG_EXPORT BOOL GUIAPI SetCaretBlinkTime (HWND hWnd, UINT uTime)

  Sets the caret blink time to the specified number of milliseconds.
  

• MG_EXPORT BOOL GUIAPI DestroyCaret (HWND hWnd)

  Destroys a caret.
  

• MG_EXPORT BOOL GUIAPI HideCaret (HWND hWnd)

  Hides a caret.
  

• MG_EXPORT BOOL GUIAPI ShowCaret (HWND hWnd)

  Shows a caret.
  

• MG_EXPORT BOOL GUIAPI SetCaretPos (HWND hWnd, int x, int y)

  Moves the caret to a new position.
  

• MG_EXPORT BOOL GUIAPI GetCaretPos (HWND hWnd, PPOINT pPt)

  Gets the caret position.
  

---

Function Documentation

BOOL GUIAPI ActiveCaret (  HWND  hWnd  )

Activates the caret owned by a window. This function activates the caret owned by the specified window hWnd. After activating the caret, the caret will begin flashing automatically. Parameters: hWnd  The owner of the caret. Returns: TRUE on success, otherwise FALSE. See also: HideCaret, ShowCaret

BOOL GUIAPI ChangeCaretSize (  HWND  hWnd, int  newWidth, int  newHeight )

Changes the size of the caret. This function change the size of the caret owned by the specified window hWnd. Note that the new size of the caret should be smaller than the original size which is specified when you call CreateCaret. Parameters: hWnd  The owner of the caret. newWidth  The new width of the caret. newHeight  The new height of the caret. Returns: TRUE on success, otherwise FALSE. See also: CreateCaret

BOOL GUIAPI CreateCaret (  HWND  hWnd, PBITMAP  pBitmap, int  nWidth, int  nHeight )

Creates a new shape for the system caret and assigns ownership of the caret to the specified window. This function creates a new shape for the system caret and assigns ownership of the caret to the specified window hWnd. The caret shape can be a line, a block, or a bitmap. Parameters: hWnd  The owner of the caret. pBitmap  The bitmap shape of the caret. It can be NULL. nWidth  The width of the caret. nHeight  The height of the caret. Returns: TRUE on success, otherwise FALSE. See also: ActiveCaret, ChangeCaretSize

BOOL GUIAPI DestroyCaret (  HWND  hWnd  )

Destroys a caret. This function destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen. Parameters: hWnd  The owner of the caret. Returns: TRUE on success, otherwise FALSE. See also: CreateCaret

UINT GUIAPI GetCaretBlinkTime (  HWND  hWnd  )

Returns the elapsed time, in milliseconds, required to invert the caret's pixels. This function returns the elapsed time, in milliseconds, required to invert the caret's pixels. The default blink time of a caret is 500 milliseconds. Parameters: hWnd  The owner of the caret. Returns: The elapsed time in milliseconds. Returns zero on error. See also: SetCaretBlinkTime

BOOL GUIAPI GetCaretPos (  HWND  hWnd, PPOINT  pPt )

Gets the caret position. This function copies the caret's position, in client coordinates, to the specified POINT structure pPt. Parameters: hWnd  The owner of the caret. pPt  The pointer to the buffer saves the caret's position. Returns: TRUE on success, otherwise FALSE. See also: SetCaretPos

BOOL GUIAPI HideCaret (  HWND  hWnd  )

Hides a caret. This function removes the caret from the screen. Hiding a caret does not destroy its current shape or invalidate the insertion point. Parameters: hWnd  The owner of the caret. Returns: TRUE on success, otherwise FALSE. See also: ShowCaret

BOOL GUIAPI SetCaretBlinkTime (  HWND  hWnd, UINT  uTime )

Sets the caret blink time to the specified number of milliseconds. This function sets the caret blink time to the specified number of milliseconds. The blink time is the elapsed time, in milliseconds, required to invert the caret's pixels. The default blink time of a caret is 500 milliseconds. Parameters: hWnd  The owner of the caret. uTime  New blink time in milliseconds. Returns: TRUE on success, otherwise FALSE. See also: GetCaretBlinkTime

BOOL GUIAPI SetCaretPos (  HWND  hWnd, int  x, int  y )

Moves the caret to a new position. This function moves the caret to the specified coordinates (x,y). Parameters: hWnd  The owner of the caret. x  x,y: The position of the caret in client coordiantes of the owner window. y  x,y: The position of the caret in client coordiantes of the owner window. Returns: TRUE on success, otherwise FALSE. See also: GetCaretPos

BOOL GUIAPI ShowCaret (  HWND  hWnd  )

Shows a caret. This function makes the caret visible on the screen at the caret's current position. When the caret becomes visible, it begins flashing automatically. Parameters: hWnd  The owner of the caret. Returns: TRUE on success, otherwise FALSE. See also: HideCaret

---