Class CLogFilter

CLogFilter

Support

Supported from 6.0

Description

Specifies the conditions that events must satisfy to appear in a view.

In general, a filter is used to construct the ‘WHERE’ clause of an SQL statement based on the content of the filter's fields. The filter's fields correspond to the event properties in a log event detail object, i.e. an instance of the CLogEvent class.

Derivation

CBase Base class for all classes to be instantiated on the heap CLogFilter Specifies the conditions that events must satisfy to appear in a view

Defined in CLogFilter:
ClearFlags(), Contact(), Copy(), Direction(), DurationType(), EventType(), Flags(), NewL(), NullFields(), Number(), RemoteParty(), SetContact(), SetDirection(), SetDurationType(), SetEventType(), SetFlags(), SetNullFields(), SetNumber(), SetRemoteParty(), SetStatus(), Status(), ~CLogFilter()

Inherited from CBase:
operator new()

See also:

• CLogEvent
• CLogViewEvent
• CLogViewRecent
• CLogViewDuplicate

static CLogFilter* NewL();

Description

Creates a new filter object.

All fields in the new instance are initialised to default values, so that if none of the fields are changed, the filter has no effect on the selection of events in view.

Return value

CLogFilter* A pointer to the new event object.

~CLogFilter();

Description

Frees all resource owned by the object prior to its destruction.

void SetEventType(TUid aType);

Description

Sets the event type to be used by the filter.

Parameters

TUid aType The event type UID.

See also:

• CLogEvent::SetEventType()

TUid EventType() const;

Description

Gets the event type used by the filter.

Return value

TUid The event type UID.

See also:

• CLogEvent::EventType()

void SetContact(TContactItemId aContact);

Description

Sets the contact ID to be used by the filter.

Parameters

TContactItemId aContact The contact ID.

See also:

• CLogEvent::SetContact()

TContactItemId Contact() const;

Description

Gets the contact ID used by the filter.

Return value

TContactItemId The contact ID.

See also:

• CLogEvent::Contact()

void SetDirection(const TDesC& aDirection);

Description

Sets the direction string to be used by the filter.

Parameters

const TDesC& aDirection The direction string.

See also:

• CLogEvent::SetDirection()

const TDesC& Direction() const;

Description

Gets the direction string used by the filter.

Return value

TDesC& A non-modifiable descriptor containing the direction string.

See also:

• CLogEvent::Direction()

void SetDurationType(TLogDurationType aType);

Description

Sets the duration type to be used by the filter.

Parameters

TLogDurationType aType The duration type.

See also:

• CLogEvent::SetDurationType()

TLogDurationType DurationType() const;

Description

Gets the duration type used by the filter.

Return value

TLogDurationType The duration type.

See also:

• CLogEvent::DurationType()

void SetNumber(const TDesC& aNumber);

Description

Sets the phone number to be used by the filter.

Parameters

const TDesC& aNumber The phone number.

See also:

• CLogEvent::SetNumber()

const TDesC& Number() const;

Description

Gets the phone number used by the filter.

Return value

TDesC& A non-modifiable descriptor containing the phone number.

See also:

• CLogEvent::Number()

void SetStatus(const TDesC& aStatus);

Description

Sets the delivery status to be used by the filter.

Parameters

const TDesC& aStatus The delivery status.

See also:

• CLogEvent::SetStatus()

const TDesC& Status() const;

Description

Gets the delivery status used by the filter.

Return value

TDesC& A non-modifiable descriptor containing the delivery status.

See also:

• CLogEvent::Status()

void SetRemoteParty(const TDesC& aRemote);

Description

Sets the remote party string to be used by the filter.

Parameters

const TDesC& aRemote The remote party string.

See also:

• CLogEvent::SetRemoteParty()

const TDesC& RemoteParty() const;

Description

Gets the remote party string used by the filter.

Return value

TDesC& A non-modifiable descriptor containing the remote party string.

See also:

• CLogEvent::RemoteParty()

void SetNullFields(TUint32 aFields);

Description

Defines NULL fields to the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.

Each field is identified by a bit value. The bit values may be ORd together in any combination.

Note that setting a flag and explicitly setting a value for the corresponding field generates an OR condition in the SQL WHERE clause.

Parameters

TUint32 aFields Bit values defining the null fields. These are one or more of the following values defined in logwrap.hrh: ELogContactField, ELogDirectionField,ELogDurationTypeField,ELogEventTypeField,ELogNumberField,ELogRemotePartyField,ELogStatusField,ELogFlagsField,ELogSubjectField,ELogLinkFieldandELogDataField.

See also:

• Using filter fields

TUint32 NullFields() const;

Description

Identifies the fields defined as NULL in the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.

Return value

TUint32 Bit values defining the null fields.

See also:

• SetNullFields()

void Copy(const CLogFilter& aFilter);

Description

Makes a copy of a filter.

Parameters

const CLogFilter& aFilter The filter object to be copied.

void SetFlags(TLogFlags aFlags);

Description

Sets the specified flags to be used by the filter.

Parameters

TLogFlags aFlags The flags to be set.

void ClearFlags(TLogFlags aFlags);

Description

Clears the specified flags to be used by the filter.

The constant KLogFlagsMask can be used to clear all the flags.

Parameters

TLogFlags aFlags The flags to be cleared

TLogFlags Flags() const;

Description

Gets the flags used by the filter.

Return value

TLogFlags The flags.