KDE PIM / Developers / API Docs / kmail

KMSearchRuleWidget Class Reference

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

#include <kmsearchpatternedit.h>

Inherits QWidget.

List of all members.

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Static Protected Member Functions


Detailed Description

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

It consists of an editable

See also:
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
See also:
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>


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

See also:
KMSearchRule as parameter, which will be used to initialize the widget.

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.

void KMSearchRuleWidget::setRule KMSearchRule aRule  ) 
 

Set the rule.

The rule is accepted regardless of the return value of

See also:
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.

KMSearchRule * KMSearchRuleWidget::rule  )  const
 

Return a reference to the currently-worked-on.

See also:
KMSearchRule.

void KMSearchRuleWidget::reset  ) 
 

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

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.

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,


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