Mercurial > projects > dwt2

comparison org.eclipse.jface.text/src/org/eclipse/jface/text/IWidgetTokenOwnerExtension.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
1 /*******************************************************************************
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 *******************************************************************************/
13 module org.eclipse.jface.text.IWidgetTokenOwnerExtension;
14
15 import org.eclipse.jface.text.IWidgetTokenKeeper; // packageimport
16
17 import java.lang.all;
18
19 /**
20 * Extension interface for {@link org.eclipse.jface.text.IWidgetTokenOwner}.
21 * <p>
22 * Replaces the original <code>requestWidgetToken</code> functionality with a
23 * new priority based approach.
24 *
25 * @since 3.0
26 */
27 public interface IWidgetTokenOwnerExtension {
28
29 /**
30 * Requests the widget token from this token owner. Returns
31 * <code>true</code> if the token has been acquired or is
32 * already owned by the requester. This method is non-blocking.
33 *
34 * <p><code>priority</code> is forwarded to any existing token keeper
35 * to give it an estimate on whether the request has higher priority than
36 * the current keeper's. There is, however, no guarantee that another keeper
37 * will release the token even if it has a high priority.</p>
38 *
39 * @param requester the token requester
40 * @param priority the priority of the request
41 * @return <code>true</code> if requester acquires the token,
42 * <code>false</code> otherwise
43 */
44 bool requestWidgetToken(IWidgetTokenKeeper requester, int priority);
45 }