ktip.h

/*****************************************************************
 
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 __K_TIP_H__
#define __K_TIP_H__
 
#include <tqstringlist.h>
 
#include <kdialog.h>
 
class TQCheckBox;
 
class KTextBrowser;

class TDEUI_EXPORT KTipDatabase
{
public:
    KTipDatabase(const TQString &tipFile = TQString::null);
 
    KTipDatabase(const TQStringList &tipFiles);

    TQString tip() const;

    void nextTip();

    void prevTip();
 
private:
    void loadTips(const TQString &tipFile);
 
    void addTips(const TQString &tipFile);
 
    TQStringList mTips;
 
    int mCurrent;
    class KTipDatabasePrivate;
    KTipDatabasePrivate *d;
};

class TDEUI_EXPORT KTipDialog : public KDialog
{
    TQ_OBJECT
public:
    KTipDialog(KTipDatabase *db, TQWidget *parent = 0, const char *name = 0);
    ~KTipDialog();

    static void showTip(TQWidget *parent, const TQString &tipFile = TQString::null, bool force=false);

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

    static void showTip(const TQString &tipFile = TQString::null, bool force = false);

    static void setShowOnStart(bool show);
 
protected:
    bool eventFilter(TQObject *, TQEvent *);
    virtual void virtual_hook( int id, void* data );
 
private slots:
    void nextTip();
    void prevTip();
    void showOnStart(bool);
 
private:
    KTipDatabase *mDatabase;
 
    TQCheckBox *mTipOnStart;
    KTextBrowser *mTipText;
 
    class KTipDialogPrivate;
    KTipDialogPrivate *d;
 
    static KTipDialog *mInstance;
 
    TQColor mBaseColor, mBlendedColor, mTextColor;
};
 
#endif