gecko-dev/mailnews/base/public/nsISubscribableServer.idl

92 строки
3.1 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
* Seth Spitzer <sspitzer@netscape.com>
*/
#include "nsISupports.idl"
#include "nsISupportsArray.idl"
interface nsIMsgWindow;
interface nsIMsgIncomingServer;
interface nsIRDFResource;
interface nsIRDFNode;
[scriptable, uuid(61a08c3a-1dd2-11b2-b64f-c4b2de1cf129)]
interface nsISubscribeDataSource : nsISupports {
readonly attribute boolean hasObservers;
void NotifyObservers(in nsIRDFResource subject, in nsIRDFResource property, in nsIRDFNode object, in boolean isAssert, in boolean isChange);
};
[scriptable, uuid(f337b84a-1dd1-11b2-97c7-fb8b2e3f2280)]
interface nsISubscribeListener : nsISupports {
void OnDonePopulating();
};
[scriptable, uuid(f0e703ba-1dd1-11b2-9dfd-d5be7140b673)]
interface nsISubscribeDumpListener : nsISupports {
void startDumping();
void dumpItem(in string name);
void doneDumping();
};
[scriptable, uuid(6f9d2e82-1dd2-11b2-bbed-bbea41ca33a7)]
interface nsISubscribableServer : nsISupports {
attribute nsISubscribeListener subscribeListener;
attribute char delimiter;
void startPopulating(in nsIMsgWindow aMsgWindow, in boolean forceToServer);
void startPopulatingWithUri(in nsIMsgWindow aMsgWindow, in boolean forceToServer, in string uri);
void stopPopulating(in nsIMsgWindow aMsgWindow);
// return true if state changed, false otherwise
boolean setState(in string path, in boolean state);
void subscribeCleanup();
void subscribe(in wstring name);
void unsubscribe(in wstring name);
void commitSubscribeChanges();
// other stuff
void setIncomingServer(in nsIMsgIncomingServer server);
void addTo(in string aName, in boolean addAsSubscribed, in boolean changeIfExists);
void setAsSubscribed(in string path);
void updateSubscribed();
void setShowFullName(in boolean showFullName);
// if path is null, use the root
boolean hasChildren(in string path);
// if path is null, use the root
boolean isSubscribed(in string path);
// if path is null, use the root
wstring getLeafName(in string path);
// if path is null, use the root
void getChildren(in string path, in nsISupportsArray array);
// if path is null, use the root
void getFirstChildURI(in string path, out string result);
// used for writing out the SubscribeTree
void setDumpListener(in nsISubscribeDumpListener dumpListener);
void dumpTree();
};