diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
commit | 6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch) | |
tree | a68f146d7fa01f0134297619fbe7e33db084e0aa /comm/mailnews/import/public/nsIImportFieldMap.idl | |
parent | Initial commit. (diff) | |
download | thunderbird-upstream.tar.xz thunderbird-upstream.zip |
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'comm/mailnews/import/public/nsIImportFieldMap.idl')
-rw-r--r-- | comm/mailnews/import/public/nsIImportFieldMap.idl | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/comm/mailnews/import/public/nsIImportFieldMap.idl b/comm/mailnews/import/public/nsIImportFieldMap.idl new file mode 100644 index 0000000000..83dc0ddfb1 --- /dev/null +++ b/comm/mailnews/import/public/nsIImportFieldMap.idl @@ -0,0 +1,71 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +/* + Field map interface for importing address books + + A field map is an arbitrary sized list of mozilla address book fields. + The field map is used by import to map fields from the import format + to mozilla fields. + For export, the map contains the ordered list of mozilla fields to + export! +*/ + +#include "nsISupports.idl" + +interface nsIAbCard; +interface nsIAbDirectory; + +[scriptable, uuid(deee9264-1fe3-47b1-b745-47b22de454e2)] +interface nsIImportFieldMap : nsISupports +{ + /* + Flag to indicate whether or not to skip the first record, + for instance csv files often have field names as the first + record + */ + attribute boolean skipFirstRecord; + + readonly attribute long numMozFields; + readonly attribute long mapSize; + + wstring GetFieldDescription(in long index); + + /* + Set the size of the field map, all unpopulated entries + will default to -1 + */ + void SetFieldMapSize(in long size); + + /* + Initialize the field map to a given size with default values + */ + void DefaultFieldMap(in long size); + + /* + Return the field number that this index maps to, -1 for no field + */ + long GetFieldMap(in long index); + + /* + Set the field that this index maps to, -1 for no field + */ + void SetFieldMap(in long index, in long fieldNum); + + /* + Return if this field is "active" in the map. + */ + boolean GetFieldActive(in long index); + + /* + Set the active state of this field + */ + void SetFieldActive(in long index, in boolean active); + + /* + Set the value of the given field in the database row + */ + void SetFieldValue(in nsIAbDirectory database, in nsIAbCard row, in long fieldNum, in AString value); +}; |