| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <HTML> |
| <BODY> |
| <H1><CENTER>Accelerator Scopes</CENTER></H1> |
| <b><i>Identifier: </i></b>org.eclipse.ui.acceleratorScopes<p> |
| <b><i>Since: </i></b>Release 2.0<p> |
| <b><i>Description: </i></b>This extension point is used to register accelerator scope extensions. Accelerator scopes are scopes for which accelerator sets may be applicable. For example, if an accelerator set is applicable for the scope entitled "Text Editor Scope", the accelerators of that accelerator set will only operate if the "Text Editor Scope" or one of its children is active (in other words, if the active part is a participating text editor). |
| <p> |
| An accelerator set declares what scope it is applicable for by listing the scope's id as the value of its "scopeId" attribute (see the Accelerator Sets extension point). Many accelerator sets can be applicable for the same accelerator scope.<p><b><i>Configuration Markup:</i></b><p> |
| <p><samp> <!ELEMENT extension (acceleratorScope*)></samp> |
| <br><br><samp> <!ATTLIST extension</samp> |
| <br><samp> point CDATA #REQUIRED</samp> |
| <br><samp> id CDATA #IMPLIED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>point</b> - a fully qualified identifier of the target extension point</li><li><b>id</b> - an optional identifier of the extension instance</li><li><b>name</b> - an optional name of the extension instance</li></ul> |
| <p><samp> <!ELEMENT acceleratorScope EMPTY></samp> |
| <br><br><samp> <!ATTLIST acceleratorScope</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> description CDATA #REQUIRED</samp> |
| <br><samp> parentScope CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>id</b> - a unique name that can be used to identify this accelerator scope.</li><li><b>name</b> - a translatable name of the accelerator scope.</li><li><b>description</b> - a short description of the accelerator scope.</li><li><b>parentScope</b> - an optional attribute which represents a scope which is active whenever this scope is active. For most scopes, org.eclipse.ui.globalScope will be the parent scope</li></ul> |
| <b><i>Examples: </i></b>Following is an example of an accelerator scope extension: |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.acceleratorScopes"> |
| <acceleratorScope |
| id="org.eclipse.ui.globalScope" |
| name="Global" |
| description="Action accelerator key applicable to all views and editors unless explicitly overridden."> |
| </acceleratorScope> |
| <acceleratorScope |
| id="org.eclipse.ui.javaEditorScope" |
| name="Java Editor" |
| description="Action accelerator key applicable only when java editor active." |
| parentScope="org.eclipse.ui.globalScope"> |
| </acceleratorScope> |
| </extension> |
| </pre> |
| </p><p> |
| <b><i>API Information: </i></b>The method public IKeyBindingService getKeyBindingService() was added to IEditorSite.<p> |
| <b><i>Supplied Implementation: </i></b>The workbench provides the Global accelerator scope and the Text Editor accelerator scope.<p> |
| <p> |
| Copyright (c) 2002 IBM Corporation and others. |
| All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html<p> |
| </BODY> |
| </HTML> |
