kfind.h

Go to the documentation of this file.

/*
    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 <kdialog.h>
#include <QtCore/QRect>

class KDEUI_EXPORT KFind :
    public QObject
{
    Q_OBJECT

public:

    enum Options
    {
        WholeWordsOnly = 1,     
        FromCursor = 2,         
        SelectedText = 4,       
        CaseSensitive = 8,      
        FindBackwards = 16,     
        RegularExpression = 32, 
        FindIncremental = 64,   
        // Note that KReplaceDialog uses 256 and 512
        // User extensions can use boolean options above this value.
        MinimumUserOption = 65536 
    };    
    Q_DECLARE_FLAGS(SearchOptions, Options)

    
    KFind(const QString &pattern, long options, QWidget *parent);

    KFind(const QString &pattern, long options, QWidget *parent, QWidget* findDialog);
    virtual ~KFind();

    enum Result { NoMatch, Match };

    bool needData() const;

    void setData( const QString& data, int startPos = -1 );

    void setData( int id, const QString& data, int startPos = -1 );

    Result find();

    long options() const;

    virtual void setOptions( long options );

    QString pattern() const;

    void setPattern( const QString& pattern );

    int numMatches() const;

    virtual void resetCounts();

    virtual bool validateMatch( const QString & text,
                                int index,
                                int matchedlength );

    virtual bool shouldRestart( bool forceAsking = false, bool showNumMatches = true ) const;

    static int find( const QString &text, const QString &pattern, int index, long options, int *matchedlength );

    static int find( const QString &text, const QRegExp &pattern, int index, long options, int *matchedlength );

    virtual void displayFinalDialog() const;

    KDialog* findNextDialog( bool create = false );

    void closeFindNextDialog();

    int index() const;

Q_SIGNALS:

    void highlight(const QString &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:

    QWidget* parentWidget() const;
    QWidget* dialogsParent() const;

private:
    friend class KReplace;
    friend class KReplacePrivate;

    struct Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void _k_slotFindNext() )
    Q_PRIVATE_SLOT( d, void _k_slotDialogClosed() )
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KFind::SearchOptions)

#endif