mirror of
https://github.com/rn10950/RetroZilla.git
synced 2024-09-21 04:20:41 +02:00
88 lines
3.7 KiB
Plaintext
88 lines
3.7 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Dan Mosedale <dmose@netscape.com> (Original Author)
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsILDAPAutoCompFormatter.idl"
|
|
|
|
/**
|
|
* An interface for formatter LDAP messages to be used as nsAutoCompleteItems
|
|
* for use in RFC 2822 message headers.
|
|
*/
|
|
[scriptable, uuid(cde8836e-1dd1-11b2-baff-a6d918243e80)]
|
|
interface nsIAbLDAPAutoCompFormatter: nsILDAPAutoCompFormatter {
|
|
|
|
/**
|
|
* All three Format attributes are templates, which work as follows:
|
|
*
|
|
* Required LDAP attributes are delimited by curly braces, and
|
|
* optional LDAP attributes are determined by brackets. Backslash
|
|
* escapes any character, including itself. Someday perhaps we'll rev
|
|
* this interface and change these to a more flexible format; perhaps
|
|
* something regexp based.
|
|
*
|
|
* If any of these are unset, components implementing this interface
|
|
* are free to choose reasonable defaults. As an example, the
|
|
*"@mozilla.org/ldap-autocomplete-formatter;1?type=addrbook"
|
|
* implementation currently happens to use the following default
|
|
* strings:
|
|
*
|
|
* nameFormat: "[cn]"
|
|
* addressFormat: "{mail}"
|
|
* commentFormat: ""
|
|
*
|
|
* and generates autocomplete items like this:
|
|
*
|
|
* value: John Doe <john.doe@foo.org>
|
|
* comment: Foo Organization
|
|
*
|
|
* Note that nsILDAPAutoCompFormatter::getAttributes() is only
|
|
* required to be called by the nsILDAPAutoCompleteSession
|
|
* implementation when the nsILDAPAutoCompleteSession::formatter
|
|
* IDL attribute is set. So if for some reason the format
|
|
* attributes exposed through this interface get changed (eg a
|
|
* user changes their prefs), it is the changing code's
|
|
* responsibly to re-set the nsILDAPAutoCompleteSession::formatter
|
|
* IDL attribute to the same object to force a new getAttributes()
|
|
* call.
|
|
*/
|
|
|
|
attribute AString nameFormat;
|
|
attribute AString addressFormat;
|
|
attribute AString commentFormat;
|
|
};
|