blob: 807f461ca3f860f5a68765078b6e08e84ead2396 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2020 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Semion Chichelnitsky (semion@il.ibm.com) - bug 278064
* Tristan Hume - <trishume@gmail.com> -
* Fix for Bug 2369 [Workbench] Would like to be able to save workspace without exiting
* Implemented workbench auto-save to correctly restore state in case of crash.
* Denis Zygann <d.zygann@web.de> - Bug 330453
* Axel Richard <axel.richard@obeo.fr> - Bug 486644
* Christian Georgi (SAP SE) - Bug 540440
*******************************************************************************/
package org.eclipse.ui.internal;
/**
* The IPreferenceConstants are the internal constants used by the Workbench.
*/
public interface IPreferenceConstants {
// Boolean: true = single click opens editor; false = double click opens
// it.
String OPEN_ON_SINGLE_CLICK = "OPEN_ON_SINGLE_CLICK"; //$NON-NLS-1$
// Boolean: true = select on hover;
String SELECT_ON_HOVER = "SELECT_ON_HOVER"; //$NON-NLS-1$
// Boolean: true = open after delay
String OPEN_AFTER_DELAY = "OPEN_AFTER_DELAY"; //$NON-NLS-1$
// Boolean: true = bidi support enabled; false = bidi support disabled
String BIDI_SUPPORT = "BIDI_SUPPORT"; //$NON-NLS-1$
// String: Text direction. May have the following values: "ltr", "rtl",
// "auto", and "".
String TEXT_DIRECTION = "TEXT_DIRECTION"; //$NON-NLS-1$
// String: Layout direction. May have the following values:
// SWT.LEFT_TO_RIGHT, SWT.RIGHT_TO_LEFT, and SWT.NONE.
String LAYOUT_DIRECTION = "LAYOUT_DIRECTION"; //$NON-NLS-1$
// String: Unicode locale extensions
String NL_EXTENSIONS = "NL_EXTENSIONS"; //$NON-NLS-1$
// Do we show color icons in toolbars?
String COLOR_ICONS = "COLOR_ICONS"; //$NON-NLS-1$
// mappings for type/extension to an editor
String EDITORS = "editors"; //$NON-NLS-1$
String RESOURCES = "resourcetypes"; //$NON-NLS-1$
// saving perspective layouts
String PERSPECTIVES = "perspectives"; //$NON-NLS-1$
// (int) If > 0, an editor will be reused once 'N' editors are opened.
String REUSE_EDITORS = "REUSE_OPEN_EDITORS"; //$NON-NLS-1$
// On/Off option for the two preceding options.
String REUSE_EDITORS_BOOLEAN = "REUSE_OPEN_EDITORS_BOOLEAN"; //$NON-NLS-1$
// (int) N recently viewed files will be listed in the File->Open Recent
// menu.
String RECENT_FILES = "RECENT_FILES"; //$NON-NLS-1$
// (int) Mode for opening a new perspective
String OPEN_PERSP_MODE = "OPEN_PERSPECTIVE_MODE"; //$NON-NLS-1$
int OPM_ACTIVE_PAGE = 0;
// int OPM_NEW_PAGE = 1;
int OPM_NEW_WINDOW = 2;
// Identifier for enabled decorators
String ENABLED_DECORATORS = "ENABLED_DECORATORS"; //$NON-NLS-1$
// Boolean: true = keep cycle part dialog open when keys released
String STICKY_CYCLE = "STICKY_CYCLE"; //$NON-NLS-1$
// List of plugins but that extends "startup" extension point but are
// overriden by the user.
// String of plugin unique ids separated by ";"
String PLUGINS_NOT_ACTIVATED_ON_STARTUP = "PLUGINS_NOT_ACTIVATED_ON_STARTUP"; //$NON-NLS-1$
// Separator for PLUGINS_NOT_ACTIVATED_ON_STARTUP
char SEPARATOR = ';';
// Preference key for default editors
String DEFAULT_EDITORS = "defaultEditors"; //$NON-NLS-1$
// Preference key for default editors
String DEFAULT_EDITORS_CACHE = "defaultEditorsCache"; //$NON-NLS-1$
// Tab width = tab height * scalar value
String EDITOR_TAB_WIDTH = "EDITOR_TAB_WIDTH"; //$NON-NLS-1$
// Boolean: true = show Editors drop down button on CTabFolder
String EDITORLIST_PULLDOWN_ACTIVE = "EDITORLIST_PULLDOWN_ACTIVE"; //$NON-NLS-1$
// Selection scope for EditorList
String EDITORLIST_SELECTION_SCOPE = "EDITORLIST_SELECTION_SCOPE"; //$NON-NLS-1$
int EDITORLIST_SET_WINDOW_SCOPE = 0;
int EDITORLIST_SET_PAGE_SCOPE = 1;
int EDITORLIST_SET_TAB_GROUP_SCOPE = 2;
// Sort criteria for EditorList
String EDITORLIST_SORT_CRITERIA = "EDITORLIST_SORT_CRITERIA"; //$NON-NLS-1$
int EDITORLIST_NAME_SORT = 0;
int EDITORLIST_MRU_SORT = 1;
// Max entries shown in the progress view (see DetailedProgressViewer)
String MAX_PROGRESS_ENTRIES = "MAX_PROGRESS_ENTRIES"; //$NON-NLS-1$
/**
* Boolean; true = EditorList displays full path
*/
String EDITORLIST_DISPLAY_FULL_NAME = "EDITORLIST_DISPLAY_FULL_NAME"; //$NON-NLS-1$
/**
* Workbench preference id for determining whether the user has chosen to
* override some of the settings in the current presentation.
* <p>
* The default value for this preference is: <code>false</code> (prompt)
* </p>
*
* @since 3.2
*/
String OVERRIDE_PRESENTATION = "overridepresentation"; // $//$NON-NLS-1$
/**
* <p>
* The key for the preference indicating which tab is selected in the keys
* preference page when last okay was pressed. This value should never really be
* directly edited by a user.
* </p>
* <p>
* This preference is an <code>int</code> value. The default value is
* <code>0</code>.
* </p>
*
* @since 3.1
*/
String KEYS_PREFERENCE_SELECTED_TAB = "KEYS_PREFERENCE_SELECTED_TAB"; //$NON-NLS-1$
/**
* <p>
* The key for the preference indicating whether multi-stroke key sequences
* should provide assistance to the user. This means that if the user pauses
* after pressing the first key, a window will open showing the possible
* completions.
* </p>
* <p>
* This preference is a <code>boolean</code> value. The default value is
* <code>false</code>.
* </p>
*
* @since 3.0
*/
String MULTI_KEY_ASSIST = "MULTI_KEY_ASSIST"; //$NON-NLS-1$
/**
* <p>
* The key for the preference indicating how long the assist window should wait
* before opening. This is a value in milliseconds -- from the time the first
* key in a multi-key is received by the system, to the time the assist window
* should appear.
* </p>
* <p>
* This preference is an <code>int</code> value. The default value is
* <code>1000</code>.
* </p>
*
* @since 3.0
*/
String MULTI_KEY_ASSIST_TIME = "MULTI_KEY_ASSIST_TIME"; //$NON-NLS-1$
/**
* Workbench preference to use the new IPersistableEditor interface throughout
* the workbench new editor/open editor calls.
*
* @since 3.3
*/
String USE_IPERSISTABLE_EDITORS = "USE_IPERSISTABLE_EDITORS"; //$NON-NLS-1$
/**
* Preference to show user jobs in a dialog.
*/
String RUN_IN_BACKGROUND = "RUN_IN_BACKGROUND"; //$NON-NLS-1$
/**
* Workbench preference id for determining whether the user will be prompted for
* activity enablement. If this is false then activities are enabled
* automatically. If it is true, then the user is only prompted for activities
* that they have not already declared a disinterest in via the prompt dialog.
* <p>
* The default value for this preference is: <code>true</code> (prompt)
* </p>
*
* @since 3.0
*/
String SHOULD_PROMPT_FOR_ENABLEMENT = "shouldPromptForEnablement"; //$NON-NLS-1$
/**
* Preference to show/hide the CoolBar.
*
* @since 3.6
*/
String COOLBAR_VISIBLE = "coolBarVisible"; //$NON-NLS-1$
/**
* Preference to show/hide the PerspectiveBar.
*
* @since 3.6
*/
String PERSPECTIVEBAR_VISIBLE = "perspectiveBarVisible"; //$NON-NLS-1$
/**
* Preference is not supported anymore
* </p>
*
* @since 3.4
*
* @deprecated
*/
@Deprecated
String USE_32_THREADING = "use32Threading"; //$NON-NLS-1$
/**
* Preference value that specifies the time interval in minutes between
* workbench auto-saves. If the value is zero it disables workbench auto-save.
*
* @since 3.105
*/
String WORKBENCH_SAVE_INTERVAL = "WORKBENCH_SAVE_INTERVAL"; //$NON-NLS-1$
/**
* This preference is the threshold value to determine whether a document is
* large or not. When the user tries to open a file larger than the threshold,
* then EditorSelectionDialog will be opened, suggesting the user to open with
* an external editor.
* <p>
* This preference is a <code>long</code> value that represents the threshold in
* bytes. The default value is <code>0</code> meaning no prompting on editor
* opening.
* </p>
*
* @since 3.7
*/
String LARGE_DOC_SIZE_FOR_EDITORS = "LARGE_DOC_SIZE_FOR_EDITORS"; //$NON-NLS-1$
/**
* This preference specifies file types which support a custom editor for large
* files.
* <p>
* This preference is a <code>String</code> value that list comma-separated file
* extensions (without a dot), for which a custom editor is specified when the
* input file exceeds a given file size.
* </p>
*
* @since 3.124.100
*/
String LARGE_FILE_LIMITS = "largeFileLimits"; //$NON-NLS-1$
/**
* Preference id for whether the editors may save automatically.
* <p>
* The boolean default value for this preference is: <code>false</code>.
* </p>
*
* @since 3.8
*/
String SAVE_AUTOMATICALLY = "SAVE_AUTOMATICALLY"; //$NON-NLS-1$
/**
* Preference value that specifies the time interval in seconds between editors
* auto-saves.
* <p>
* The integer default value for this preference is: <code>60</code>.
* </p>
*
* @since 3.8
*/
String SAVE_AUTOMATICALLY_INTERVAL = "SAVE_AUTOMATICALLY_INTERVAL"; //$NON-NLS-1$
/**
* Preference for whether pressed command keys are to be visualized
* <p>
* The boolean default value for this preference is: <code>false</code>.
* </p>
*
* @since 3.119
*/
String SHOW_KEYS_ENABLED_FOR_KEYBOARD = "showCommandKeysForKeyboard"; //$NON-NLS-1$
/**
* Preference for whether pressed command keys are to be visualized
* <p>
* The boolean default value for this preference is: <code>false</code>.
* </p>
*
* @since 3.119
*/
String SHOW_KEYS_ENABLED_FOR_MOUSE_EVENTS = "showCommandKeysForMouseEvents"; //$NON-NLS-1$
/**
* Preference for the time (in ms) after the command keys UI is to be closed
* <p>
* The integer default value for this preference is: <code>3000</code>.
* </p>
*
* @since 3.115
*/
String SHOW_KEYS_TIME_TO_CLOSE = "showCommandKeys_timeToClose"; //$NON-NLS-1$
}