tdepim/kmail/interfaces/rulewidgethandler.h

/*
    interfaces/rulewidgethandler.h

    This file is part of KMail, the KDE mail client.
    Copyright (c) 2004 Ingo Kloecker <kloecker@kde.org>

    KMail 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.

    KMail 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 __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__
#define __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__

#include "../kmsearchpattern.h"

class TQWidget;
class TQWidgetStack;
class TQCString;
class TQString;
class TQObject;

namespace KMail {
  /**
   * @short An interface to filter/search rule widget handlers
   */
  class RuleWidgetHandler {
  public:
    virtual ~RuleWidgetHandler() {}

    virtual TQWidget * createFunctionWidget( int number,
                                            TQWidgetStack *functionStack,
                                            const TQObject *receiver ) const = 0;
    virtual TQWidget * createValueWidget( int number,
                                         TQWidgetStack *valueStack,
                                         const TQObject *receiver ) const = 0;
    virtual KMSearchRule::Function function( const TQCString & field,
                                             const TQWidgetStack *functionStack ) const = 0;
    virtual TQString value( const TQCString & field,
                           const TQWidgetStack *functionStack,
                           const TQWidgetStack *valueStack ) const = 0;
    virtual TQString prettyValue( const TQCString & field,
                                 const TQWidgetStack *functionStack,
                                 const TQWidgetStack *valueStack ) const = 0;
    virtual bool handlesField( const TQCString & field ) const = 0;
    virtual void reset( TQWidgetStack *functionStack,
                        TQWidgetStack *valueStack ) const = 0;
    virtual bool setRule( TQWidgetStack *functionStack,
                          TQWidgetStack *valueStack,
                          const KMSearchRule *rule ) const = 0;
    virtual bool update( const TQCString & field,
                         TQWidgetStack *functionStack,
                         TQWidgetStack *valueStack ) const = 0;

  };

} // namespace KMail

#endif // __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__