gecko-dev/lib/libmsg/chngntfy.h

/* -*- Mode: C++; 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): 
 */

#ifndef _ChngNtfy_H_
#define _ChngNtfy_H_

#include "ptrarray.h"

class ChangeListener;
class MessageDBView;

class ChangeAnnouncer : public XPPtrArray  // array of ChangeListeners
{
public:
	ChangeAnnouncer();
	virtual ~ChangeAnnouncer();
	virtual XP_Bool AddListener(ChangeListener *listener);
	virtual XP_Bool RemoveListener(ChangeListener *listener);

	// convenience routines to notify all our ChangeListeners
	void NotifyViewChangeAll(MSG_ViewIndex startIndex, int32 numChanged, 
		MSG_NOTIFY_CODE changeType, ChangeListener *instigator);
	void NotifyViewStartChangeAll(MSG_ViewIndex startIndex, int32 numChanged, 
		MSG_NOTIFY_CODE changeType, ChangeListener *instigator);
	void NotifyViewEndChangeAll(MSG_ViewIndex startIndex, int32 numChanged, 
		MSG_NOTIFY_CODE changeType, ChangeListener *instigator);
	void NotifyKeyChangeAll(MessageKey keyChanged, int32 flags, 
		ChangeListener *instigator);
	void NotifyAnnouncerGoingAway(ChangeAnnouncer *instigator);
	void NotifyAnnouncerChangingView(ChangeAnnouncer *instigator, MessageDBView *newView);
};

class ChangeListener
{
public:
	ChangeListener();
	virtual ~ChangeListener();
	// do nothing notification routines - subclass to do something.
	// New notification routines need to be added here as do nothing routines
	virtual void OnViewChange(MSG_ViewIndex /*startInd*/, int32 /*numChanged*/, 
		MSG_NOTIFY_CODE /* changeType */, ChangeListener * /*instigator*/);
	virtual void OnViewStartChange(MSG_ViewIndex /*startInd*/, int32 /*numChanged*/, 
		MSG_NOTIFY_CODE /* changeType */, ChangeListener * /*instigator*/) ;
	virtual void OnViewEndChange(MSG_ViewIndex /*startInd*/, int32 /*numChanged*/, 
		MSG_NOTIFY_CODE /* changeType */, ChangeListener * /*instigator*/) ;
	virtual void OnKeyChange(MessageKey /*keyChanged*/, int32 /*flags*/, 
		ChangeListener * /*instigator*/) ;
	virtual void OnAnnouncerGoingAway(ChangeAnnouncer * /*instigator*/) ;
	virtual void OnAnnouncerChangingView(ChangeAnnouncer * /* instigator */, MessageDBView * /* view */) ;
};

#endif