Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.ui / src / org / simantics / ui / workbench / action / IWorkbenchActionHints.java

diff --git a/bundles/org.simantics.ui/src/org/simantics/ui/workbench/action/IWorkbenchActionHints.java b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/action/IWorkbenchActionHints.java
new file mode 100644 (file)
index 0000000..0d5e813
--- /dev/null
+++ b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/action/IWorkbenchActionHints.java
@@ -0,0 +1,45 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.ui.workbench.action;\r
+\r
+import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
+import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;\r
+\r
+/**\r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface IWorkbenchActionHints {\r
+\r
+    /**\r
+     * A hint for holding the currently active perspective id for use in other\r
+     * threads besides the SWT UI thread.\r
+     */\r
+    Key KEY_CURRENTPERSPECTIVE = new KeyOf(String.class);\r
+\r
+    /**\r
+     * A generic hint for stating whether to remember the result of a user\r
+     * action or not.\r
+     */\r
+    Key KEY_REMEMBER           = new KeyOf(Boolean.class);\r
+\r
+    /**\r
+     * A generic hint for stating whether to always ask for input from the user\r
+     * regardless of whether remembered setting could be used.\r
+     */\r
+    Key KEY_ALWAYS_ASK         = new KeyOf(Boolean.class);\r
+\r
+    /**\r
+     * A generic hint defining the source widget of an action.\r
+     */\r
+    Key KEY_WIDGET             = new KeyOf(Object.class);\r
+\r
+}\r