Public Member Functions

nsIAbItem Interface Reference

A containable item for address books. More...

import "nsIAbItem.idl";

Inheritance diagram for nsIAbItem:

List of all members.

Public Member Functions

AString generateName (in long aGenerateFormat,[optional] in nsIStringBundle aBundle)
 Generate a name from the item for display purposes.

Public Attributes

const unsigned long GENERATE_DISPLAY_NAME = 0
 These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.
const unsigned long GENERATE_LAST_FIRST_ORDER = 1
 These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.
const unsigned long GENERATE_FIRST_LAST_ORDER = 2
 These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.

Detailed Description

A containable item for address books.


Member Function Documentation

AString nsIAbItem::generateName ( in long  aGenerateFormat,
[optional] in nsIStringBundle  aBundle 
)

Generate a name from the item for display purposes.

If this item is an nsIAbCard, then it will use the aGenerateFormat option to determine the string to return. If this item is not an nsIAbCard, then the aGenerateFormat option may be ignored, and the displayName of the item returned.

Parameters:
aGenerateFormat The format to generate as per the GENERATE_* constants above.
aBundle An optional parameter that is a pointer to a string bundle that holds: chrome://messenger/locale/addressbook/addressBook.properties If this bundle is not supplied, then the function will obtain the bundle itself. If cached by the caller and supplied to this function, then performance will be improved over many calls.
Returns:
A string containing the generated name.

Member Data Documentation

const unsigned long nsIAbItem::GENERATE_DISPLAY_NAME = 0

These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.

They are intended to be used in generateName, defined below.

const unsigned long nsIAbItem::GENERATE_FIRST_LAST_ORDER = 2

These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.

They are intended to be used in generateName, defined below.

const unsigned long nsIAbItem::GENERATE_LAST_FIRST_ORDER = 1

These constants reflect the possible values of the mail.addr_book.lastnamefirst preferences.

They are intended to be used in generateName, defined below.


The documentation for this interface was generated from the following file: