mailnews/base/search/public/nsIMsgSearchAdapter.idl


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */


#include "nsISupports.idl"
#include "nsIMsgSearchScopeTerm.idl"

[ptr] native nsMsgResultElement(nsMsgResultElement);

%{C++
class nsMsgResultElement;
%}

[scriptable, uuid(0b09078b-e0cd-440a-afee-01f45808ee74)]
interface nsIMsgSearchAdapter : nsISupports {
    void ValidateTerms();
    void Search(out boolean done);
    void SendUrl();
    void CurrentUrlDone(in nsresult exitCode);

    void AddHit(in nsMsgKey key);
    void AddResultElement(in nsIMsgDBHdr aHdr);

    [noscript] void OpenResultElement(in nsMsgResultElement element);
    [noscript] void ModifyResultElement(in nsMsgResultElement element,
                                        in nsMsgSearchValue value);

    readonly attribute string encoding;
    
    [noscript] nsIMsgFolder FindTargetFolder([const] in nsMsgResultElement
                                             element);
    void Abort();
    void getSearchCharsets(out AString srcCharset, out AString destCharset);
    /*
     * Clear the saved scope reference. This is used when deleting scope, which is not
     * reference counted in nsMsgSearchSession
     */
    void clearScope();
};