src/tooltips/ktooltip.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Fredrik Höglund <fredrik@kde.org>               *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef KTOOLTIP_H
  21 #define KTOOLTIP_H
  22
  23 class QPoint;
  24 class QString;
  25 class QWidget;
  26
  27 /**
  28  * Allows to show tooltips having a widget as content.
  29  */
  30 namespace KToolTip
  31 {
  32     void showText(const QPoint& pos, const QString& text);
  33
  34     /**
  35      * Shows the tip @p content at the global position indicated by @p pos.
  36      *
  37      * Ownership of the content widget is transferred to KToolTip. The widget will be deleted
  38      * automatically when it is hidden.
  39      *
  40      * The tip is shown immediately when this function is called.
  41      */
  42     void showTip(const QPoint& pos, QWidget* content);
  43     void hideTip();
  44 }
  45
  46 #endif