kmail

rulewidgethandler.h

Go to the documentation of this file.
00001 /*  -*- mode: C++; c-file-style: "gnu" -*-
00002     interfaces/rulewidgethandler.h
00003 
00004     This file is part of KMail, the KDE mail client.
00005     Copyright (c) 2004 Ingo Kloecker <kloecker@kde.org>
00006 
00007     KMail is free software; you can redistribute it and/or modify
00008     it under the terms of the GNU General Public License as published by
00009     the Free Software Foundation; either version 2 of the License, or
00010     (at your option) any later version.
00011 
00012     KMail is distributed in the hope that it will be useful, but
00013     WITHOUT ANY WARRANTY; without even the implied warranty of
00014     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015     GNU General Public License for more details.
00016 
00017     You should have received a copy of the GNU General Public License
00018     along with this program; if not, write to the Free Software
00019     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00020 
00021     In addition, as a special exception, the copyright holders give
00022     permission to link the code of this program with any edition of
00023     the Qt library by Trolltech AS, Norway (or with modified versions
00024     of Qt that use the same license as Qt), and distribute linked
00025     combinations including the two.  You must obey the GNU General
00026     Public License in all respects for all of the code used other than
00027     Qt.  If you modify this file, you may extend this exception to
00028     your version of the file, but you are not obligated to do so.  If
00029     you do not wish to do so, delete this exception statement from
00030     your version.
00031 */
00032 
00033 #ifndef __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__
00034 #define __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__
00035 
00036 #include "../kmsearchpattern.h"
00037 
00038 class QWidget;
00039 class QWidgetStack;
00040 class QCString;
00041 class QString;
00042 class QObject;
00043 
00044 namespace KMail {
00048   class RuleWidgetHandler {
00049   public:
00050     virtual ~RuleWidgetHandler() {}
00051 
00052     virtual QWidget * createFunctionWidget( int number,
00053                                             QWidgetStack *functionStack,
00054                                             const QObject *receiver ) const = 0;
00055     virtual QWidget * createValueWidget( int number,
00056                                          QWidgetStack *valueStack,
00057                                          const QObject *receiver ) const = 0;
00058     virtual KMSearchRule::Function function( const QCString & field,
00059                                              const QWidgetStack *functionStack ) const = 0;
00060     virtual QString value( const QCString & field,
00061                            const QWidgetStack *functionStack,
00062                            const QWidgetStack *valueStack ) const = 0;
00063     virtual QString prettyValue( const QCString & field,
00064                                  const QWidgetStack *functionStack,
00065                                  const QWidgetStack *valueStack ) const = 0;
00066     virtual bool handlesField( const QCString & field ) const = 0;
00067     virtual void reset( QWidgetStack *functionStack,
00068                         QWidgetStack *valueStack ) const = 0;
00069     virtual bool setRule( QWidgetStack *functionStack,
00070                           QWidgetStack *valueStack,
00071                           const KMSearchRule *rule ) const = 0;
00072     virtual bool update( const QCString & field,
00073                          QWidgetStack *functionStack,
00074                          QWidgetStack *valueStack ) const = 0;
00075 
00076   };
00077 
00078 } // namespace KMail
00079 
00080 #endif // __KMAIL_INTERFACES_RULEWIDGETHANDLER_H__
00081