kmail Library API Documentation

KMSearchRuleWidget Class Reference

A widget to edit a single KMSearchRule. A widget to edit a single KMSearchRule. More...

#include <kmsearchpatternedit.h>

Inheritance diagram for KMSearchRuleWidget:

Inheritance graph
[legend]
Collaboration diagram for KMSearchRuleWidget:

Collaboration graph
[legend]
List of all members.

Public Types

enum  {
  Message, Body, AnyHeader, Recipients,
  Size, AgeInDays, Status
}

Public Slots

void slotFunctionChanged ()
void slotValueChanged ()

Signals

void fieldChanged (const QString &)
void contentsChanged (const QString &)

Public Member Functions

 KMSearchRuleWidget (QWidget *parent=0, KMSearchRule *aRule=0, const char *name=0, bool headersOnly=false, bool absoluteDates=false)
void setHeadersOnly (bool headersOnly)
void setRule (KMSearchRule *aRule)
KMSearchRulerule () const
void reset ()

Static Public Member Functions

int ruleFieldToId (const QString &i18nVal)

Protected Slots

void slotRuleFieldChanged (const QString &)

Protected Member Functions

int indexOfRuleField (const QCString &aName) const

Static Protected Member Functions

QCString ruleFieldToEnglish (const QString &i18nVal)

Detailed Description

A widget to edit a single KMSearchRule. A widget to edit a single KMSearchRule.

It consists of an editable QComboBox for the field, a read-only QComboBox for the function and a QLineEdit for the content or the pattern (in case of regexps). It manages the i18n itself, so field name should be in it's english form.

To use, you essentially give it the reference to a KMSearchRule and it does the rest. It will never delete the rule itself, as it assumes that something outside of it manages this.

Author:
Marc Mutz <Marc@Mutz.com>

Definition at line 39 of file kmsearchpatternedit.h.


Constructor & Destructor Documentation

KMSearchRuleWidget::KMSearchRuleWidget QWidget parent = 0,
KMSearchRule aRule = 0,
const char *  name = 0,
bool  headersOnly = false,
bool  absoluteDates = false
 

Constructor.

You can give a KMSearchRule as parameter, which will be used to initialize the widget.

Definition at line 51 of file kmsearchpatternedit.cpp.

References reset(), and setRule().


Member Function Documentation

void KMSearchRuleWidget::setHeadersOnly bool  headersOnly  ) 
 

Set whether only header fields can be searched.

If is true only header fields can be searched otherwise <message> and <body> searches are available also.

Definition at line 69 of file kmsearchpatternedit.cpp.

References KMSearchRule::field(), and rule().

void KMSearchRuleWidget::setRule KMSearchRule aRule  ) 
 

Set the rule.

The rule is accepted regardless of the return value of KMSearchRule::isEmpty. This widget makes a shallow copy of aRule and operates directly on it. If aRule is 0, resets itself, taks user input, but does essentially nothing. If you pass 0, you should probably disable it.

Definition at line 121 of file kmsearchpatternedit.cpp.

References KMSearchRule::field(), and indexOfRuleField().

Referenced by KMSearchRuleWidget().

KMSearchRule * KMSearchRuleWidget::rule  )  const
 

Return a reference to the currently-worked-on KMSearchRule.

Definition at line 147 of file kmsearchpatternedit.cpp.

References KMSearchRule::createInstance(), and ruleFieldToEnglish().

Referenced by setHeadersOnly().

void KMSearchRuleWidget::reset  ) 
 

Resets the rule currently worked on and updates the widget accordingly.

Definition at line 159 of file kmsearchpatternedit.cpp.

Referenced by KMSearchRuleWidget().

void KMSearchRuleWidget::fieldChanged const QString  )  [signal]
 

This signal is emitted whenever the user alters the field.

The pseudo-headers <...> are returned in their i18n form, but stored in their english form in the rule.

void KMSearchRuleWidget::contentsChanged const QString  )  [signal]
 

This signal is emitted whenever the user alters the contents/value of the rule.

QCString KMSearchRuleWidget::ruleFieldToEnglish const QString i18nVal  )  [static, protected]
 

Used internally to translate i18n-ized pseudo-headers back to english.

Definition at line 187 of file kmsearchpatternedit.cpp.

Referenced by rule().

int KMSearchRuleWidget::indexOfRuleField const QCString aName  )  const [protected]
 

Used internally to find the corresponding index into the field ComboBox.

Returns the index if found or -1 if the search failed,

Definition at line 205 of file kmsearchpatternedit.cpp.

Referenced by setRule().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 22:44:27 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003