| package org.eclipse.ui; |
| |
| /* |
| * Copyright (c) 2002 IBM Corp. All rights reserved. |
| * This file is 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 |
| */ |
| |
| import org.eclipse.jface.action.IAction; |
| import org.eclipse.swt.widgets.Event; |
| |
| /** |
| * This interface is a mixin interface for action delegates, adding the ability to |
| * examine the triggering SWT event when it is run. |
| * If an action delegate implements this interface, then <code>runWithEvent(IAction, Event)</code> |
| * is called instead of <code>run(IAction)</code>. |
| * <p> |
| * Clients should implement this interface, in addition to <code>IActionDelegate</code> |
| * (or subinterface), if they need to examine the triggering event. |
| * Otherwise, they should simply implement <code>IActionDelegate</code> (or subinterface). |
| * <p> |
| * NOTE: This is experimental API, which may change in the future. |
| * |
| * @since 2.0 |
| */ |
| public interface IActionDelegateWithEvent { |
| |
| /** |
| * Performs this action, passing the SWT event which triggered it. |
| * <p> |
| * This method is called when the delegating action has been triggered. |
| * Implement this method to do the actual work. |
| * If an action delegate implements this interface, this method |
| * is called instead of <code>run(IAction)</code>. |
| * <p> |
| * NOTE: This is experimental API, which may change in the future. |
| * |
| * @param action the action proxy that handles the presentation portion of the action |
| * @param event the SWT event which triggered this action being run |
| * @since 2.0 |
| */ |
| public void runWithEvent(IAction action, Event event); |
| |
| } |
