001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 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: *******************************************************************************/package org.eclipse.ui;
011:
012: import org.eclipse.jface.resource.ImageDescriptor;
013: import org.eclipse.swt.graphics.Image;
014:
015: /**
016: * A registry for common images used by the workbench which may be useful
017: * to other plug-ins.
018: * <p>
019: * This class provides <code>Image</code> and <code>ImageDescriptor</code>s
020: * for each named image in the interface. All <code>Image</code> objects provided
021: * by this class are managed by this class and must never be disposed
022: * by other clients.
023: * </p>
024: * <p>
025: * This interface is not intended to be implemented by clients.
026: * </p>
027: */
028: public interface ISharedImages {
029: /**
030: * Identifies a file image.
031: */
032: public final static String IMG_OBJ_FILE = "IMG_OBJ_FILE"; //$NON-NLS-1$
033:
034: /**
035: * Identifies a folder image.
036: */
037: public final static String IMG_OBJ_FOLDER = "IMG_OBJ_FOLDER"; //$NON-NLS-1$
038:
039: /**
040: * Identifies a project image.
041: *
042: * @deprecated in 3.0. This image is IDE-specific, and is therefore found
043: * only in IDE configurations. IDE-specific tools should use
044: * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJ_PROJECT</code> instead.
045: */
046: public final static String IMG_OBJ_PROJECT = "IMG_OBJ_PROJECT"; //$NON-NLS-1$
047:
048: /**
049: * Identifies a closed project image.
050: *
051: * @deprecated in 3.0. This image is IDE-specific, and is therefore found
052: * only in IDE configurations. IDE-specific tools should use
053: * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJ_PROJECT_CLOSED</code> instead.
054: */
055: public final static String IMG_OBJ_PROJECT_CLOSED = "IMG_OBJ_PROJECT_CLOSED"; //$NON-NLS-1$
056:
057: /**
058: * Identifies an element image.
059: */
060: public final static String IMG_OBJ_ELEMENT = "IMG_OBJ_ELEMENTS"; //$NON-NLS-1$
061:
062: /**
063: * Identifies the image used for "open marker".
064: *
065: * @deprecated in 3.0. This image is IDE-specific, and is therefore found
066: * only in IDE configurations. IDE-specific tools should use
067: * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OPEN_MARKER</code> instead.
068: */
069: public final static String IMG_OPEN_MARKER = "IMG_OPEN_MARKER"; //$NON-NLS-1$
070:
071: /**
072: * Identifies the default image used for views.
073: */
074: public final static String IMG_DEF_VIEW = "IMG_DEF_VIEW"; //$NON-NLS-1$
075:
076: /**
077: * Identifies the default image used to indicate errors.
078: */
079: public final static String IMG_OBJS_ERROR_TSK = "IMG_OBJS_ERROR_TSK"; //$NON-NLS-1$
080:
081: /**
082: * Identifies the default image used to indicate warnings.
083: */
084: public final static String IMG_OBJS_WARN_TSK = "IMG_OBJS_WARN_TSK"; //$NON-NLS-1$
085:
086: /**
087: * Identifies the default image used to indicate information only.
088: */
089: public final static String IMG_OBJS_INFO_TSK = "IMG_OBJS_INFO_TSK"; //$NON-NLS-1$
090:
091: /**
092: * Identifies the default image used to indicate a task.
093: *
094: * @deprecated in 3.0. This image is IDE-specific, and is therefore found
095: * only in IDE configurations. IDE-specific tools should use
096: * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJS_TASK_TSK</code> instead.
097: */
098: public final static String IMG_OBJS_TASK_TSK = "IMG_OBJS_TASK_TSK"; //$NON-NLS-1$
099:
100: /**
101: * Identifies the default image used to indicate a bookmark.
102: *
103: * @deprecated in 3.0. This image is IDE-specific, and is therefore found
104: * only in IDE configurations. IDE-specific tools should use
105: * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJS_BKMRK_TSK</code> instead.
106: */
107: public final static String IMG_OBJS_BKMRK_TSK = "IMG_OBJS_BKMRK_TSK"; //$NON-NLS-1$
108:
109: /**
110: * Identifies the new wizard image in the enabled state.
111: */
112: public final static String IMG_TOOL_NEW_WIZARD = "IMG_TOOL_NEW_WIZARD"; //$NON-NLS-1$
113:
114: /**
115: * Identifies the new wizard image in the hover (colored) state.
116: *
117: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_NEW_WIZARD</code>.
118: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
119: */
120: public final static String IMG_TOOL_NEW_WIZARD_HOVER = "IMG_TOOL_NEW_WIZARD_HOVER"; //$NON-NLS-1$
121:
122: /**
123: * Identifies the new wizard image in the disabled state.
124: */
125: public final static String IMG_TOOL_NEW_WIZARD_DISABLED = "IMG_TOOL_NEW_WIZARD_DISABLED"; //$NON-NLS-1$
126:
127: /**
128: * Identifies the undo image in the enabled state.
129: */
130: public final static String IMG_TOOL_UNDO = "IMG_TOOL_UNDO"; //$NON-NLS-1$
131:
132: /**
133: * Identifies the undo image in the hover (colored) state.
134: *
135: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_UNDO</code>.
136: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
137: */
138: public final static String IMG_TOOL_UNDO_HOVER = "IMG_TOOL_UNDO_HOVER"; //$NON-NLS-1$
139:
140: /**
141: * Identifies the undo image in the disabled state.
142: */
143: public final static String IMG_TOOL_UNDO_DISABLED = "IMG_TOOL_UNDO_DISABLED"; //$NON-NLS-1$
144:
145: /**
146: * Identifies the redo image in the enabled state.
147: */
148: public final static String IMG_TOOL_REDO = "IMG_TOOL_REDO"; //$NON-NLS-1$
149:
150: /**
151: * Identifies the redo image in the hover (colored) state.
152: *
153: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_REDO</code>.
154: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
155: */
156: public final static String IMG_TOOL_REDO_HOVER = "IMG_TOOL_REDO_HOVER"; //$NON-NLS-1$
157:
158: /**
159: * Identifies the redo image in the disabled state.
160: */
161: public final static String IMG_TOOL_REDO_DISABLED = "IMG_TOOL_REDO_DISABLED"; //$NON-NLS-1$
162:
163: /**
164: * Identifies the cut image in the enabled state.
165: */
166: public final static String IMG_TOOL_CUT = "IMG_TOOL_CUT"; //$NON-NLS-1$
167:
168: /**
169: * Identifies the cut image in the hover (colored) state.
170: *
171: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_CUT</code>.
172: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
173: */
174: public final static String IMG_TOOL_CUT_HOVER = "IMG_TOOL_CUT_HOVER"; //$NON-NLS-1$
175:
176: /**
177: * Identifies the cut image in the disabled state.
178: */
179: public final static String IMG_TOOL_CUT_DISABLED = "IMG_TOOL_CUT_DISABLED"; //$NON-NLS-1$
180:
181: /**
182: * Identifies the copy image in the enabled state.
183: */
184: public final static String IMG_TOOL_COPY = "IMG_TOOL_COPY"; //$NON-NLS-1$
185:
186: /**
187: * Identifies the copy image in the hover (colored) state.
188: *
189: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_COPY</code>.
190: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
191: */
192: public final static String IMG_TOOL_COPY_HOVER = "IMG_TOOL_COPY_HOVER"; //$NON-NLS-1$
193:
194: /**
195: * Identifies the copy image in the disabled state.
196: */
197: public final static String IMG_TOOL_COPY_DISABLED = "IMG_TOOL_COPY_DISABLED"; //$NON-NLS-1$
198:
199: /**
200: * Identifies the paste image in the enabled state.
201: */
202: public final static String IMG_TOOL_PASTE = "IMG_TOOL_PASTE"; //$NON-NLS-1$
203:
204: /**
205: * Identifies the paste image in the hover (colored) state.
206: *
207: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_PASTE</code>.
208: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
209: */
210: public final static String IMG_TOOL_PASTE_HOVER = "IMG_TOOL_PASTE_HOVER"; //$NON-NLS-1$
211:
212: /**
213: * Identifies the paste image in the disabled state.
214: */
215: public final static String IMG_TOOL_PASTE_DISABLED = "IMG_TOOL_PASTE_DISABLED"; //$NON-NLS-1$
216:
217: /**
218: * Identifies the delete image in the enabled state.
219: */
220: public final static String IMG_TOOL_DELETE = "IMG_TOOL_DELETE"; //$NON-NLS-1$
221:
222: /**
223: * Identifies the delete image in the hover (colored) state.
224: *
225: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_DELETE</code>.
226: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
227: */
228: public final static String IMG_TOOL_DELETE_HOVER = "IMG_TOOL_DELETE_HOVER"; //$NON-NLS-1$
229:
230: /**
231: * Identifies the delete image in the disabled state.
232: */
233: public final static String IMG_TOOL_DELETE_DISABLED = "IMG_TOOL_DELETE_DISABLED"; //$NON-NLS-1$
234:
235: /**
236: * Identifies the forward image in the enabled state.
237: */
238: public final static String IMG_TOOL_FORWARD = "IMG_TOOL_FORWARD"; //$NON-NLS-1$
239:
240: /**
241: * Identifies the forward image in the hover (colored) state.
242: *
243: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_FORWARD</code>.
244: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
245: */
246: public final static String IMG_TOOL_FORWARD_HOVER = "IMG_TOOL_FORWARD_HOVER"; //$NON-NLS-1$
247:
248: /**
249: * Identifies the forward image in the disabled state.
250: */
251: public final static String IMG_TOOL_FORWARD_DISABLED = "IMG_TOOL_FORWARD_DISABLED"; //$NON-NLS-1$
252:
253: /**
254: * Identifies the back image in the enabled state.
255: */
256: public final static String IMG_TOOL_BACK = "IMG_TOOL_BACK"; //$NON-NLS-1$
257:
258: /**
259: * Identifies the back image in the hover (colored) state.
260: *
261: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_BACK</code>.
262: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
263: */
264: public final static String IMG_TOOL_BACK_HOVER = "IMG_TOOL_BACK_HOVER"; //$NON-NLS-1$
265:
266: /**
267: * Identifies the back image in the disabled state.
268: */
269: public final static String IMG_TOOL_BACK_DISABLED = "IMG_TOOL_BACK_DISABLED"; //$NON-NLS-1$
270:
271: /**
272: * Identifies the up image in the enabled state.
273: */
274: public final static String IMG_TOOL_UP = "IMG_TOOL_UP"; //$NON-NLS-1$
275:
276: /**
277: * Identifies the up image in the hover (colored) state.
278: *
279: * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_UP</code>.
280: * Enabled images are now in color. The workbench itself no longer uses the hover image variants.
281: */
282: public final static String IMG_TOOL_UP_HOVER = "IMG_TOOL_UP_HOVER"; //$NON-NLS-1$
283:
284: /**
285: * Identifies the up image in the disabled state.
286: */
287: public final static String IMG_TOOL_UP_DISABLED = "IMG_TOOL_UP_DISABLED"; //$NON-NLS-1$
288:
289: /**
290: * Retrieves the specified image from the workbench plugin's image registry.
291: * Note: The returned <code>Image</code> is managed by the workbench; clients
292: * must <b>not</b> dispose of the returned image.
293: *
294: * @param symbolicName the symbolic name of the image; there are constants
295: * declared in this interface for build-in images that come with the workbench
296: * @return the image, or <code>null</code> if not found
297: */
298: public Image getImage(String symbolicName);
299:
300: /**
301: * Retrieves the image descriptor for specified image from the workbench's
302: * image registry. Unlike <code>Image</code>s, image descriptors themselves do
303: * not need to be disposed.
304: *
305: * @param symbolicName the symbolic name of the image; there are constants
306: * declared in this interface for build-in images that come with the workbench
307: * @return the image descriptor, or <code>null</code> if not found
308: */
309: public ImageDescriptor getImageDescriptor(String symbolicName);
310: }
|