FilterSetupItem Class Reference

This class is used in ConfigFilter to show the available filters in the list view and to store a filter setup. More...

#include <filtersetupitem.h>

List of all members.

Public Types

enum  Column { ColNumber = 0, ColName = 1, ColAction = 2 }

Public Member Functions

 FilterSetupItem (QTreeWidget *parent)
 FilterSetupItem (QTreeWidget *parent, uint num)
 ~FilterSetupItem ()
void setName (QString name)
QString getName () const
void setNumber (uint number)
uint getNumber () const
void setAction (int action)
int getAction () const
void setMailBox (QString mailbox)
QString getMailBox () const
void setCriteriaLinkage (int linkage)
int getCriteriaLinkage () const
void setCriteriaList (FilterCriteriaList_Type list)
FilterCriteriaList_Type getCriteriaList () const
void save ()
virtual int compare (FilterSetupItem *i, int col, bool ascending) const
void load ()

Protected Member Functions

void init ()
void updateActionColumn ()


Detailed Description

This class is used in ConfigFilter to show the available filters in the list view and to store a filter setup.

Author:
Ulrich Weigelt <ulrich.weigelt@gmx.de>

Definition at line 41 of file filtersetupitem.h.


Member Enumeration Documentation

Column Numbers.

Definition at line 49 of file filtersetupitem.h.


Constructor & Destructor Documentation

FilterSetupItem::FilterSetupItem ( QTreeWidget *  parent  ) 

General Constructor

Parameters:
parent the list view

Definition at line 20 of file filtersetupitem.cpp.

FilterSetupItem::FilterSetupItem ( QTreeWidget *  parent,
uint  num 
)

Constructor

Parameters:
parent the list view
num filter number

Definition at line 29 of file filtersetupitem.cpp.

FilterSetupItem::~FilterSetupItem (  ) 

Destructor

Definition at line 38 of file filtersetupitem.cpp.


Member Function Documentation

void FilterSetupItem::setName ( QString  name  ) 

Sets the filter name.

Parameters:
name filter name
See also:
name

getName

Definition at line 56 of file filtersetupitem.cpp.

QString FilterSetupItem::getName (  )  const

Returns the name of this filter.

Returns:
filter name
See also:
name

setName

Definition at line 64 of file filtersetupitem.cpp.

void FilterSetupItem::setNumber ( uint  number  ) 

Sets the filter number.

Parameters:
number filter number.
See also:
number

getNumber

Definition at line 69 of file filtersetupitem.cpp.

uint FilterSetupItem::getNumber (  )  const

Returns the filter number.

Returns:
filter number
See also:
number

setNumber

Definition at line 236 of file filtersetupitem.cpp.

void FilterSetupItem::setAction ( int  action  ) 

Sets the action. See constants.h for valid values (CONFIG_VALUE_FILTER_ACTION...).

Parameters:
action 
See also:
getAction

action

Definition at line 77 of file filtersetupitem.cpp.

int FilterSetupItem::getAction (  )  const

Returns the action of this filter. See constants.h for possible values (CONFIG_VALUE_FILTER_ACTION...).

Returns:
action code
See also:
setAction

action

Definition at line 218 of file filtersetupitem.cpp.

void FilterSetupItem::setMailBox ( QString  mailbox  ) 

Sets the mailbox of a move action.

Parameters:
mailbox name of the mailbox
See also:
setMailBox

mailbox

Definition at line 205 of file filtersetupitem.cpp.

QString FilterSetupItem::getMailBox (  )  const

Returns the mailbox name of a move action if this action is selected. Otherwise it returns an empty string.

Returns:
mailbox name
See also:
setMailBox

mailbox

Definition at line 223 of file filtersetupitem.cpp.

void FilterSetupItem::setCriteriaLinkage ( int  linkage  ) 

Sets the criteria linkage. Valid values are CONFIG_VALUE_FILTER_CRITERIA_LINKAGE_MATCH_ALL (all criterias have to satisy) or CONFIG_VALUE_FILTER_CRITERIA_LINKAGE_MATCH_ANY (at least one criteria has to satisy ).

Parameters:
linkage criteria linkage
See also:
linkage

Definition at line 184 of file filtersetupitem.cpp.

int FilterSetupItem::getCriteriaLinkage (  )  const

Returns the criteria linkage. Possible values are CONFIG_VALUE_FILTER_CRITERIA_LINKAGE_MATCH_ALL (all criterias have to satisy) or CONFIG_VALUE_FILTER_CRITERIA_LINKAGE_MATCH_ANY (at least one criteria has to satisy ).

Returns:
criteria linkage
See also:
setCriteriaLinkage

linkage

Definition at line 213 of file filtersetupitem.cpp.

void FilterSetupItem::setCriteriaList ( FilterCriteriaList_Type  list  ) 

Sets the criteria list.

Parameters:
list criteria list
See also:
criteriaList

getCriteriaList

Types::FilterCriteriaList_Type

Definition at line 200 of file filtersetupitem.cpp.

FilterCriteriaList_Type FilterSetupItem::getCriteriaList (  )  const

Returns the criteria list.

Returns:
criteria list
See also:
criteriaList

setCriteriaList

Types::FilterCriteriaList_Type

Definition at line 231 of file filtersetupitem.cpp.

void FilterSetupItem::save (  ) 

Saves the settings to the configuration file. The group is named CONFIG_GROUP_FILTER + filter number, e.g. Filter12.

Definition at line 99 of file filtersetupitem.cpp.

int FilterSetupItem::compare ( FilterSetupItem i,
int  col,
bool  ascending 
) const [virtual]

Compares this item to i using the column col in ascending order. Reutrns <0 if this item is less than i, 0 if they are equal and >0 if this item is greater than i. The parameter ascneding will be ignored.

Parameters:
i pointer to the second view item
col number of the sorted column
ascending ignored

Definition at line 241 of file filtersetupitem.cpp.

void FilterSetupItem::load (  ) 

Reads the settings from the config file. The group is named CONFIG_GROUP_FILTER + filter number, e.g. Filter12.

Definition at line 282 of file filtersetupitem.cpp.

void FilterSetupItem::init (  )  [protected]

Initializes the object.

Definition at line 42 of file filtersetupitem.cpp.

void FilterSetupItem::updateActionColumn (  )  [protected]

Updates the text of the rule column.

Definition at line 262 of file filtersetupitem.cpp.


The documentation for this class was generated from the following files:

Generated on Tue May 18 19:43:53 2010 for KShowmail by  doxygen 1.5.6