KTextEditor::TextHintInterface Class Reference

This is an interface for the KTextEditor::View class. More...

#include <texthintinterface.h>

List of all members.

Public Member Functions
virtual void	disableTextHints ()=0
virtual void	enableTextHints (int timeout)=0
virtual void	needTextHint (int line, int col, QString &text)=0
	TextHintInterface ()
unsigned int	textHintInterfaceNumber () const
virtual	~TextHintInterface ()

---

Detailed Description

This is an interface for the KTextEditor::View class.

Definition at line 34 of file texthintinterface.h.

---

Constructor & Destructor Documentation

KTextEditor::TextHintInterface::TextHintInterface

(

)

Definition at line 37 of file texthintinterface.cpp.

KTextEditor::TextHintInterface::~TextHintInterface

(

)

[virtual]

Definition at line 45 of file texthintinterface.cpp.

---

Member Function Documentation

virtual void KTextEditor::TextHintInterface::disableTextHints

(

)

[pure virtual]

Disable texthints.

Per default they are disabled.

virtual void KTextEditor::TextHintInterface::enableTextHints

(

int

timeout

)

[pure virtual]

enable Texthints.

If they are enabled a signal needTextHint is emitted, if the mouse changed the position and a new character is beneath the mouse cursor. The signal is delayed for a certain time, specifiedin the timeout parameter.

virtual void KTextEditor::TextHintInterface::needTextHint	(	int	line,
		int	col,
		QString &	text
	)			[pure virtual]

emit this signal, if a tooltip text is needed for displaying.

I you don't want a tooltip to be displayd set text to an emtpy string in a connected slot, otherwise set text to the string you want the editor to display

unsigned int KTextEditor::TextHintInterface::textHintInterfaceNumber

(

)

const

This method returns a number, unique during one application run.

Definition at line 50 of file texthintinterface.cpp.

---

The documentation for this class was generated from the following files:

• texthintinterface.h
• texthintinterface.cpp