path: root/kftpgrabber/src/misc/filterwidgethandler.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 KFTPCORE_FILTERFILTERWIDGETHANDLER_H
#define KFTPCORE_FILTERFILTERWIDGETHANDLER_H

#include "filter.h"

#include <tqmap.h>
#include <tqwidget.h>
#include <tqwidgetstack.h>

namespace KFTPCore {

namespace Filter {

/**
 * This is an interface that any condition widget handlers must implement
 * in order to be registred with the manager. The handler handles several
 * widgets at once so it should not keep any member variables.
 *
 * @author Jernej Kos
 */
class ConditionWidgetHandler {
public:
    /**
     * This method has to return a new widget used for displaying condition
     * types. It is usually a combobox with several options. The returned
     * widget is added to the value widget stack.
     *
     * @param parent Widget to be used as parent for the newly created widget
     * @param receiver Object that receives type change notifications
     * @return A valid TQWidget instance
     */
    virtual TQWidget *createTypeWidget(TQWidget *parent, const TQObject *receiver) const = 0;
    
    /**
     * This method has to create one or several input widgets for different
     * condition types. Each widget has to be added to the widget stack. An
     * identifying widget name is recommended for each widget, so you can easily
     * access it from other methods which get the value stack widget passed as
     * an argument.
     *
     * @param stack Value widget stack
     * @param receiver Object that receives value change notifications
     */
    virtual void createValueWidgets(TQWidgetStack *stack, const TQObject *receiver) const = 0;
    
    /**
     * Update the status of all widgets.
     *
     * @param field The field to display
     * @param types Type widget stack to use
     * @param values Value widget stack to use
     */
    virtual void update(int field, TQWidgetStack *types, TQWidgetStack *values) const = 0;
    
    /**
     * Extract data from internal condition representation and show it to the
     * user using the created widgets.
     *
     * @param types Type widget stack to use
     * @param values Value widget stack to use
     * @param condition The condition representation
     */
    virtual void setCondition(TQWidgetStack *types, TQWidgetStack *values, const Condition *condition) = 0;
    
    /**
     * This method should return the currently selected condition type.
     *
     * @param widget The type widget previously created
     * @return A valid Condition::Type
     */
    virtual Condition::Type getConditionType(TQWidget *widget) const = 0;
    
    /**
     * This method should return the current condition value.
     *
     * @param values Value widget stack to use
     * @return A valid condition value
     */
    virtual TQVariant getConditionValue(TQWidgetStack *values) const = 0;
};

/**
 * This is an interface that any action widget handlers must implement
 * in order to be registred with the manager. The handler handles several
 * widgets at once so it should not keep any member variables.
 *
 * @author Jernej Kos
 */
class ActionWidgetHandler {
public:
    /**
     * This method has to return a new widget used for displaying the action
     * value. It is usually a line edit or a similar input widget. The returned
     * widget is added to the value widget stack.
     *
     * @param parent Widget to be used as parent for the newly created widget
     * @param receiver Object that receives type change notifications
     * @return A valid TQWidget instance
     */
    virtual TQWidget *createWidget(TQWidget *parent, const TQObject *receiver) const = 0;
    
    /**
     * Extract data from internal action representation and show it to the
     * user using the created widgets.
     *
     * @param stack Value widget stack to use
     * @param action The action representation
     */
    virtual void setAction(TQWidgetStack *stack, const Action *action) const = 0;
    
    /**
     * This method should return the current action value.
     *
     * @param values Value widget stack to use
     * @return A valid action value
     */
    virtual TQVariant getActionValue(TQWidget *widget) const = 0;
};

/**
 * This class keeps a list of all registred condition and action widget
 * handlers. It is a singleton.
 *
 * @author Jernej Kos
 */
class WidgetHandlerManager
{
public:
    /**
     * Get the global class instance.
     */
    static WidgetHandlerManager *self();
    
    /**
     * Class destructor.
     */
    ~WidgetHandlerManager();
    
    /**
     * Create widgets for all currently registred condition handlers.
     *
     * @param types Type widget stack to use
     * @param value Value widget stack to use
     * @param receiver Object that receives change notifications
     */
    void createConditionWidgets(TQWidgetStack *types, TQWidgetStack *values, const TQObject *receiver);
    
    /**
     * Create widgets for all currently registred action handlers.
     *
     * @param stack Value widget stack to use
     * @param receiver Object that receives change notifications
     */
    void createActionWidgets(TQWidgetStack *stack, const TQObject *receiver);
    
    /**
     * Update the specified condition widget handler.
     *
     * @param field New condition field
     * @param types Type widget stack to use
     * @param values Value widget stack to use
     */
    void update(Field field, TQWidgetStack *types, TQWidgetStack *values);
    
    /**
     * Extract data from internal condition representation and show it to the
     * user using the created widgets.
     *
     * @param types Type widget stack to use
     * @param values Value widget stack to use
     * @param condition The condition representation
     */
    void setCondition(TQWidgetStack *types, TQWidgetStack *values, const Condition *condition);
    
    /**
     * Get the currently selected condition type.
     *
     * @param field Condition field
     * @param types Type widget stack to use
     * @return A valid Condition::Type
     */
    Condition::Type getConditionType(Field field, TQWidgetStack *types);
    
    /**
     * Get the current condition value.
     *
     * @param field Condition field
     * @param values Value widget stack to use
     * @return A valid condition value
     */
    TQVariant getConditionValue(Field field, TQWidgetStack *values);
    
    /**
     * Extract data from internal action representation and show it to the
     * user using the created widgets.
     *
     * @param stack Value widget stack to use
     * @param action The action representation
     */
    void setAction(TQWidgetStack *stack, const Action *action);
    
    /**
     * Get the current action value.
     *
     * @param stack Value widget stack to use
     * @return A valid action value
     */
    TQVariant getActionValue(TQWidgetStack *stack);
    
    /**
     * Register a new condition handler with the manager.
     *
     * @param field Field that this handler handles
     * @param handler The actual handler instance
     */
    void registerConditionHandler(Field field, ConditionWidgetHandler *handler);
    
    /**
     * Register a new action handler with the manager.
     *
     * @param type Action type that this handler handles
     * @param handler The actual handler instance
     */
    void registerActionHandler(Action::Type type, ActionWidgetHandler *handler); 
protected:
    /**
     * Class constructor.
     */
    WidgetHandlerManager();
private:
    static WidgetHandlerManager *m_self;
    
    typedef TQMap<Field, ConditionWidgetHandler*> ConditionHandlerMap;
    ConditionHandlerMap m_conditionHandlers;
    
    typedef TQMap<Action::Type, ActionWidgetHandler*> ActionHandlerMap;
    ActionHandlerMap m_actionHandlers;
};

}

}

#endif