gecko-dev/cmd/macfe/central/CTargetedUpdateMenuRegistry.h

91 строка
2.6 KiB
C++

/* -*- 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.
*/
// CTargetedUpdateMenuRegistry.h
//
// CTargetedUpdateMenuRegistry is used in conjunction with LEventDispatchers
// which are CTargetedUpdateMenuRegistry-aware to enable a more targeted
// update of menus.
//
// One common example of this is menu items whose text should change when
// certain modifiers are held down (Close -> Close All when optionKey is
// held down, for example).
//
// Usage notes for callers of UpdateMenus:
//
// (1) Call SetCommands with a list of commands which should be updated.
// (2) Call UpdateMenus.
//
// Usage notes for implementors of UpdateMenus:
//
// (1) When looping through commands in menus, determine if the registry
// is active by calling UseRegistryToUpdateMenus.
// (2) If the registry is active, then check to see if the command is
// in the registry by calling CommandInRegistry before processing
// command status for the command.
//
// Note: For the targeted update to be useful, there should generally be
// a very small number of targeted commands. In fact, command lookup will
// slow down if there are too many commands.
#ifndef CTargetedUpdateMenuRegistry_H
#define CTargetedUpdateMenuRegistry_H
#pragma once
// Includes
#include <list>
#include <algorithm>
#include <LCommander.h>
#include <LEventDispatcher.h>
// Class declaration
class CTargetedUpdateMenuRegistry
{
public:
// Interface for callers of UpdateMenus
static void SetCommands(const list<CommandT>& inCommands);
static void UpdateMenus();
// Interface for implementors of UpdateMenus
static Boolean CommandInRegistry(CommandT inCommand);
static Boolean UseRegistryToUpdateMenus();
private:
static Boolean sUseRegistryToUpdateMenus;
static list<CommandT> sCommands;
};
// Inline methods
inline
Boolean
CTargetedUpdateMenuRegistry::UseRegistryToUpdateMenus()
{
return sUseRegistryToUpdateMenus;
}
#endif