From ce4a32fe52ef09d8f5ff1dd22c001110902b60a2 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- interfaces/ktexteditor/texthintinterface.h | 79 ++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 interfaces/ktexteditor/texthintinterface.h (limited to 'interfaces/ktexteditor/texthintinterface.h') diff --git a/interfaces/ktexteditor/texthintinterface.h b/interfaces/ktexteditor/texthintinterface.h new file mode 100644 index 000000000..3b5f0476d --- /dev/null +++ b/interfaces/ktexteditor/texthintinterface.h @@ -0,0 +1,79 @@ +/* This file is part of the KDE libraries + Copyright (C) 2001 Joseph Wenninger + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License version 2 as published by the Free Software Foundation. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef __ktexteditor_texthintinterface_h__ +#define __ktexteditor_texthintinterface_h__ + +#include +#include + +#include + +namespace KTextEditor +{ + +/** + * This is an interface for the KTextEditor::View class. + + */ +class KTEXTEDITOR_EXPORT TextHintInterface +{ + friend class PrivateTextHintInterface; +public: + TextHintInterface(); + virtual ~TextHintInterface(); + + /** + * 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 enableTextHints(int timeout)=0; + + /** + * Disable texthints. Per default they are disabled. + */ + virtual void disableTextHints()=0; + + /** + * This method returns a number, unique during one application run + * + */ + unsigned int textHintInterfaceNumber () const; + + + //signals + + /** + * 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 + */ + virtual void needTextHint(int line, int col, QString &text)=0; + + private: + class PrivateTextHintInterface *d; + static unsigned int globalTextHintInterfaceNumber; + unsigned int myTextHintInterfaceNumber; +}; + +KTEXTEDITOR_EXPORT TextHintInterface *textHintInterface (class View *view); + +} + +#endif -- cgit v1.2.3