runtime/khelpcenter/navigator.h

   1 /*
   2  *  This file is part of the KDE Help Center
   3  *
   4  *  Copyright (C) 1999 Matthias Elter (me@kde.org)
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20
  21 #ifndef __navigator_h__
  22 #define __navigator_h__
  23
  24 #include "glossary.h"
  25
  26 #include <k3listview.h>
  27 #include <kurl.h>
  28
  29 #include <QFile>
  30 #include <QTextStream>
  31 #include <QTimer>
  32 #include <Qt3Support/Q3PtrList>
  33 #include <QTabWidget>
  34 #include <Qt3Support/Q3CheckListItem>
  35 #include <Qt3Support/Q3Dict>
  36 //Added by qt3to4:
  37 #include <QFrame>
  38
  39 class QPushButton;
  40
  41 class K3ListView;
  42 class KLineEdit;
  43
  44 class KCMHelpCenter;
  45
  46 namespace KHC {
  47
  48 class NavigatorItem;
  49 class Navigator;
  50 class View;
  51 class SearchEngine;
  52 class SearchWidget;
  53 class Formatter;
  54
  55 class Navigator : public QWidget
  56 {
  57     Q_OBJECT
  58   public:
  59     explicit Navigator(View *, QWidget *parent=0, const char *name=0);
  60     virtual ~Navigator();
  61
  62     KUrl homeURL();
  63
  64     SearchEngine *searchEngine() const;
  65     Formatter *formatter() const;
  66
  67     const GlossaryEntry &glossEntry(const QString &term) const { return mGlossaryTree->entry( term ); }
  68
  69     void insertParentAppDocs( const QString &name, NavigatorItem *parent );
  70     NavigatorItem *insertScrollKeeperDocs( NavigatorItem *parentItem,
  71                                  NavigatorItem *after );
  72     void insertInfoDocs( NavigatorItem *parentItem );
  73     void insertKCMDocs(const QString &, NavigatorItem*parent, const QString &);
  74     void insertIOSlaveDocs(const QString &, NavigatorItem*parent);
  75
  76     void createItemFromDesktopFile( NavigatorItem *item, const QString &name );
  77
  78     bool showMissingDocs() const;
  79
  80     void clearSelection();
  81
  82     void showOverview( NavigatorItem *item, const KUrl &url );
  83
  84     void readConfig();
  85     void writeConfig();
  86
  87   public Q_SLOTS:
  88     void openInternalUrl( const KUrl &url );
  89     void slotItemSelected(Q3ListViewItem* index);
  90     void slotSearch();
  91     void slotShowSearchResult( const QString & );
  92     void slotSelectGlossEntry( const QString &id );
  93     void selectItem( const KUrl &url );
  94     void showIndexDialog();
  95
  96   Q_SIGNALS:
  97     void itemSelected(const QString& itemURL);
  98     void glossSelected(const GlossaryEntry &entry);
  99
 100   protected Q_SLOTS:
 101     void slotSearchFinished();
 102     void slotTabChanged( QWidget * );
 103     void checkSearchButton();
 104
 105     bool checkSearchIndex();
 106
 107     void clearSearch();
 108
 109   protected:
 110     QString createChildrenList( Q3ListViewItem *child );
 111
 112   private:
 113     void setupContentsTab();
 114     void setupIndexTab();
 115     void setupSearchTab();
 116     void setupGlossaryTab();
 117
 118     void insertPlugins();
 119     void hideSearch();
 120
 121     K3ListView *mContentsTree;
 122     Glossary *mGlossaryTree;
 123
 124     SearchWidget *mSearchWidget;
 125     KCMHelpCenter *mIndexDialog;
 126
 127     QTabWidget *mTabWidget;
 128
 129     QFrame *mSearchFrame;
 130     KLineEdit *mSearchEdit;
 131     QPushButton *mSearchButton;
 132
 133     bool mShowMissingDocs;
 134
 135     SearchEngine *mSearchEngine;
 136
 137     View *mView;
 138
 139     KUrl mHomeUrl;
 140
 141     bool mSelected;
 142
 143     KUrl mLastUrl;
 144
 145     int mDirLevel;
 146 };
 147
 148 }
 149
 150 #endif
 151 // vim:ts=2:sw=2:et