- Main Page
- Packages
- Classes
- Files
- Related Pages

- Packages
- Package Functions

# Package smjg.libs.sdwf.caret

Text cursor manipulation. More...

## Classes
class | Caret
| The smjg.libs.sdwf.caret.Caret class represents a window's caret (text cursor). More...
## Enumerations
enum | CARET_STYLE { SOLID, GREY, GRAY = GREY, BITMAP }
| The smjg.libs.sdwf.caret.CARET_STYLE enumeration is used to specify the appearance of a caret (text cursor). More...

## Detailed Description

Text cursor manipulation.

The smjg.libs.sdwf.caret module contains the Caret class, used to manipulate the Windows caret. This is the cursor commonly displayed to indicate that the user may input text. The cursor can be the usual line or rectangle, a 'grey' version of this (rendered by drawing alternate pixels) or a bitmap. The caret is drawn by XORing the the solid rectangle, grey rectangle or bitmap with what is already displayed at its location.

The caret can also be invisible. The caret not only indicates to the user where text will be inserted, but is also used by some accessibility software (such as screen magnifiers).

Since:
  0.5

Limitations:
  If an area of the window containing all or part of the caret is repainted while the window is active, it can sometimes corrupt the display. This appears to be a bug in some versions of Windows; a workaround is to ensure that the WindowClass has the CS.HREDRAW and CS.VREDRAW style flags.

## Enumeration Type Documentation

enum smjg::libs::sdwf::caret::CARET_STYLE

The smjg.libs.sdwf.caret.CARET_STYLE enumeration is used to specify the appearance of a caret (text cursor).

Enumerator:

  SOLID |
  GREY |
  GRAY |
  BITMAP |