/* -*- 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.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */

//////////////////////////////////////////////////////////////////////////
//                                                                      //
// Name:        FrameListMenu.h                                         //
//                                                                      //
// Description:	A menu class for listing all the xfe windows.           //
//              This class can be used with both XmCascadeButton and    //
//              XfeCascade widgets.                                     //
//                                                                      //
// Author:		Ramiro Estrugo <ramiro@netscape.com>                    //
//                                                                      //
//////////////////////////////////////////////////////////////////////////

#include "NotificationCenter.h"
#include "Frame.h"

#ifndef _xfe_window_list_menu_h_
#define _xfe_window_list_menu_h_

// This class can be used with a DYNA_CASCADEBUTTON or
// DYNA_MENUITEMS.

class XFE_FrameListMenu : public XFE_NotificationCenter
{
public:

	virtual ~XFE_FrameListMenu();

	// this function occupies the generateCallback slot in a menuspec.
	static void generate(Widget, void *, XFE_Frame *);

private:
	
	XFE_FrameListMenu(Widget, XFE_Frame *);
	
	// the toplevel component -- the thing we dispatch our events to.
	XFE_Frame *m_parentFrame;
	
	// the cascade button we're tied to.
	Widget m_cascade;
	
	// the row column we're in.
	Widget m_submenu;
	
	// this is the first slot we are using the code assumes that the 
	// dynamic portion of the menu is at the end, so we can destroy from
	// this index down.
	int m_firstslot;
	
	// this function is substituted as the cascadingCallback once the
	// object has been created, and is used from then on.
	static void update_cb(Widget, XtPointer, XtPointer);
	
	// callback added in generate() that destroys this object when the cascade button
	// is destroyed.
	static void destroy_cb(Widget, XtPointer, XtPointer);

	static void item_activate_cb(Widget, XtPointer, XtPointer);

 	static void cascading_cb(Widget, XtPointer, XtPointer);

	void cascading();
	void item_activate(Widget item);

	XP_List * getShownFrames();

};

#endif /* _xfe_window_list_menu_h_ */