summaryrefslogtreecommitdiffstats
path: root/mailnews/base/search/src/nsMsgFilterService.h
blob: 8fdc6a5cbded2d89321a0a13ceb71260b3ae9c37 (plain)
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
43
44
45
46
/* -*- 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/. */

#ifndef _nsMsgFilterService_H_
#define _nsMsgFilterService_H_

#include "nsIMsgFilterService.h"
#include "nsCOMArray.h"

class nsIMsgWindow;
class nsIStringBundle;



// The filter service is used to acquire and manipulate filter lists.

class nsMsgFilterService : public nsIMsgFilterService
{

public:
  nsMsgFilterService();

  NS_DECL_ISUPPORTS
  NS_DECL_NSIMSGFILTERSERVICE
/* clients call OpenFilterList to get a handle to a FilterList, of existing nsMsgFilter *.
  These are manipulated by the front end as a result of user interaction
   with dialog boxes. To apply the new list call MSG_CloseFilterList.
*/
  nsresult BackUpFilterFile(nsIFile *aFilterFile, nsIMsgWindow *aMsgWindow);
  nsresult AlertBackingUpFilterFile(nsIMsgWindow *aMsgWindow);
  nsresult ThrowAlertMsg(const char*aMsgName, nsIMsgWindow *aMsgWindow);
  nsresult GetStringFromBundle(const char *aMsgName, char16_t **aResult);
  nsresult GetFilterStringBundle(nsIStringBundle **aBundle);

protected:
  virtual ~nsMsgFilterService();

  nsCOMArray<nsIMsgFilterCustomAction> mCustomActions; // defined custom action list
  nsCOMArray<nsIMsgSearchCustomTerm> mCustomTerms; // defined custom term list

};

#endif  // _nsMsgFilterService_H_