kftpgrabber/kftpgrabber/src/widgets/filtereditor.h

/*
 * This file is part of the KFTPGrabber project
 *
 * Copyright (C) 2003-2006 by the KFTPGrabber developers
 * Copyright (C) 2003-2006 Jernej Kos <kostko@jweb-network.net>
 *
 * 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
 * is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
 * NON-INFRINGEMENT.  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 Steet, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, 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 OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
#ifndef KFTPWIDGETSFILTEREDITOR_H
#define KFTPWIDGETSFILTEREDITOR_H

#include "widgetlister.h"
#include "misc/filter.h"

#include <tqwidget.h>
#include <tqpushbutton.h>
#include <tqgroupbox.h>
#include <tqlistview.h>
#include <tqradiobutton.h>
#include <tqcombobox.h>
#include <tqwidgetstack.h>
#include <tqcheckbox.h>

#include <kpushbutton.h>

namespace KFTPWidgets {

class ListView;

/**
 * A visual representation of a condition.
 *
 * @author Jernej Kos
 */
class FilterConditionWidget : public TQWidget {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterConditionWidget(TQWidget *parent);
    
    /**
     * Associate a condition with this widget.
     *
     * @param condition The internal condition representation
     */
    void setCondition(const KFTPCore::Filter::Condition *condition);
    
    /**
     * Return the condition associated with this widget.
     *
     * @return A valid condition or 0 if no condition has been associated
     */
    KFTPCore::Filter::Condition *condition() const { return m_condition; }
private slots:
    void slotFieldChanged(int field);
    void slotTypeChanged();
    void slotValueChanged();
private:
    TQComboBox *m_fieldCombo;
    TQWidgetStack *m_typeStack;
    TQWidgetStack *m_valueStack;
    
    KFTPCore::Filter::Condition *m_condition;
};

/**
 * A container for condition representation widgets.
 *
 * @author Jernej Kos
 */
class FilterConditionWidgetLister : public WidgetLister {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterConditionWidgetLister(TQWidget *parent);
    
    /**
     * Load the conditions from the specified rule.
     *
     * @param rule The rule instance
     */ 
    void loadConditions(KFTPCore::Filter::Rule *rule);
protected:
    TQWidget *createWidget(TQWidget *parent);
protected slots:
    void slotMore();
    void slotFewer();
    void slotClear();
private:
    KFTPCore::Filter::Rule *m_rule;
};

/**
 * A list of conditions together with all/any configuration.
 *
 * @author Jernej Kos
 */
class FilterConditionsList : public TQGroupBox {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterConditionsList(TQWidget *parent);
public slots:
    /**
     * Reset the condition list and disable it.
     */
    void reset();
    
    /**
     * Load the conditions from the specified rule.
     *
     * @param rule The rule instance
     */
    void loadRule(KFTPCore::Filter::Rule *rule);
private slots:
    void slotMatchTypeChanged(int type);
private:
    TQRadioButton *m_buttonAll;
    TQRadioButton *m_buttonAny;
    
    FilterConditionWidgetLister *m_lister;
    KFTPCore::Filter::Rule *m_rule;
};

/**
 * A visual representation of an action.
 *
 * @author Jernej Kos
 */
class FilterActionWidget : public TQWidget {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterActionWidget(TQWidget *parent);
    
    /**
     * Associate an action with this widget.
     *
     * @param action The internal action representation
     */
    void setAction(const KFTPCore::Filter::Action *action);
    
    /**
     * Return the action associated with this widget.
     *
     * @return A valid action or 0 if no action has been associated
     */
    KFTPCore::Filter::Action *action() const { return m_action; }
private slots:
    void slotActionChanged(int field);
    void slotValueChanged();
private:
    TQComboBox *m_actionCombo;
    TQWidgetStack *m_valueStack;
    
    KFTPCore::Filter::Action *m_action;
};

/**
 * A container for action representation widgets.
 *
 * @author Jernej Kos
 */
class FilterActionWidgetLister : public WidgetLister {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterActionWidgetLister(TQWidget *parent);
    
    /**
     * Load the actions from the specified rule.
     *
     * @param rule The rule instance
     */ 
    void loadActions(KFTPCore::Filter::Rule *rule);
protected:
    TQWidget *createWidget(TQWidget *parent);
protected slots:
    void slotMore();
    void slotFewer();
    void slotClear();
private:
    KFTPCore::Filter::Rule *m_rule;
};

/**
 * A list of actions.
 *
 * @author Jernej Kos
 */
class FilterActionsList : public TQGroupBox {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterActionsList(TQWidget *parent);
public slots:
    /**
     * Reset the action list and disable it.
     */
    void reset();
    
    /**
     * Load the actions from the specified rule.
     *
     * @param rule The rule instance
     */
    void loadRule(KFTPCore::Filter::Rule *rule);
private:
    FilterActionWidgetLister *m_lister;
    KFTPCore::Filter::Rule *m_rule;
};

/**
 * A widget that displays the list of currently loaded filter rules.
 *
 * @author Jernej Kos
 */
class FilterListView : public TQGroupBox {
Q_OBJECT
public:
    /**
     * Class constructor.
     *
     * @param parent Parent widget
     */
    FilterListView(TQWidget *parent);
    
    /**
     * Reset the filter editor and reload all the rules.
     */
    void reset();
private slots:
    void slotSelectionChanged(TQListViewItem *item);
    
    void slotNewRule();
    void slotDeleteRule();
    void slotRenameRule();
    void slotCopyRule();
    
    void slotUp();
    void slotDown();
private:
    ListView *m_listView;
    
    KPushButton *m_buttonUp;
    KPushButton *m_buttonDown;
    
    TQPushButton *m_buttonNew;
    TQPushButton *m_buttonCopy;
    TQPushButton *m_buttonDelete;
    TQPushButton *m_buttonRename;
signals:
    /**
     * This signal gets emitted when a new rule should be displayed by
     * other widgets.
     *
     * @param rule The rule to display
     */
    void ruleChanged(KFTPCore::Filter::Rule *rule);
    
    /**
     * This signal gets emitted when a rule is removed.
     */
    void ruleRemoved();
};

/**
 * An item visually representing a filter rule.
 *
 * @author Jernej Kos
 */
class FilterListItem : public TQListViewItem {
public:
    /**
     * Class constructor.
     *
     * @param parent The parent list view
     * @param rule Rule this item represents
     */
    FilterListItem(ListView *parent, KFTPCore::Filter::Rule *rule);
    
    /**
     * Get the rule this item represents.
     */
    KFTPCore::Filter::Rule *rule() { return m_rule; }
private:
    KFTPCore::Filter::Rule *m_rule;
};

/**
 * This widget is a global filter editor and enables the user to add,
 * remove or modify existing filters.
 *
 * @author Jernej Kos
 */
class FilterEditor : public TQWidget {
Q_OBJECT
public:
    /**
     * Class constructor.
     */
    FilterEditor(TQWidget *parent);
    
    /**
     * Reset the filter editor and reload all the rules.
     */
    void reset();
private slots:
    void slotRuleChanged(KFTPCore::Filter::Rule *rule);
    void slotRuleRemoved();
    
    void slotEnabledChanged();
private:
    KFTPCore::Filter::Rule *m_rule;
    
    TQCheckBox *m_enabledCheck;
    FilterListView *m_listView;
    FilterConditionsList *m_conditionsList;
    FilterActionsList *m_actionsList;
};

}

#endif