IDebugPreferenceConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 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   *     QNX Software Systems - Mikhail Khodjaiants - Registers View (Bug 53640)
11   *******************************************************************************/
12  package org.eclipse.debug.internal.ui.preferences;
13  
14  
15  import org.eclipse.debug.ui.IDebugUIConstants;
16   
17  /**
18   * Constants defining the keys to be used for accessing preferences
19   * inside the debug ui plugin's preference bundle.
20   *
21   * In descriptions (of the keys) below describe the preference 
22   * stored at the given key. The type indicates type of the stored preferences
23   *
24   * The preference store is loaded by the plugin (DebugUIPlugin).
25   * @see DebugUIPlugin.initializeDefaultPreferences(IPreferenceStore) - for initialization of the store
26   */
27  public interface IDebugPreferenceConstants {
28  
29      /**
30       * The symbolic names for colors for displaying the content in the Console
31       * @see org.eclipse.jface.resource.ColorRegistry
32       */
33      public static final String   CONSOLE_SYS_ERR_COLOR= "org.eclipse.debug.ui.errorColor"; //$NON-NLS-1$
34      public static final String   CONSOLE_SYS_OUT_COLOR= "org.eclipse.debug.ui.outColor"; //$NON-NLS-1$
35      public static final String   CONSOLE_SYS_IN_COLOR= "org.eclipse.debug.ui.inColor"; //$NON-NLS-1$
36      public static final String   CONSOLE_BAKGROUND_COLOR= "org.eclipse.debug.ui.consoleBackground"; //$NON-NLS-1$
37      
38      /**
39       * @deprecated use IDebugUIConstants.PREF_MEMORY_HISTORY_UNKNOWN_COLOR instead
40       */
41      public static final String   MEMORY_VIEW_UNBUFFERED_LINE_COLOR = IDebugUIConstants.PLUGIN_ID + ".MemoryViewLineColor"; //$NON-NLS-1$
42      
43      /**
44       * @deprecated use IDebugUIConstants.PREF_MEMORY_HISTORY_KNOWN_COLOR instead
45       */
46      public static final String   MEMORY_VIEW_BUFFERED_LINE_COLOR = IDebugUIConstants.PLUGIN_ID + ".MemoryViewBufferedLineColor"; //$NON-NLS-1$
47      
48      /**
49       * (boolean) Whether or not the text in the console will wrap
50       */
51      public static final String   CONSOLE_WRAP= "Console.wrap"; //$NON-NLS-1$
52      
53      /**
54       * (int) The maximum console character width, if wrapping. 
55       */ 
56      public static final String   CONSOLE_WIDTH = "Console.width"; //$NON-NLS-1$
57      
58      /**
59       * (boolean) Whether or not the console view is shown 
60       * when there is program output.
61       */
62      public static final String   CONSOLE_OPEN_ON_OUT= "DEBUG.consoleOpenOnOut"; //$NON-NLS-1$
63      /**
64       * (boolean) Whether or not the console view is shown 
65       * when there is program error.
66       */
67      public static final String   CONSOLE_OPEN_ON_ERR= "DEBUG.consoleOpenOnErr"; //$NON-NLS-1$
68      
69      /**
70       * Console buffer high and low water marks
71       */
72      public static final String   CONSOLE_LIMIT_CONSOLE_OUTPUT = "Console.limitConsoleOutput"; //$NON-NLS-1$
73      public static final String   CONSOLE_LOW_WATER_MARK = "Console.lowWaterMark"; //$NON-NLS-1$ 
74      public static final String   CONSOLE_HIGH_WATER_MARK = "Console.highWaterMark"; //$NON-NLS-1$
75      
76      /**
77       * Integer preference specifying the number of spaces composing a
78       * tab in the console.
79       * 
80       * @since 3.0
81       */
82      public static final String   CONSOLE_TAB_WIDTH= "Console.console_tab_width"; //$NON-NLS-1$
83      
84      
85      
86      /**
87       * The orientation of the detail view in the VariablesView
88       */
89      public static final String   VARIABLES_DETAIL_PANE_ORIENTATION = "Variables.detail.orientation"; //$NON-NLS-1$
90      public static final String   EXPRESSIONS_DETAIL_PANE_ORIENTATION = "Expressions.detail.orientation"; //$NON-NLS-1$
91      public static final String   REGISTERS_DETAIL_PANE_ORIENTATION = "Registers.detail.orientation"; //$NON-NLS-1$
92      public static final String   VARIABLES_DETAIL_PANE_RIGHT = "Variables.detail.orientation.right"; //$NON-NLS-1$
93      public static final String   VARIABLES_DETAIL_PANE_UNDERNEATH = "Variables.detail.orientation.underneath"; //$NON-NLS-1$
94      public static final String   VARIABLES_DETAIL_PANE_HIDDEN = "Variables.detail.orientation.hidden"; //$NON-NLS-1$
95      
96      /**
97       * Memento for the last selected launch config in the
98       * launch config dialog.
99       * 
100      * @deprecated no longer supported
101      */
102     public static final String   PREF_LAST_LAUNCH_CONFIGURATION_SELECTION = IDebugUIConstants.PLUGIN_ID + ".lastLaunchConfigSelection"; //$NON-NLS-1$
103         
104     /**
105      * The maximum size of the launch history list
106      */
107     public static int MAX_LAUNCH_HISTORY_SIZE= 40;
108 
109     /**
110      * Boolean preference controlling whether the text in the detail panes is
111      * wrapped. When <code>true</code> the text in the detail panes will be
112      * wrapped in new variable view.
113      *
114      * @since 2.1
115      */
116     public static final String   PREF_DETAIL_PANE_WORD_WRAP = IDebugUIConstants.PLUGIN_ID + ".detail_pane_word_wrap"; //$NON-NLS-1$
117     
118     /**
119      * Column size preference for the Memory View
120      * 
121      * @since 3.0
122      */
123     public static final String   PREF_COLUMN_SIZE = "org.eclipse.debug.ui.memory.columnSize"; //$NON-NLS-1$
124     
125     /**
126      * Default column size for the Memory View
127      * 
128      * @since 3.0
129      */
130     public static final int PREF_COLUMN_SIZE_DEFAULT = 4;
131     
132     
133     /**
134      * Row size preference for Memory View
135      * 
136      * @since 3.2
137      */
138     public static final String   PREF_ROW_SIZE = "org.eclipse.debug.ui.memory.rowSize"; //$NON-NLS-1$
139     
140     /**
141      * Default row size for the Memory View
142      * 
143      * @since 3.2
144      */
145     public static final int PREF_ROW_SIZE_DEFAULT = 16;
146     
147     /**
148      * Stores the boolean preference of whether to prompt when removing all breakpoints.
149      * @since 3.3
150      */
151     public static final String   PREF_PROMPT_REMOVE_ALL_BREAKPOINTS = IDebugUIConstants.PLUGIN_ID + ".remove_all_breakpoints_prompt"; //$NON-NLS-1$
152         
153     /**
154      * stroes the boolean preference of whether or not to promtp wehen removing all of the breakpopints form a breakpoints
155      * container.
156      * @since 3.3 
157      */
158     public static final String   PREF_PROMPT_REMOVE_BREAKPOINTS_FROM_CONTAINER = IDebugUIConstants.PLUGIN_ID + ".remove_breakpoints_from_container_prompt"; //$NON-NLS-1$
159     
160     /**
161      * Default padded string for renderings
162      * 
163      * @since 3.1
164      */
165     public static final String   PREF_PADDED_STR_DEFAULT = "??"; //$NON-NLS-1$
166     
167     /**
168      * Default ASCII code page if ASCII code page preference is not set.
169      * @since 3.1
170      */
171     public static final String   DEFAULT_ASCII_CP = "CP1252"; //$NON-NLS-1$
172     
173     
174     /**
175      * Default EBCDIC code page if EBCDIC code page preference is not set.
176      * @since 3.1
177      */
178     public static final String   DEFAULT_EBCDIC_CP = "CP037"; //$NON-NLS-1$
179     
180     /**
181      * Preference to determine if table rendering should dynamically load
182      * memory as the user scrolls
183      * 
184      * @since 3.1
185      */
186     public static final String   PREF_DYNAMIC_LOAD_MEM = "org.eclpise.debug.ui.memory.dynamicLoad"; //$NON-NLS-1$
187     
188     
189     /**
190      * Size of buffer in a table rendering when dynamic loading mode is off.
191      * 
192      * @since 3.1
193      */
194     public static final String   PREF_TABLE_RENDERING_PAGE_SIZE = "org.eclispe.debug.ui.memory.pageSize"; //$NON-NLS-1$
195     
196     /**
197      * Default page size when dynamic loading mode is off.  This preference is stored
198      * in number of lines.
199      * 
200      * @since 3.1
201      */
202     public static final int DEFAULT_PAGE_SIZE = 20;
203     /**
204      * Preference for defining behavior when resetting a memory monitor.
205      * Possible values:
206      * - RESET_AL - reset all renderings regardless if they are visible or not
207      * - RESET_VISIBLE - reset visible renderings
208      * 
209      * @since 3.2
210      */
211     public static final String   PREF_RESET_MEMORY_BLOCK = IDebugUIConstants.PLUGIN_ID + ".reset_memory_block"; //$NON-NLS-1$
212     
213     /**
214      * Constant to indicate that the memory view will reset all memory renderings when the reset
215      * memory monitor action is invoked.
216      * 
217      * @since 3.2
218      */
219     public static final String   RESET_ALL = IDebugUIConstants.PLUGIN_ID + "resetMemoryBlock.all"; //$NON-NLS-1$
220     
221     
222     /**
223      * Constant to indicate that the memory view will reset visible memory renderings when
224      * the reset memory monitor action is invoked
225      * 
226      * @since 3.2
227      */
228     public static final String   RESET_VISIBLE = IDebugUIConstants.PLUGIN_ID + "resetMemoryBlock.visible"; //$NON-NLS-1$
229     
230     /**
231      * Preference identifier for the row size in a table rendering.
232      * This preference is expected to be saved by an </code>IPersistableDebugElement</code>.  
233      * Memory Blocks can optionally provide and save this preference to customize
234      * the initial format of a table rendering.
235      * 
236      * The value of this property is an Integer.  The value can be one of the
237      * following values:  1, 2, 4, 8, 16.  This value must be greater than 
238      * <code>PREF_COL_SIZE_BY_MODEL</code> and must also be divisible by <code>PREF_COL_SIZE_BY_MODEL</code>.
239      * 
240      * @since 3.2
241      */
242     public static final String   PREF_ROW_SIZE_BY_MODEL = "org.eclipse.debug.ui.AbstractTableRendering.rowSize"; //$NON-NLS-1$
243     /**
244      * Preference identifier for the column size in a table rendering.
245      * This preference is expected to be saved by an <code>IPersistableDebugElement</code>.  
246      * Memory Blocks can optionally provide and save this preference to customize
247      * the initial format of a table rendering.
248      * 
249      * The value of this property is an Integer.  The value can be one of the
250      * following values:  1, 2, 4, 8, 16.  This value must be smaller than
251      * <code>PREF_ROW_SIZE_BY_MODEL</code>.  <code>PREF_ROW_SIZE_BY_MODEL</code> must be divisible by <code>PREF_COL_SIZE_BY_MODEL</code>.
252      * 
253      * @since 3.2
254      */
255     public static final String   PREF_COL_SIZE_BY_MODEL = "org.eclipse.debug.ui.AbstractTableRendering.colSize"; //$NON-NLS-1$
256     
257     /**
258      * Number of lines to preload before the visible region in the table rendering
259      * 
260      * @since 3.3
261      */
262     public static final String   PREF_TABLE_RENDERING_PRE_BUFFER_SIZE = "org.eclispe.debug.ui.memory.preBufferSize"; //$NON-NLS-1$
263     
264     /**
265      * Number of lines to preload after the visible region in the table rendering
266      * 
267      * @since 3.3
268      */
269     public static final String   PREF_TABLE_RENDERING_POST_BUFFER_SIZE = "org.eclispe.debug.ui.memory.postBufferSize"; //$NON-NLS-1$
270 
271 }
272 
273 
274 
275
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags