/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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 the Mozilla browser.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Joe Hewitt <hewitt@netscape.com> (Original Author)
 *   Stuart Morgan <stuart.morgan@alumni.case.edu>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#import <AppKit/AppKit.h>

@class HistoryItem;

// A class that builds and maintains a menu heirarchy parallel to some portion
// of the history backend.
@interface HistorySubmenu : NSMenu
{
  HistoryItem*          mRootItem;               // root history item for this menu (retained)
  HistoryItem*          mAdditionalItemsParent;  // may also contain children of this item (retained)

  int                   mNumIgnoreItems;         // if > 0, ignore the first N items (for "earlier today")
  BOOL                  mHistoryItemsDirty;      // whether we need to rebuild the items on next update
}

// Sets the root history item that this menu represents.
- (void)setRootHistoryItem:(HistoryItem*)inRootItem;

// Gets the root history item that this menu represents.
- (HistoryItem*)rootItem;

// Sets the menu to skip displaying the first |inIgnoreItems| history items.
- (void)setNumLeadingItemsToIgnore:(int)inIgnoreItems;

// Marks the history menu as needing to be rebuilt.
- (void)setNeedsRebuild:(BOOL)needsRebuild;

@end


// Encapsulates all of the logic of building, displaying, and handling the
// top-level "History" menu.
@interface TopLevelHistoryMenu : HistorySubmenu
{
  IBOutlet NSMenuItem*  mItemBeforeHistoryItems; // the item after which we add history items.
  HistoryItem*          mTodayItem;              // the "Today" history group
  NSMenu*               mRecentlyClosedMenu;     // the folder of recently closed pages

  BOOL                  mAppLaunchDone;          // has app launching completed?
}

@end
