001: /*******************************************************************************
002: * Copyright (c) 2000, 2007 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: * Genady Beryozkin, me@genady.org - https://bugs.eclipse.org/bugs/show_bug.cgi?id=11668
011: * Benjamin Muskalla <b.muskalla@gmx.net> - https://bugs.eclipse.org/bugs/show_bug.cgi?id=41573
012: *******************************************************************************/package org.eclipse.ui.texteditor;
013:
014: import org.eclipse.jface.text.information.IInformationProvider;
015:
016: import org.eclipse.ui.IWorkbenchActionConstants;
017: import org.eclipse.ui.PlatformUI;
018:
019: /**
020: * Help context ids for the text editor.
021: * <p>
022: * This interface contains constants only; it is not intended to be implemented.
023: * </p>
024: */
025: public interface IAbstractTextEditorHelpContextIds {
026:
027: /**
028: * The string with which all other defined ids are prefixed to construct help context ids.
029: * Value: <code>"org.eclipse.ui."</code>
030: */
031: String PREFIX = PlatformUI.PLUGIN_ID + "."; //$NON-NLS-1$
032:
033: /**
034: * The string which is appended to action ids to construct help context ids.
035: * Value: <code>"_action_context"</code>
036: */
037: String ACTION_POSTFIX = "_action_context"; //$NON-NLS-1$
038:
039: /**
040: * Help context id for the action.
041: * Value: <code>"org.eclipse.ui.undo_action_context"</code>
042: */
043: String UNDO_ACTION = PREFIX + ITextEditorActionConstants.UNDO
044: + ACTION_POSTFIX;
045:
046: /**
047: * Help context id for the action.
048: * Value: <code>"org.eclipse.ui.redo_action_context"</code>
049: */
050: String REDO_ACTION = PREFIX + ITextEditorActionConstants.REDO
051: + ACTION_POSTFIX;
052:
053: /**
054: * Help context id for the action.
055: * Value: <code>"org.eclipse.ui.cut_action_context"</code>
056: */
057: String CUT_ACTION = PREFIX + ITextEditorActionConstants.CUT
058: + ACTION_POSTFIX;
059:
060: /**
061: * Help context id for the action.
062: * Value: <code>"org.eclipse.ui.copy_action_context"</code>
063: */
064: String COPY_ACTION = PREFIX + ITextEditorActionConstants.COPY
065: + ACTION_POSTFIX;
066:
067: /**
068: * Help context id for the action.
069: * Value: <code>"org.eclipse.ui.paste_action_context"</code>
070: */
071: String PASTE_ACTION = PREFIX + ITextEditorActionConstants.PASTE
072: + ACTION_POSTFIX;
073:
074: /**
075: * Help context id for the action.
076: * Value: <code>"org.eclipse.ui.delete_action_context"</code>
077: */
078: String DELETE_ACTION = PREFIX + ITextEditorActionConstants.DELETE
079: + ACTION_POSTFIX;
080:
081: /**
082: * Help context id for the action.
083: * Value: <code>"org.eclipse.ui.DeleteLine_action_context"</code>
084: * @since 2.0
085: */
086: String DELETE_LINE_ACTION = PREFIX
087: + ITextEditorActionConstants.DELETE_LINE + ACTION_POSTFIX;
088:
089: /**
090: * Help context id for the action.
091: * Value: <code>"org.eclipse.ui.JoinLines_action_context"</code>
092: * @since 3.3
093: */
094: String JOIN_LINES_ACTION = PREFIX
095: + ITextEditorActionConstants.JOIN_LINES + ACTION_POSTFIX;
096:
097: /**
098: * Help context id for the action.
099: * Value: <code>"org.eclipse.ui.CutLine_action_context"</code>
100: * @since 2.1
101: */
102: String CUT_LINE_ACTION = PREFIX
103: + ITextEditorActionConstants.CUT_LINE + ACTION_POSTFIX;
104:
105: /**
106: * Help context id for the action.
107: * Value: <code>"org.eclipse.ui.DeleteLineToBeginning_action_context"</code>
108: * @since 2.0
109: */
110: String DELETE_LINE_TO_BEGINNING_ACTION = PREFIX
111: + ITextEditorActionConstants.DELETE_LINE_TO_BEGINNING
112: + ACTION_POSTFIX;
113:
114: /**
115: * Help context id for the action.
116: * Value: <code>"org.eclipse.ui.CutLineToBeginning_action_context"</code>
117: * @since 2.1
118: */
119: String CUT_LINE_TO_BEGINNING_ACTION = PREFIX
120: + ITextEditorActionConstants.CUT_LINE_TO_BEGINNING
121: + ACTION_POSTFIX;
122:
123: /**
124: * Help context id for the action.
125: * Value: <code>"org.eclipse.ui.DeleteLineToEnd_action_context"</code>
126: * @since 2.0
127: */
128: String DELETE_LINE_TO_END_ACTION = PREFIX
129: + ITextEditorActionConstants.DELETE_LINE_TO_END
130: + ACTION_POSTFIX;
131:
132: /**
133: * Help context id for the action.
134: * Value: <code>"org.eclipse.ui.CutLineToEnd_action_context"</code>
135: * @since 2.1
136: */
137: String CUT_LINE_TO_END_ACTION = PREFIX
138: + ITextEditorActionConstants.CUT_LINE_TO_END
139: + ACTION_POSTFIX;
140:
141: /**
142: * Help context id for the action.
143: * Value: <code>"org.eclipse.ui.SetMark_action_context"</code>
144: * @since 2.0
145: */
146: String SET_MARK_ACTION = PREFIX
147: + ITextEditorActionConstants.SET_MARK + ACTION_POSTFIX;
148:
149: /**
150: * Help context id for the action.
151: * Value: <code>"org.eclipse.ui.ClearMark_action_context"</code>
152: * @since 2.0
153: */
154: String CLEAR_MARK_ACTION = PREFIX
155: + ITextEditorActionConstants.CLEAR_MARK + ACTION_POSTFIX;
156:
157: /**
158: * Help context id for the action.
159: * Value: <code>"org.eclipse.ui.SwapMark_action_context"</code>
160: * @since 2.0
161: */
162: String SWAP_MARK_ACTION = PREFIX
163: + ITextEditorActionConstants.SWAP_MARK + ACTION_POSTFIX;
164:
165: /**
166: * Help context id for the action.
167: * Value: <code>"org.eclipse.ui.selectAll_action_context"</code>
168: */
169: String SELECT_ALL_ACTION = PREFIX
170: + ITextEditorActionConstants.SELECT_ALL + ACTION_POSTFIX;
171:
172: /**
173: * Help context id for the action.
174: * Value: <code>"org.eclipse.ui.ShiftRight_action_context"</code>
175: */
176: String SHIFT_RIGHT_ACTION = PREFIX
177: + ITextEditorActionConstants.SHIFT_RIGHT + ACTION_POSTFIX;
178:
179: /**
180: * Help context id for the action.
181: * Value: <code>"org.eclipse.ui.ShiftLeft_action_context"</code>
182: */
183: String SHIFT_LEFT_ACTION = PREFIX
184: + ITextEditorActionConstants.SHIFT_LEFT + ACTION_POSTFIX;
185:
186: /**
187: * Help context id for the action.
188: * Value: <code>"org.eclipse.ui.find_action_context"</code>
189: */
190: String FIND_ACTION = PREFIX + ITextEditorActionConstants.FIND
191: + ACTION_POSTFIX;
192:
193: /**
194: * Help context id for the action.
195: * Value: <code>"org.eclipse.ui.FindNext_action_context"</code>
196: * @since 2.0
197: */
198: String FIND_NEXT_ACTION = PREFIX
199: + ITextEditorActionConstants.FIND_NEXT + ACTION_POSTFIX;
200:
201: /**
202: * Help context id for the action.
203: * Value: <code>"org.eclipse.ui.FindPrevious_action_context"</code>
204: * @since 2.0
205: */
206: String FIND_PREVIOUS_ACTION = PREFIX
207: + ITextEditorActionConstants.FIND_PREVIOUS + ACTION_POSTFIX;
208:
209: /**
210: * Help context id for the action.
211: * Value: <code>"org.eclipse.ui.goto_next_annotation_action_context"</code>
212: * @since 3.2
213: */
214: String GOTO_NEXT_ANNOTATION_ACTION = PREFIX
215: + "goto_next_annotation" + ACTION_POSTFIX; //$NON-NLS-1$
216:
217: /**
218: * Help context id for the action.
219: * Value: <code>"org.eclipse.ui.goto_previous_annotation_action_context"</code>
220: * @since 3.2
221: */
222: String GOTO_PREVIOUS_ANNOTATION_ACTION = PREFIX
223: + "goto_previous_annotation" + ACTION_POSTFIX; //$NON-NLS-1$
224:
225: /**
226: * Help context id for the action.
227: * Value: <code>"org.eclipse.ui.FindIncremental_action_context"</code>
228: * @since 2.0
229: */
230: String FIND_INCREMENTAL_ACTION = PREFIX
231: + ITextEditorActionConstants.FIND_INCREMENTAL
232: + ACTION_POSTFIX;
233: /**
234: * Help context id for the action.
235: * Value: <code>"org.eclipse.ui.FindIncrementalReverse_action_context"</code>
236: * @since 2.1
237: */
238: String FIND_INCREMENTAL_REVERSE_ACTION = PREFIX
239: + ITextEditorActionConstants.FIND_INCREMENTAL_REVERSE
240: + ACTION_POSTFIX;
241:
242: /**
243: * Help context id for the action.
244: * Value: <code>"org.eclipse.ui.bookmark_action_context"</code>
245: * @deprecated in 3.0 Use <code>org.eclipse.ui.texteditor.ITextEditorHelpContextIds.BOOKMARK_ACTION</code> instead.
246: */
247: String BOOKMARK_ACTION = PREFIX
248: + IWorkbenchActionConstants.BOOKMARK + ACTION_POSTFIX;
249:
250: /**
251: * Help context id for the action.
252: * Value: <code>"org.eclipse.ui.addTask_action_context"</code>
253: * @deprecated in 3.0 Use <code>org.eclipse.ui.texteditor.ITextEditorHelpContextIds.ADD_TASK_ACTION</code> instead.
254: */
255: String ADD_TASK_ACTION = PREFIX
256: + IWorkbenchActionConstants.ADD_TASK + ACTION_POSTFIX;
257:
258: /**
259: * Help context id for the action.
260: * Value: <code>"org.eclipse.ui.save_action_context"</code>
261: */
262: String SAVE_ACTION = PREFIX + ITextEditorActionConstants.SAVE
263: + ACTION_POSTFIX;
264:
265: /**
266: * Help context id for the action.
267: * Value: <code>"org.eclipse.ui.revert_action_context"</code>
268: */
269: String REVERT_TO_SAVED_ACTION = PREFIX
270: + ITextEditorActionConstants.REVERT_TO_SAVED
271: + ACTION_POSTFIX;
272:
273: /**
274: * Help context id for the action.
275: * Value: <code>"org.eclipse.ui.GotoLine_action_context"</code>
276: */
277: String GOTO_LINE_ACTION = PREFIX
278: + ITextEditorActionConstants.GOTO_LINE + ACTION_POSTFIX;
279:
280: /**
281: * Help context id for the action.
282: * Value: <code>"org.eclipse.ui.print_action_context"</code>
283: */
284: String PRINT_ACTION = PREFIX + ITextEditorActionConstants.PRINT
285: + ACTION_POSTFIX;
286:
287: /**
288: * Help context id for the action.
289: * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToWindows_action_context"</code>
290: * @since 2.0
291: * @deprecated since 3.1. No longer supported as editor actions.
292: */
293: String CONVERT_LINE_DELIMITERS_TO_WINDOWS = PREFIX
294: + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_WINDOWS
295: + ACTION_POSTFIX;
296:
297: /**
298: * Help context id for the action.
299: * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToUNIX_action_context"</code>
300: * @since 2.0
301: * @deprecated since 3.1. No longer supported as editor actions.
302: */
303: String CONVERT_LINE_DELIMITERS_TO_UNIX = PREFIX
304: + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_UNIX
305: + ACTION_POSTFIX;
306:
307: /**
308: * Help context id for the action.
309: * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToMAC_action_context"</code>
310: * @since 2.0
311: * @deprecated since 3.1 No longer supported as editor actions.
312: */
313: String CONVERT_LINE_DELIMITERS_TO_MAC = PREFIX
314: + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_MAC
315: + ACTION_POSTFIX;
316:
317: /**
318: * Help context id for the action.
319: * Value: <code>"org.eclipse.ui.find_replace_dialog_context"</code>
320: */
321: String FIND_REPLACE_DIALOG = PREFIX + "find_replace_dialog_context"; //$NON-NLS-1$
322:
323: /**
324: * Help context id for the action.
325: * Value: <code>"org.eclipse.ui.goto_last_edit_position_action_context"</code>
326: * @since 2.1
327: */
328: String GOTO_LAST_EDIT_POSITION_ACTION = PREFIX
329: + "goto_last_edit_position" + ACTION_POSTFIX; //$NON-NLS-1$
330:
331: /**
332: * Help context id for the action.
333: * Value: <code>"org.eclipse.ui.move_lines_action_context"</code>
334: * @since 3.0
335: */
336: String MOVE_LINES_ACTION = PREFIX + "move_lines" + ACTION_POSTFIX; //$NON-NLS-1$
337:
338: /**
339: * Help context id for the action.
340: * Value: <code>"org.eclipse.ui.copy_lines_action_context"</code>
341: * @since 3.0
342: */
343: String COPY_LINES_ACTION = PREFIX + "copy_lines" + ACTION_POSTFIX; //$NON-NLS-1$;
344:
345: /**
346: * Help context id for the action.
347: * Value: <code>"org.eclipse.ui.upper_case_action_context"</code>
348: * @since 3.0
349: */
350: String UPPER_CASE_ACTION = PREFIX + "upper_case" + ACTION_POSTFIX; //$NON-NLS-1$
351:
352: /**
353: * Help context id for the action.
354: * Value: <code>"org.eclipse.ui.lower_case_action_context"</code>
355: * @since 3.0
356: */
357: String LOWER_CASE_ACTION = PREFIX + "lower_case" + ACTION_POSTFIX; //$NON-NLS-1$
358:
359: /**
360: * Help context id for the action.
361: * Value: <code>"org.eclipse.ui.smart_enter_action_context"</code>
362: * @since 3.0
363: */
364: String SMART_ENTER_ACTION = PREFIX + "smart_enter" + ACTION_POSTFIX; //$NON-NLS-1$;
365:
366: /**
367: * Help context id for the smart insert mode toggle action.
368: * Value: <code>"org.eclipse.ui.toggle_insert_mode_action_context"</code>
369: * @since 3.0
370: */
371: String TOGGLE_INSERT_MODE_ACTION = PREFIX
372: + "toggle_insert_mode" + ACTION_POSTFIX; //$NON-NLS-1$;;
373:
374: /**
375: * Help context id for the word completion action.
376: * Value: <code>"org.eclipse.ui.hippie_completion_action_context"</code>
377: * @since 3.1
378: */
379: String HIPPIE_COMPLETION_ACTION = PREFIX
380: + "hippie_completion" + ACTION_POSTFIX; //$NON-NLS-1$
381:
382: /**
383: * Help context id for the quick assist action.
384: * Value: <code>"org.eclipse.ui.quick_assist_action_context"</code>
385: * @since 3.2
386: */
387: String QUICK_ASSIST_ACTION = PREFIX
388: + "quick_assist" + ACTION_POSTFIX; //$NON-NLS-1$
389:
390: /**
391: * Help context id for the recenter action.
392: * Value: <code>"org.eclipse.ui.recenter_action_context"</code>
393: * @since 3.3
394: */
395: String RECENTER_ACTION = PREFIX + "recenter" + ACTION_POSTFIX; //$NON-NLS-1$
396:
397: /**
398: * Help context id for the show whitespace characters action.
399: * Value: <code>"show_whitespace_characters_action_context"</code>
400: * @since 3.3
401: */
402: String SHOW_WHITESPACE_CHARACTERS_ACTION = PREFIX
403: + "show_whitepsace_characters" + ACTION_POSTFIX; //$NON-NLS-1$
404:
405: /**
406: * Help context id for the action that displays information
407: * for the current caret location in a sticky hover.
408: * Value: <code>"show_information_action_context"</code>
409: * @see IInformationProvider
410: * @since 3.3
411: */
412: String SHOW_INFORMATION_ACTION = PREFIX
413: + "show_information" + ACTION_POSTFIX; //$NON-NLS-1$
414: }
|