Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# PimRecord Class Reference
[qpepim module]

The PimRecord class is the base class for PIM data recorded in the Qtopia database. More...

`#include <qtopia/pim/pimrecord.h>`

Inherited by PimContact, PimContact, PimEvent, PimEvent, PimTask, PimTask, PimContact, PimEvent and PimTask.

List of all member functions.

## Public Members

- PimRecord ()
- PimRecord ( const PimRecord & other )
- virtual ~PimRecord ()
- virtual PimRecord & operator= ( const PimRecord & other )
- bool operator== ( const PimRecord & other ) const
- bool operator!= ( const PimRecord & other ) const
- void setCategories ( const QArray<int> & categories )
- void setCategories ( int id )
- QArray<int> categories () const
- virtual QString customField ( const QString & key ) const
- virtual void setCustomField ( const QString & key, const QString & value )
- virtual void removeCustomField ( const QString & key )
- QUuid uid () const

## Detailed Description

The PimRecord class is the base class for PIM data recorded in the Qtopia database.

The Pim record class contains data that is common to all data used by the PIM applications, in particular a unique ID and a set of categories.

A PimRecord's ID is returned by uid() and is set with setUid(). Each category is represented by an integer. A PimRecord's categories are returned by categories() and are set with setCategories().

PimRecord comparisons are provided by operator==() and operator!=().

See also Qtopia PIM Library.

## Member Function Documentation

### PimRecord::PimRecord ()

Creates an empty record.

### PimRecord::PimRecord ( const PimRecord & other )

Creates a clone of the record other.

### PimRecord::~PimRecord ()`[virtual]`

Destroys the record.

### QArray<int> PimRecord::categories () const

Returns the set of categories the record belongs to.

See also setCategories().

### QString PimRecord::customField ( const QString & key ) const`[virtual]`

Returns the string stored for the custom field key. Returns a null string if the field does not exist.

### bool PimRecord::operator!= ( const PimRecord & other ) const

Returns TRUE if the record does not have the same Uid as other; otherwise returns FALSE.

See also operator==().

### PimRecord & PimRecord::operator= ( const PimRecord & other )`[virtual]`

Sets the record to be a clone of other.

### bool PimRecord::operator== ( const PimRecord & other ) const

Returns TRUE if the record has the same Uid as other; otherwise returns FALSE.

See also operator!=().

### void PimRecord::removeCustomField ( const QString & key )`[virtual]`

Removes the custom field key.

### void PimRecord::setCategories ( const QArray<int> & categories )

Sets the record to belong to the set of categories specificed by categories.

See also categories().

### void PimRecord::setCategories ( int id )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Sets the record to belong only to the category specified by id.

See also categories().

### void PimRecord::setCustomField ( const QString & key, const QString & value )`[virtual]`

Sets the string stored for the custom field key to value.

### QUuid PimRecord::uid () const

Returns the unique ID for this record.

This file is part of the Qtopia platform, copyright © 1995-2004 Trolltech, all rights reserved.