org.eclipse.ui.IKeyBindingService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui;

import org.eclipse.jface.action.IAction;

/**
 * The key binding service allows one to query or set the scope of Eclipse for
 * the purposes of resolving key assignments to commands, and to register
 * actions to handle specific commands. See the org.eclipse.ui.commands
 * extension point for details.
 * 
 * A participating workbench part is responsible to register all its actions
 * with this service. The part is also responsible to set the current scope.
 * 
 * 
 * This interface is not intended to be implemented or extended by clients.
 * 
 * 
 * @since 2.0
 * @deprecated See IContextService to manage scopes and
 * IHandlerService to manage handlers. IAction can
 * be proxied by org.eclipse.jface.commands.ActionHandler.
 */
public interface IKeyBindingService {

    /**
     * Returns the active accelerator scope ids.
     * 
     * @return the active accelerator scope ids.
     */
    String[] getScopes();

    /**
     * Registers an action with the key binding service.
     * 
     * @param action
     *            the action to be registered with the key binding service.
     */
    void registerAction(IAction action);

    /**
     * Sets the active accelerator scope ids.
     * 
     * @param scopes
     *            the active accelerator scope ids.
     */
    void setScopes(String[] scopes);

    /**
     * Unregisters an action with the key binding service.
     * 
     * @param action
     *            the action to be unregistered with the key binding service.
     */
    void unregisterAction(IAction action);
}