зеркало из https://github.com/mozilla/pjs.git
Work in progress for command updating APIs. Not part of the build.
This commit is contained in:
sfraser%netscape.com
Родитель
c39284f26a
Коммит
3bbb6a5040
|
|
@ -24,33 +24,90 @@
|
|||
|
||||
#include "nsISupports.idl"
|
||||
#include "nsIObserver.idl"
|
||||
#include "nsICommandParams.idl"
|
||||
|
||||
/*
|
||||
* nsICommandManager is an interface used to executing user-level commands,
|
||||
* and getting the state of available commands.
|
||||
*
|
||||
* Commands are identified by strings, which are documented elsewhere.
|
||||
* In addition, the list of required and optional parameters for
|
||||
* each command, that are passed in via the nsICommandParams, are
|
||||
* also documented elsewhere. (Where? Need a good location for this).
|
||||
*/
|
||||
|
||||
|
||||
[scriptable, uuid(080D2001-F91E-11D4-A73C-F9242928207C)]
|
||||
interface nsICommandManager : nsISupports
|
||||
{
|
||||
/*
|
||||
* Register an observer on the specified command. The observer's Observe
|
||||
* method will get called when the state (enabled/disbaled, or toggled etc)
|
||||
* of the command changes.
|
||||
*
|
||||
* You can register the same observer on multiple commmands by calling this
|
||||
* multiple times.
|
||||
*/
|
||||
void addCommandObserver(in nsIObserver aCommandObserver,
|
||||
in DOMString aCommandToObserve);
|
||||
|
||||
void addCommandObserver(in nsIObserver aCommandObserver, in wstring aCommandToObserve);
|
||||
void removeCommandObserver(in nsIObserver aCommandObserver, in wstring aCommandObserved);
|
||||
/*
|
||||
* Stop an observer from observering the specified command. If the observer
|
||||
* was also registered on ther commands, they will continue to be observed.
|
||||
*
|
||||
* Passing an empty string in 'aCommandObserved' will remove the observer
|
||||
* from all commands.
|
||||
*/
|
||||
void removeCommandObserver(in nsIObserver aCommandObserver,
|
||||
in DOMString aCommandObserved);
|
||||
|
||||
boolean isCommandSupported(in wstring aCommandName);
|
||||
/*
|
||||
* Ask the command manager if the specified command is supported.
|
||||
*
|
||||
*/
|
||||
boolean isCommandSupported(in DOMString aCommandName);
|
||||
|
||||
boolean isCommandEnabled(in wstring aCommandName);
|
||||
/*
|
||||
* Ask the command manager if the specified command is currently.
|
||||
* enabled.
|
||||
*/
|
||||
boolean isCommandEnabled(in DOMString aCommandName);
|
||||
|
||||
wstring getCommandState(in wstring aCommandName);
|
||||
|
||||
void doCommand(in wstring aCommandName, in wstring aCommandParams);
|
||||
/*
|
||||
* Get the state of the specified commands.
|
||||
*
|
||||
* On input: aCommandParams filled in with values that the caller cares
|
||||
* about, most of which are command-specific (see the command documentation
|
||||
* for details). One boolean value, "enabled", applies to all commands,
|
||||
* and, in return will be set to indicate whether the command is enabled
|
||||
* (equivalent to calling isCommandEnabled).
|
||||
*
|
||||
* On output: aCommandParams: values set by the caller filled in with
|
||||
* state from the command.
|
||||
*/
|
||||
void getCommandState(in DOMString aCommandName,
|
||||
inout nsICommandParams aCommandParams);
|
||||
|
||||
/*
|
||||
* Execute the specified command.
|
||||
*
|
||||
* param: aCommandParams, a list of name-value pairs of command parameters,
|
||||
* may be null for parameter-less commands.
|
||||
*
|
||||
*/
|
||||
void doCommand(in DOMString aCommandName, in nsICommandParams aCommandParams);
|
||||
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
[scriptable, uuid()]
|
||||
interface nsIObserver : nsISupports
|
||||
{
|
||||
void Observe( in nsISupports aSubject, // The nsICommandManager calling this Observer
|
||||
in wstring aTopic, // Name of the command being updated
|
||||
in wstring someData ); // Command state (if available)
|
||||
};
|
||||
|
||||
Arguments to observers "Observe" method are as follows:
|
||||
|
||||
void Observe( in nsISupports aSubject, // The nsICommandManager calling this Observer
|
||||
in wstring aTopic, // Name of the command whose state changed
|
||||
in wstring aDummy ); // Unused string
|
||||
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,109 @@
|
|||
/* -*- Mode: C++; tab-width: 2; 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):
|
||||
* Simon Fraser <sfraser@netscape.com>
|
||||
*
|
||||
*/
|
||||
|
||||
#include "nsISupports.idl"
|
||||
|
||||
/*
|
||||
* nsICommandParams is used to pass parameters to commands executed
|
||||
* via nsICommandManager, and to get command state.
|
||||
*
|
||||
*/
|
||||
|
||||
[scriptable, uuid(83f892cf-7ed3-490e-967a-62640f3158e1)]
|
||||
interface nsICommandParams : nsISupports
|
||||
{
|
||||
|
||||
/*
|
||||
* List of primitive types for parameter values.
|
||||
*/
|
||||
const short eNoType = 0; /* Only used for sanity checking */
|
||||
const short eBooleanType = 1;
|
||||
const short eLongType = 2;
|
||||
const short eDoubleType = 3;
|
||||
const short eWStringType = 4;
|
||||
const short eISupportsType = 5;
|
||||
|
||||
/*
|
||||
* getValueType
|
||||
*
|
||||
* Get the type of a specified parameter
|
||||
*/
|
||||
short getValueType(in DOMString name);
|
||||
|
||||
/*
|
||||
* get_Value
|
||||
*
|
||||
* Get the value of a specified parameter. Will return
|
||||
* an error if the parameter does not exist, or if the value
|
||||
* is of the wrong type (no coercion is performed for you).
|
||||
*
|
||||
* nsISupports values can contain any XPCOM interface,
|
||||
* as documented for the command. It is permissible
|
||||
* for it to contain nsICommandParams, but not *this*
|
||||
* one (i.e. self-containing is not allowed).
|
||||
*/
|
||||
boolean getBooleanValue(in DOMString name);
|
||||
long getLongValue(in DOMString name);
|
||||
double getDoubleValue(in DOMString name);
|
||||
DOMString getStringValue(in DOMString name);
|
||||
nsISupports getISupportsValue(in DOMString name);
|
||||
|
||||
/*
|
||||
* set_Value
|
||||
*
|
||||
* Set the value of a specified parameter (thus creating
|
||||
* an entry for it).
|
||||
*
|
||||
* nsISupports values can contain any XPCOM interface,
|
||||
* as documented for the command. It is permissible
|
||||
* for it to contain nsICommandParams, but not *this*
|
||||
* one (i.e. self-containing is not allowed).
|
||||
*/
|
||||
void setBooleanValue(in DOMString name, in boolean value);
|
||||
void setLongValue(in DOMString name, in long value);
|
||||
void setDoubleValue(in DOMString name, in double value);
|
||||
void setStringValue(in DOMString name, in DOMString value);
|
||||
void setISupportsValue(in DOMString name, in nsISupports value);
|
||||
|
||||
/*
|
||||
* removeValue
|
||||
*
|
||||
* Remove the specified parameter from the list.
|
||||
*/
|
||||
void removeValue(in DOMString name);
|
||||
|
||||
/*
|
||||
* Enumeration methods
|
||||
*
|
||||
* Use these to enumerate over the contents of a parameter
|
||||
* list. For each name that getNext() returns, use
|
||||
* getValueType() and then getMumbleValue to get its
|
||||
* value.
|
||||
*/
|
||||
boolean hasMoreElements();
|
||||
void first();
|
||||
DOMString getNext();
|
||||
|
||||
};
|
||||
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
/* -*- Mode: C++; tab-width: 2; 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):
|
||||
* Simon Fraser <sfraser@netscape.com>
|
||||
*
|
||||
*/
|
||||
|
||||
#include "nsISupports.idl"
|
||||
#include "domstubs.idl"
|
||||
|
||||
/*
|
||||
The nsPICommandUpdater interface is used by modules that implement
|
||||
commands, to tell the command manager that commands need updating.
|
||||
This is a private interface; embedders should not use it.
|
||||
|
||||
Command-implementing modules should get one of these by a QI
|
||||
from an nsICommandManager.
|
||||
*/
|
||||
|
||||
[scriptable, uuid(B135F602-0BFE-11D5-A73C-F0E420E8293C)]
|
||||
interface nsPICommandUpdater : nsISupports
|
||||
{
|
||||
|
||||
/*
|
||||
* Init the command updater, passing an nsIDOMWindow which
|
||||
* is the window that the command updater lives on.
|
||||
*
|
||||
*/
|
||||
void init(in nsIDOMWindow aWindow);
|
||||
|
||||
/*
|
||||
* Notify the command manager that the status of a command
|
||||
* changed. It may have changed from enabled to disabled,
|
||||
* or vice versa, or become toggled etc.
|
||||
*/
|
||||
void commandStatusChanged(in DOMString aCommandName);
|
||||
|
||||
};
|
||||
|
||||
|
||||
Загрузка…
Ссылка в новой задаче