kexisearchandreplaceiface.h

/* This file is part of the KDE project
   Copyright (C) 2007 Jaroslaw Staniek <js@iidea.pl>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   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 KexiSearchAndReplaceViewInterface_H
#define KexiSearchAndReplaceViewInterface_H
 
#include <kexiutils/tristate.h>
#include <tqstring.h>
class TQVariant;
class TQStringList;

class KEXICORE_EXPORT KexiSearchAndReplaceViewInterface
{
    public:
        KexiSearchAndReplaceViewInterface();
        virtual ~KexiSearchAndReplaceViewInterface();


        class KEXICORE_EXPORT Options {
            public:
                Options();

                enum SpecialLookInValue {
                    AllColumns = -1,   
                    CurrentColumn = -2 
                };

                int columnNumber;

                enum TextMatching {
                    MatchAnyPartOfField = 0, 
                    MatchWholeField = 1,     
                    MatchStartOfField = 2    
                };

                TextMatching textMatching;

                enum SearchDirection {
                    SearchUp = 0,      
                    SearchDown = 1,    
                    SearchAllRows = 2, 
                    DefaultSearchDirection = SearchDown 
                };

                SearchDirection searchDirection;

                bool caseSensitive : 1;

                bool wholeWordsOnly : 1;

                bool promptOnReplace : 1;
        };

        virtual bool setupFindAndReplace(TQStringList& columnNames, TQStringList& columnCaptions,
            TQString& currentColumnName) = 0;

        virtual tristate find(const TQVariant& valueToFind, 
            const KexiSearchAndReplaceViewInterface::Options& options, bool next) = 0;

        virtual tristate findNextAndReplace(const TQVariant& valueToFind, const TQVariant& replacement, 
            const KexiSearchAndReplaceViewInterface::Options& options, bool replaceAll) = 0;
};
 
#endif