JVCL Help:TJvCaret

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Class Hierarchy

TJvCaret
run\JvCaret.pas


Summary

Helper object to store caret settings in.

run\JvCaret.pas


Pascal

 run\JvCaret.pas
 TJvCaret = class(TPersistent);


Description

TJvCaret is a helper object to store the settings for the custom caret in. It is used by some of the edit controls in JVCL, but it can be used for any control that is derived from TWinControl.
If Bitmap is assigned, the Width and Height properties are set to 0 and Gray is set to false.
If Gray is set to true or Width and/or Height are specified, Bitmap is ignored.
If no bitmap has been assigned, Gray is set to false and both Width and Height are 0, no custom caret will be created, but the standard Windows caret will be used instead.
A control that wants to use a custom caret should take care of the following:

  • As soon as your control has focus (and your application is the active application) you may callTJvCaret.CreateCaret to create and display the caret (if needed you can use the Windows API call for HideCaret to temporarily hide it).
  • If the control loses focus or the application will be deactivated (because another applicationgets focus) you must call TJvCaret.DestroyCaret * Use the Window API calls to hide/show the caret or to get or change its location (HideCaret, ShowCaret, GetCaretPos, SetCaretPos respectively).

run\JvCaret.pas


About

Navigation

run\JvCaret.pas



Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page