annotate dwtx/jface/preference/IPreferencePageContainer.d @ 34:b3c8e32d406f

preference
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Apr 2008 01:45:47 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.preference.IPreferencePageContainer;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.preference.IPreferenceStore;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.dwthelper.utils;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * An interface used by a preference page to talk to
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * its dialog.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 public interface IPreferencePageContainer {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * Returns the preference store.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @return the preference store, or <code>null</code> if none
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 public IPreferenceStore getPreferenceStore();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * Adjusts the enable state of the OK
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * button to reflect the state of the currently active
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * page in this container.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * <p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * This method is called by the container itself
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * when its preference page changes and may be called
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * by the page at other times to force a button state
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * update.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * </p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 public void updateButtons();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * Updates the message (or error message) shown in the message line to
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * reflect the state of the currently active page in this container.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * <p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * This method is called by the container itself
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * when its preference page changes and may be called
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * by the page at other times to force a message
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * update.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * </p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 public void updateMessage();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * Updates the title to reflect the state of the
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * currently active page in this container.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * <p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * This method is called by the container itself
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * when its page changes and may be called
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * by the page at other times to force a title
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * update.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * </p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 public void updateTitle();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 }