/* Filter Dialog * Author: Marc Mutz , * based upon work by Stefan Taferner * This code is under GPL */ #ifndef kmfilterdlg_h #define kmfilterdlg_h #include "kmfilter.h" #include "kmfilteraction.h" #include #include #include #include #include #include #include #include #include #include class KMSearchPatternEdit; class TQListBox; class TQPushButton; class TQComboBox; class TQWidgetStack; class TQCheckBox; class KIconButton; class KKeyButton; class KListView; /** This is a complex widget that is used to manipulate KMail's filter list. It consists of an internal list of filters, which is a deep copy of the list KMFilterMgr manages, a TQListBox displaying that list, and a few buttons used to create new filters, delete them, rename them and change the order of filters. It does not provide means to change the actual filter (besides the name), but relies on auxiliary widgets (KMSearchPatternEdit and KMFilterActionEdit) to do that. Communication with this widget is quite easy: simply create an instance, connect the signals filterSelected, resetWidgets and applyWidgets with a slot that does the right thing and there you go... This widget will operate on it's own copy of the filter list as long as you don't call slotApplyFilterChanges. It will then transfer the altered filter list back to KMFilterMgr. @short A complex widget that allows managing a list of KMFilter's. @author Marc Mutz , based upon work by Stefan Taferner . @see KMFilter KMFilterDlg KMFilterActionEdit KMSearchPatternEdit */ class KMFilterListBox : public TQGroupBox { Q_OBJECT TQ_OBJECT public: /** Constuctor. */ KMFilterListBox( const TQString & title, TQWidget* parent=0, const char* name=0, bool popFilter = false); /** Called from KMFilterDlg. Creates a new filter and presets the first rule with "field equals value". It's there mainly to support "rapid filter creation" from a context menu. You should instead call KMFilterMgr::createFilter. @see KMFilterMgr::createFilter KMFilterDlg::createFilter */ void createFilter( const TQCString & field, const TQString & value ); /** Loads the filter list and selects the first filter. Should be called when all signals are connected properly. If createDummyFilter is true, an empty filter is created to improve the usability of the dialog in case no filter has been defined so far.*/ void loadFilterList( bool createDummyFilter ); /** Returns wheather the global option 'Show Later Msgs' is set or not */ bool showLaterMsgs(); void insertFilter( KMFilter* aFilter ); void appendFilter( KMFilter* aFilter ); /** Returns a list of _copies_ of the current list of filters. * The list owns the contents and thus the caller needs to clean them * up. */ TQValueList filtersForSaving() const; signals: /** Emitted when a new filter has been selected by the user or if the current filter has changed after a 'new' or 'delete' operation. */ void filterSelected( KMFilter* filter ); /** Emitted when this widget wants the edit widgets to let go of their filter reference. Everyone holding a reference to a filter should update it from the contents of the widgets used to edit it and set their internal reference to 0. */ void resetWidgets(); /** Emitted when this widget wants the edit widgets to apply the changes to the current filter. */ void applyWidgets(); public slots: /** Called when the name of a filter might have changed (e.g. through changing the first rule in KMSearchPatternEdit). Updates the corresponding entry in the listbox and (if necessary) auto-names the filter. */ void slotUpdateFilterName(); /** Called when the user clicks either 'Apply' or 'OK' in KMFilterDlg. Updates the filter list in the KMFilterMgr. */ void slotApplyFilterChanges(); /** Called when the user toggles the 'Show Download Later Msgs' Checkbox in the Global Options section */ void slotShowLaterToggled(bool aOn); protected slots: /** Called when the user clicks on a filter in the filter list. Calculates the corresponding filter and emits the filterSelected signal. */ void slotSelected( int aIdx ); /** Called when the user clicks the 'New' button. Creates a new empty filter just before the current one. */ void slotNew(); /** Called when the user clicks the 'Copy' button. Creates a copy of the current filter and inserts it just before the current one. */ void slotCopy(); /** Called when the user clicks the 'Delete' button. Deletes the current filter. */ void slotDelete(); /** Called when the user clicks the 'Top' button. Moves the current filter to the top line. */ void slotTop(); /** Called when the user clicks the 'Up' button. Moves the current filter up one line. */ void slotUp(); /** Called when the user clicks the 'Down' button. Moves the current filter down one line. */ void slotDown(); /** Called when the user clicks the 'Bottom' button. Moves the current filter to the bottom line. */ void slotBottom(); /** Called when the user clicks the 'Rename' button. Pops up a dialog prompting to enter the new name. */ void slotRename(); void slotSelectSourceFolders(); protected: /** The deep copy of the filter list. */ TQPtrList mFilterList; /** The listbox displaying the filter list. */ TQListBox *mListBox; /** The various action buttons. */ TQPushButton *mBtnNew, *mBtnCopy, *mBtnDelete, *mBtnRename; TQPushButton *mBtnTop, *mBtnUp, *mBtnDown, *mBtnBot; /** The index of the currently selected item. */ int mIdxSelItem; bool mShowLater; private: void enableControls(); void swapFilters( int from, int to ); void swapNeighbouringFilters( int untouchedOne, int movedOne ); bool bPopFilter; }; /** This widgets allows to edit a single KMFilterAction (in fact any derived class that is registered in KMFilterActionDict). It consists of a combo box which allows to select the type of actions this widget should act upon and a TQWidgetStack, which holds the parameter widgets for the different rule types. You can load a KMFilterAction into this widget with setAction, and retrieve the result of user action with action. The widget will copy it's setting into the corresponding parameter widget. For that, it internally creates an instance of every KMFilterAction in KMFilterActionDict and asks each one to create a parameter widget. The parameter widgets are put on the widget stack and are raised when their corresponding action type is selected in the combo box. @short A widget to edit a single KMFilterAction. @author Marc Mutz @see KMFilterAction KMFilter KMFilterActionWidgetLister */ class KMFilterActionWidget : public TQHBox { Q_OBJECT TQ_OBJECT public: /** Constructor. Creates a filter action widget with no type selected. */ KMFilterActionWidget( TQWidget* parent=0, const char* name=0 ); /** Set an action. The action's type is determined and the corresponding widget it loaded with @p aAction's parameters and then raised. If @ aAction is 0, the widget is cleared. */ void setAction( const KMFilterAction * aAction ); /** Retrieve the action. This method is necessary because the type of actions can change during editing. Therefore the widget always creates a new action object from the data in the combo box and the widget stack and returns that. */ KMFilterAction *action(); private: /** This list holds an instance of every KMFilterAction subclass. The only reason that these 'slave' actions exist is that they are 'forced' to create parameter widgets for the widget stack and to clear them on setAction. */ TQPtrList mActionList; /** The combo box that contains the labels of all KMFilterActions. It's @p activated(int) signal is internally connected to the @p raiseWidget(int) slot of @p mWidgetStack. */ TQComboBox *mComboBox; /** The widget stack that holds all the parameter widgets for the filter actions. */ TQWidgetStack *mWidgetStack; }; class KMPopFilterActionWidget : public TQVButtonGroup { Q_OBJECT TQ_OBJECT public: KMPopFilterActionWidget( const TQString &title, TQWidget* parent=0, const char* name=0 ); void setAction( KMPopFilterAction aAction ); KMPopFilterAction action(); public slots: void reset(); private slots: void slotActionClicked(int aId); private: KMPopFilterAction mAction; KMFilter mFilter; TQMap mActionMap; TQMap mIdMap; signals: // Signals void actionChanged(const KMPopFilterAction aAction); }; class KMFilterActionWidgetLister : public KWidgetLister { Q_OBJECT TQ_OBJECT public: KMFilterActionWidgetLister( TQWidget *parent=0, const char* name=0 ); virtual ~KMFilterActionWidgetLister(); void setActionList( TQPtrList * aList ); /** Updates the action list according to the current widget values */ void updateActionList() { regenerateActionListFromWidgets(); } public slots: void reset(); protected: virtual void clearWidget( TQWidget *aWidget ); virtual TQWidget* createWidget( TQWidget *parent ); private: void regenerateActionListFromWidgets(); TQPtrList *mActionList; }; /** The filter dialog. This is a non-modal dialog used to manage KMail's filters. It should only be called through KMFilterMgr::openDialog. The dialog consists of three main parts: @li The KMFilterListBox in the left half allows the user to select a filter to be displayed using the widgets on the right half. It also has buttons to delete filters, add new ones, to rename them and to change their order (maybe you will be able to move the filters around by dragging later, and to optimise the filters by trying to apply them to all locally available KMMessage in turn and thus profiling which filters (and which rules of the search patterns) matches most often and sorting the filter/rules list according to the results, but I first want the basic functionality in place). @li The KMSearchPatternEdit in the upper-right quarter allows the user to modify the filter criteria. @li The KMFilterActionEdit in the lower-right quarter allows the user to select the actions that will be executed for any message that matches the search pattern. @li (tbi) There will be another widget that will allow the user to select to which folders the filter may be applied and whether it should be applied on outbound or inbound message transfers or both or none (meaning the filter is only applied when the user explicitly hits CTRL-J). I'm not sure whether there should be a per-folder filter list or a single list where you can select the names of folders this rule will be applied to. Upon creating the dialog, a (deep) copy of the current filter list is made by KMFilterListBox. The changed filters are local to KMFilterListBox until the user clicks the 'Apply' button. NOTE: Though this dialog is non-modal, it completely ignores all the stuff that goes on behind the scenes with folders esp. folder creation, move and create. The widgets that depend on the filter list and the filters that use folders as parameters are not updated as you expect. I hope this will change sometime soon. KMFilterDlg supports the creation of new filters through context menues, dubbed "rapid filters". Call KMFilterMgr::createFilter to use this. That call will be delivered to this dialog, which in turn delivers it to the KMFilterListBox. If you change the (DocBook) anchor for the filter dialog help, make sure to change @p const @p TQString @p KMFilterDlgHelpAnchor in kmfilterdlg.cpp accordingly. @short The filter dialog. @author Marc Mutz , based upon work by Stefan Taferner . @see KMFilter KMFilterActionEdit KMSearchPatternEdit KMFilterListBox */ class KMFilterDlg: public KDialogBase { Q_OBJECT TQ_OBJECT public: /** Create the filter dialog. The only class which should be able to do this is KMFilterMgr. This ensures that there is only a single filter dialog */ KMFilterDlg( TQWidget* parent=0, const char* name=0, bool popFilter=false, bool createDummyFilter=true ); /** Called from KMFilterMgr. Creates a new filter and presets the first rule with "field equals value". Internally forwarded to KMFilterListBox::createFilter. You should instead call KMFilterMgr::createFilter. */ void createFilter( const TQCString & field, const TQString & value ) { mFilterList->createFilter( field, value ); } public slots: /** Internally connected to KMFilterListBox::filterSelected. Just does a simple check and then calls KMSearchPatternEdit::setSearchPattern and KMFilterActionEdit::setActionList. */ void slotFilterSelected(KMFilter * aFilter); /** Action for popFilter */ void slotActionChanged(const KMPopFilterAction aAction); protected slots: void slotApplicabilityChanged(); void slotApplicableAccountsChanged(); void slotStopProcessingButtonToggled( bool aChecked ); void slotConfigureShortcutButtonToggled( bool aChecked ); void slotCapturedShortcutChanged( const KShortcut& ); void slotConfigureToolbarButtonToggled( bool aChecked ); void slotFilterActionIconChanged( TQString icon ); void slotReset(); void slotUpdateFilter(); void slotSaveSize(); // called when the dialog is closed (finished) void slotFinished(); // update the list of accounts shown in the advanced tab void slotUpdateAccountList(); /** Called when a user clicks the import filters button. Pops up * a dialog asking the user which file to import from and which * of the filters in that file to import. */ void slotImportFilters(); /** Called when a user clicks the export filters button. Pops up * a dialog asking the user which filters to export and which * file to export to. */ void slotExportFilters(); protected: /** The widget that contains the ListBox showing the filters, and the controls to remove filters, add new ones and to change their order. */ KMFilterListBox *mFilterList; /** The widget that allows editing of the filter pattern. */ KMSearchPatternEdit *mPatternEdit; /** The widget that allows editing of the filter actions. */ KMFilterActionWidgetLister *mActionLister; /** The widget that allows editing the popFilter actions. */ KMPopFilterActionWidget *mActionGroup; /** Lets the user select whether to apply this filter on inbound/outbound messages, both, or only on explicit CTRL-J. */ TQCheckBox *mApplyOnIn, *mApplyOnOut, *mApplyOnCtrlJ; /** For a filter applied to inbound messages selects whether to apply this filter to all accounts or to selected accounts only. */ TQRadioButton *mApplyOnForAll, *mApplyOnForTraditional, *mApplyOnForChecked; /** ListView that shows the accounts in the advanced tab */ KListView *mAccountList; TQCheckBox *mStopProcessingHere; TQCheckBox *mConfigureShortcut; TQCheckBox *mConfigureToolbar; TQLabel *mFilterActionLabel; KIconButton *mFilterActionIconButton; KKeyButton *mKeyButton; TQGroupBox *mAdvOptsGroup; TQVGroupBox *mGlobalsBox; TQCheckBox *mShowLaterBtn; KMFilter *mFilter; bool bPopFilter; }; #endif /*kmfilterdlg_h*/