summaryrefslogtreecommitdiffstats
path: root/khelpcenter/kcmhelpcenter.h
blob: 0212a22c5629ea2a6f858a6a9ca02a2e9fb52533 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
  This file is part of KHelpcenter.

  Copyright (C) 2002 Cornelius Schumacher <schumacher@kde.org>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public
  License version 2 as published by the Free Software Foundation.

  This program 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; see the file COPYING.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/
#ifndef KCMHELPCENTER_H
#define KCMHELPCENTER_H

#include <kdialog.h>
#include <kdialogbase.h>

#include <dcopobject.h>

#include "scopeitem.h"

class TQPushButton;
class TQProgressBar;
class TQTextEdit;
class TQLabel;

class TDEProcess;
class TDEConfig;
class TDEAboutData;
class KTempFile;
class KURLRequester;
class TDEListView;

namespace KHC {
class HtmlSearchConfig;
class DocEntry;
class SearchEngine;
}

class IndexDirDialog : public KDialogBase
{
    Q_OBJECT
  public:
    IndexDirDialog( TQWidget *parent );

  protected slots:
    void slotOk();
    void slotUrlChanged( const TQString &_url);    
  private:
    KURLRequester *mIndexUrlRequester;
};

class IndexProgressDialog : public KDialog
{
    Q_OBJECT
  public:
    IndexProgressDialog( TQWidget *parent );
    ~IndexProgressDialog();

    void setTotalSteps( int );
    void advanceProgress();
    void setLabelText( const TQString & );
    void setMinimumLabelWidth( int width );
    void setFinished( bool );

    void appendLog( const TQString &text );

  signals:
    void closed();
    void cancelled();

  protected:
    void hideDetails();

  protected slots:
    void slotEnd();
    void toggleDetails();

  private:
    TQLabel *mLabel;
    TQProgressBar *mProgressBar;
    TQLabel *mLogLabel;
    TQTextEdit *mLogView;
    TQPushButton *mDetailsButton;
    TQPushButton *mEndButton;

    bool mFinished;
};

class KCMHelpCenterIface : virtual public DCOPObject
{
    K_DCOP
  k_dcop:
    virtual void slotIndexProgress() = 0;
    virtual void slotIndexError( const TQString & ) = 0;
};

class KCMHelpCenter : public KDialogBase, virtual public KCMHelpCenterIface
{
    Q_OBJECT
  public:
    KCMHelpCenter( KHC::SearchEngine *, TQWidget *parent = 0,
      const char *name = 0 );
    ~KCMHelpCenter();
    
    void load();
    bool save();
    void defaults();

  public slots:

  signals:
    void searchIndexUpdated();

  protected slots:
    bool buildIndex();
    void cancelBuildIndex();
    void slotIndexFinished( TDEProcess * );
    void slotIndexProgress();
    void slotIndexError( const TQString & );
    void slotReceivedStdout(TDEProcess *proc, char *buffer, int buflen);
    void slotReceivedStderr(TDEProcess *proc, char *buffer, int buflen);
    void slotProgressClosed();

    void slotOk();

    void showIndexDirDialog();

    void checkSelection();

  protected:
    void setupMainWidget( TQWidget *parent );
    void updateStatus();
    void startIndexProcess();

    void deleteProcess();
    void deleteCmdFile();

    void advanceProgress();

    /**
     * Find a user-writeable location for the indices, if the current location
     * is not.
     */
    void findWriteableIndexDir();
  private:
    KHC::SearchEngine *mEngine;
  
    TDEListView *mListView;
    TQLabel *mIndexDirLabel;
    TQPushButton *mBuildButton;
    IndexProgressDialog *mProgressDialog;
    
    TQValueList<KHC::DocEntry *> mIndexQueue;
    TQValueList<KHC::DocEntry *>::ConstIterator mCurrentEntry;
    
    TDEConfig *mConfig;
    
    TDEAboutData *mAboutData;

    KHC::HtmlSearchConfig *mHtmlSearchTab;
    TQWidget *mScopeTab;

    KTempFile *mCmdFile;

    TDEProcess *mProcess;

    bool mIsClosing;

    TQString mStdOut;
    TQString mStdErr;

    bool mRunAsRoot;
};

#endif
// vim:ts=2:sw=2:et