diff dwtx/jface/text/IWidgetTokenOwnerExtension.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/IWidgetTokenOwnerExtension.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2005 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
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.jface.text.IWidgetTokenOwnerExtension;
+
+import dwt.dwthelper.utils;
+
+/**
+ * Extension interface for {@link dwtx.jface.text.IWidgetTokenOwner}.
+ * <p>
+ * Replaces the original <code>requestWidgetToken</code> functionality with a
+ * new priority based approach.
+ *
+ * @since 3.0
+ */
+public interface IWidgetTokenOwnerExtension {
+
+    /**
+     * Requests the widget token from this token owner. Returns
+     * <code>true</code> if the token has been acquired or is
+     * already owned by the requester. This method is non-blocking.
+     *
+     * <p><code>priority</code> is forwarded to any existing token keeper
+     * to give it an estimate on whether the request has higher priority than
+     * the current keeper's. There is, however, no guarantee that another keeper
+     * will release the token even if it has a high priority.</p>
+     *
+     * @param requester the token requester
+     * @param priority the priority of the request
+     * @return <code>true</code> if requester acquires the token,
+     *  <code>false</code> otherwise
+     */
+    bool requestWidgetToken(IWidgetTokenKeeper requester, int priority);
+}