ktip.h

Go to the documentation of this file.

/*****************************************************************

Copyright (c) 2000-2003 Matthias Hoelzer-Kluepfel <mhk@kde.org>
                        Tobias Koenig <tokoe@kde.org>
                        Daniel Molkentin <molkentin@kde.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

******************************************************************/

#ifndef KTIP_H
#define KTIP_H

#include <QtCore/QStringList>

#include <kdialog.h>

class KDEUI_EXPORT KTipDatabase
{
  public:
    explicit KTipDatabase( const QString &tipFile = QString() );

    explicit KTipDatabase( const QStringList &tipFiles );

    ~KTipDatabase();

    QString tip() const;

    void nextTip();

    void prevTip();

  private:
    class Private;
    Private* const d;

    Q_DISABLE_COPY( KTipDatabase )
};

class KDEUI_EXPORT KTipDialog : public KDialog
{
  Q_OBJECT

  public:
    explicit KTipDialog( KTipDatabase *database, QWidget *parent = 0 );

    ~KTipDialog();

    static void showTip( QWidget *parent, const QString &tipFile = QString(), bool force = false );

    static void showMultiTip( QWidget *parent, const QStringList &tipFiles, bool force = false );

    static void showTip( const QString &tipFile = QString(), bool force = false );

    static void setShowOnStart( bool show );

  protected:
    bool eventFilter( QObject*, QEvent* );

  private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void _k_nextTip() )
    Q_PRIVATE_SLOT( d, void _k_prevTip() )
    Q_PRIVATE_SLOT( d, void _k_showOnStart( bool ) )
    Q_DISABLE_COPY(KTipDialog)
};

#endif