kmail

#include <kmsearchpatternedit.h>

Inherits TQWidget.

List of all members.

Public Types

enum  {
  Message, Body, AnyHeader, Recipients,
  Size, AgeInDays, Status, Subject,
  From, To, CC, ReplyTo,
  Organization
}

Public Slots

void slotFunctionChanged ()
void slotValueChanged ()

Signals

void fieldChanged (const TQString &)
void contentsChanged (const TQString &)

Public Member Functions

 KMSearchRuleWidget (TQWidget *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

static int ruleFieldToId (const TQString &i18nVal)

Protected Slots

void slotRuleFieldChanged (const TQString &)

Protected Member Functions

int indexOfRuleField (const TQCString &aName) const

Static Protected Member Functions

static TQCString ruleFieldToEnglish (const TQString &i18nVal)

Detailed Description

A widget to edit a single KMSearchRule.

It consists of an editable TQComboBox for the field, a read-only TQComboBox for the function and a TQLineEdit 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.

A widget to edit a single KMSearchRule.

Author:
Marc Mutz <Marc@Mutz.com>

Definition at line 40 of file kmsearchpatternedit.h.


Constructor & Destructor Documentation

KMSearchRuleWidget::KMSearchRuleWidget ( TQWidget *  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 57 of file kmsearchpatternedit.cpp.


Member Function Documentation

void KMSearchRuleWidget::contentsChanged ( const TQString &  ) [signal]

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

void KMSearchRuleWidget::fieldChanged ( const TQString &  ) [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.

int KMSearchRuleWidget::indexOfRuleField ( const TQCString &  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 228 of file kmsearchpatternedit.cpp.

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

Definition at line 171 of file kmsearchpatternedit.cpp.

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

Definition at line 159 of file kmsearchpatternedit.cpp.

TQCString KMSearchRuleWidget::ruleFieldToEnglish ( const TQString &  i18nVal) [static, protected]

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

Definition at line 199 of file kmsearchpatternedit.cpp.

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 75 of file kmsearchpatternedit.cpp.

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 133 of file kmsearchpatternedit.cpp.


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