tdesdk/kbabel/kbabeldict/modules/tmx/tmxcompendium.h

/* ****************************************************************************
  This file is part of KBabel

  Copyright (C) 2000 by Matthias Kiefer
                            <matthias.kiefer@gmx.de>
		2002 by Stanislav Visnovsky
			    <visnovsky@kde.org>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  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; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

  In addition, as a special exception, the copyright holders give
  permission to link the code of this program with any edition of
  the TQt library by Trolltech AS, Norway (or with modified versions  
  of TQt that use the same license as TQt), and distribute linked
  combinations including the two.  You must obey the GNU General
  Public License in all respects for all of the code used other than
  TQt. If you modify this file, you may extend this exception to
  your version of the file, but you are not obligated to do so.  If
  you do not wish to do so, delete this exception statement from
  your version.
		
**************************************************************************** */

#ifndef TMXCOMPENDIUM_H
#define TMXCOMPENDIUM_H

#include "tmxcompendiumdata.h"
#include "searchengine.h"

#include <tqdict.h>
#include <tqfile.h>
#include <tqguardedptr.h>

class TmxCompendiumPreferencesWidget;
class KConfigBase;
class TQTimer;

class TmxCompendium : public SearchEngine
{
	Q_OBJECT
  

public:
	TmxCompendium(TQObject *parent=0, const char *name=0);
	virtual ~TmxCompendium();

	virtual bool isReady() const;
    
    virtual TQString translate(const TQString& text, uint pluralForm);
    virtual TQString fuzzyTranslation(const TQString& text, int &score, uint pluralForm);

	virtual bool isSearching() const;

	virtual void saveSettings(KConfigBase *config);
	virtual void readSettings(KConfigBase *config);

	virtual PrefWidget *preferencesWidget(TQWidget *parent);

	virtual const KAboutData *about() const;

	virtual TQString name() const;
	
	virtual TQString id() const;

	virtual TQString lastError();


public slots:
	virtual bool startSearch(const TQString& text, uint pluralForm, const SearchFilter* filter);
	virtual void stopSearch();
    virtual void setLanguageCode(const TQString& lang);

protected slots:
	/** reads the current settings from the preferences dialog */
	void applySettings();
    
	/** sets the current settings in the preferences dialog */
	void restoreSettings();

    void slotLoadCompendium();

    void recheckData();
    void removeData();

protected:
	void loadCompendium();
    void addResult(SearchResult *);
    TQString maskString(TQString string) const;

    void registerData();
    void unregisterData();

private:
	TQGuardedPtr<TmxCompendiumPreferencesWidget> prefWidget;
    TmxCompendiumData *data;
    TQTimer *loadTimer;

	TQString url;
    TQString realURL;
    TQString langCode;
	
	bool caseSensitive;
    bool wholeWords;

	bool matchEqual;
	bool matchIsContained;
	bool matchContains;
    bool matchWords;
    bool matchNGram;
    
    bool buildIndex;
    uint freeMemDelay;

	bool error;
	TQString errorMsg;

	bool stop;
	bool active;
	bool initialized;
    bool loading;

    static TQDict<TmxCompendiumData> *_compDict;
    static TQDict<TmxCompendiumData> *compendiumDict();
};

#endif