Inherited by KTextEditor::ViewPrivate.
|virtual void||registerTextHintProvider (KTextEditor::TextHintProvider *provider)=0|
|virtual void||setTextHintDelay (int delay)=0|
|virtual int||textHintDelay () const =0|
|virtual void||unregisterTextHintProvider (KTextEditor::TextHintProvider *provider)=0|
Text hint interface showing tool tips under the mouse for the View.
The text hint interface provides a way to show tool tips for text located under the mouse. Possible applications include showing a value of a variable when debugging an application, or showing a complete path of an include directive.
To register as text hint provider, call registerTextHintProvider() with an instance that inherits TextHintProvider. Finally, make sure you remove your text hint provider by calling unregisterTextHintProvider().
- See also
Member Function Documentation
Register the text hint provider
Whenever the user hovers over text,
provider will be asked for a text hint. When the provider is about to be destroyed, make sure to call unregisterTextHintProvider() to avoid a dangling pointer.
provider text hint provider
Set the text hint delay to
The delay specifies the time the user needs to hover over the text before the tool tip is shown. Therefore,
delay should not be too large, a value of 500 milliseconds is recommended and set by default.
delay is <= 0, the default delay will be set.
delay tool tip delay in milliseconds
Get the text hint delay in milliseconds.
By default, the text hint delay is set to 500 milliseconds. It can be changed by calling
The documentation for this class was generated from the following files: