kfind.h

/*
    Copyright (C) 2001, S.R.Haque <srhaque@iee.org>.
    Copyright (C) 2002, David Faure <david@mandrakesoft.com>
    This file is part of the KDE project
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2, as published by the Free Software Foundation.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef KFIND_H
#define KFIND_H
 
#include <kdialogbase.h>
#include <tqrect.h>
 
class TDEUTILS_EXPORT KFind :
    public TQObject
{
    TQ_OBJECT
    
 
public:
 
    KFind(const TQString &pattern, long options, TQWidget *parent);
 
    KFind(const TQString &pattern, long options, TQWidget *parent, TQWidget* findDialog);
 
    virtual ~KFind();
 
    enum Result {
        NoMatch,  
        Match     
    };
 
    bool needData() const;
 
    void setData( const TQString& data, int startPos = -1 );
 
    void setData( int id, const TQString& data, int startPos = -1 );
 
    Result find();
 
    long options() const { return m_options; }
 
    virtual void setOptions( long options );
 
    TQString pattern() const { return m_pattern; }
 
    void setPattern( const TQString& pattern );
 
    int numMatches() const { return m_matches; }
 
    virtual void resetCounts() { m_matches = 0; }
 
    virtual bool validateMatch( const TQString & text, int index, int matchedlength ) {
        Q_UNUSED(text); Q_UNUSED(index); Q_UNUSED(matchedlength); return true; }
 
    virtual bool shouldRestart( bool forceAsking = false, bool showNumMatches = true ) const;
 
    static int find( const TQString &text, const TQString &pattern, int index, long options, int *matchedlength );
 
    static int find( const TQString &text, const TQRegExp &pattern, int index, long options, int *matchedlength );
 
    virtual void displayFinalDialog() const;
 
    KDialogBase* findNextDialog( bool create = false );
 
    void closeFindNextDialog();
 
    int index() const;
 
signals:
 
    void highlight(const TQString &text, int matchingIndex, int matchedLength);
 
    void highlight(int id, int matchingIndex, int matchedLength);
 
    // ## TODO docu
    // findprevious will also emit findNext, after temporarily switching the value
    // of FindBackwards
    void findNext();
 
    void optionsChanged();
 
    void dialogClosed();
 
protected:
 
    TQWidget* parentWidget() const { return (TQWidget *)parent(); }
    TQWidget* dialogsParent() const;
 
protected slots:
 
    void slotFindNext();
    void slotDialogClosed();
 
private:
    void init( const TQString& pattern );
    void startNewIncrementalSearch();
 
    static bool isInWord( TQChar ch );
    static bool isWholeWords( const TQString &text, int starts, int matchedLength );
 
    friend class KReplace;
 
 
    TQString m_pattern;
    TQRegExp *m_regExp;
    KDialogBase* m_dialog;
    long m_options;
    unsigned m_matches;
 
    TQString m_text; // the text set by setData
    int m_index;
    int m_matchedLength;
    bool m_dialogClosed;
    bool m_lastResult;
 
    // Binary compatible extensibility.
    struct Private;
    Private *d;
};
 
#endif