searchpatternedit.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-

  Author: Marc Mutz <mutz@kde.org>

  This program 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.

  This program 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.
*/

#ifndef MAILCOMMON_SEARCHPATTERNEDIT_H
#define MAILCOMMON_SEARCHPATTERNEDIT_H

#include "mailcommon_export.h"
#include "searchpattern.h"

#include <libkdepim/widgets/kwidgetlister.h>

#include <QByteArray>
#include <QGroupBox>

class KComboBox;
class KPushButton;

class QAbstractButton;
class QRadioButton;
class QStackedWidget;

namespace MailCommon {

class SearchPatternEdit;




class SearchRuleWidgetLister;
class MAILCOMMON_EXPORT SearchPatternEdit : public QWidget
{
    Q_OBJECT

public:
    enum SearchPatternEditOption {
        None = 0,
        HeadersOnly = 1,
        NotShowAbsoluteDate = 2,
        MatchAllMessages = 4,
        NotShowSize = 8,
        NotShowDate = 16,
        NotShowTags = 32
    };
    Q_DECLARE_FLAGS( SearchPatternEditOptions, SearchPatternEditOption )

    enum SearchModeType {
        StandardMode = 0,
        BalooMode = 1
    };

    explicit SearchPatternEdit(
            QWidget *parent = 0,
            SearchPatternEditOptions options = (SearchPatternEditOptions) (None),
            SearchModeType modeType = StandardMode);

    ~SearchPatternEdit();

    void setPatternEditOptions( SearchPatternEdit::SearchPatternEditOptions options );

    void setSearchPattern( MailCommon::SearchPattern *aPattern );


    void updateSearchPattern();

public slots:
    void reset();

signals:
    void maybeNameChanged();

    void patternChanged();

    void returnPressed();

private slots:
    void slotRadioClicked( QAbstractButton *aRBtn );
    void slotAutoNameHack();
    void slotRuleAdded( QWidget *widget );

private:
    void initLayout( SearchPatternEditOptions options, SearchModeType modeType );
    MailCommon::SearchPattern *mPattern;
    QRadioButton *mAllRBtn;
    QRadioButton *mAnyRBtn;
    QRadioButton *mAllMessageRBtn;
    SearchRuleWidgetLister *mRuleLister;
};

class SearchRuleWidget : public QWidget
{
    Q_OBJECT

public:
    explicit SearchRuleWidget(QWidget *parent = 0,
                              MailCommon::SearchRule::Ptr aRule = MailCommon::SearchRule::Ptr(),
                              SearchPatternEdit::SearchPatternEditOptions options = (SearchPatternEdit::SearchPatternEditOptions) (SearchPatternEdit::None),
                              SearchPatternEdit::SearchModeType modeType = SearchPatternEdit::StandardMode);

    enum {
        Message,
        Body,
        AnyHeader,
        Recipients,
        Size,
        AgeInDays,
        Status,
        Tag,
        Subject,
        From,
        To,
        CC,
        ReplyTo,
        Organization,
        Date
    };

    void setRule( MailCommon::SearchRule::Ptr aRule );

    MailCommon::SearchRule::Ptr rule() const;

    void reset();

    static int ruleFieldToId( const QString &i18nVal );

    void updateAddRemoveButton( bool addButtonEnabled, bool removeButtonEnabled );

    void setPatternEditOptions(MailCommon::SearchPatternEdit::SearchPatternEditOptions options);

public slots:
    void slotFunctionChanged();
    void slotValueChanged();
    void slotReturnPressed();

signals:
    void fieldChanged( const QString & );

    void contentsChanged( const QString & );

    void returnPressed();

    void addWidget( QWidget * );
    void removeWidget( QWidget * );

protected:
    static QByteArray ruleFieldToEnglish( const QString &i18nVal );

    int indexOfRuleField( const QByteArray & aName ) const;

protected slots:
    void slotRuleFieldChanged( const QString & );
    void slotAddWidget();
    void slotRemoveWidget();

private:
    void initWidget(SearchPatternEdit::SearchModeType modeType);
    void initFieldList(MailCommon::SearchPatternEdit::SearchPatternEditOptions options);

    QStringList mFilterFieldList;
    KComboBox *mRuleField;
    QStackedWidget *mFunctionStack;
    QStackedWidget *mValueStack;
    KPushButton *mAdd;
    KPushButton *mRemove;
};


class SearchRuleWidgetLister : public KPIM::KWidgetLister
{
    Q_OBJECT

    friend class SearchPatternEdit;

public:
    explicit SearchRuleWidgetLister(QWidget *parent = 0,
                                    SearchPatternEdit::SearchPatternEditOptions opt = (SearchPatternEdit::SearchPatternEditOptions) (SearchPatternEdit::None),
                                    SearchPatternEdit::SearchModeType modeType = SearchPatternEdit::StandardMode);

    virtual ~SearchRuleWidgetLister();

    void setRuleList( QList<MailCommon::SearchRule::Ptr> *aList );

    void setPatternEditOptions( SearchPatternEdit::SearchPatternEditOptions options );

public slots:
    void reset();
    void slotAddWidget( QWidget * );
    void slotRemoveWidget( QWidget * );

protected:
    virtual void clearWidget( QWidget *aWidget );
    virtual QWidget *createWidget( QWidget *parent );

private:
    void reconnectWidget( SearchRuleWidget *w );
    void updateAddRemoveButton();
    void regenerateRuleListFromWidgets();
    QList<MailCommon::SearchRule::Ptr> *mRuleList;
    SearchPatternEdit::SearchPatternEditOptions mOptions;
    SearchPatternEdit::SearchModeType mTypeMode;
};


}

#endif