summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KRootProp.java
blob: 14adb1b25cbacff0fc61d63a61d2ebd479efe1dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.Qt;
import org.kde.qt.TQColor;
import org.kde.qt.TQFont;
import org.kde.qt.QtSupport;
import java.util.ArrayList;

/**

 Access KDE desktop resources stored on the root window.
 A companion to the TDEConfig class.
 The KRootProp class is used for reading and writing configuration entries
 to properties on the root window.
 All configuration entries are of the form "key=value".
		@author Mark Donohoe (donohe@kde.org)

		@short    Access KDE desktop resources stored on the root window.
		@see TDEConfig#TDEConfig

*/
public class KRootProp implements QtSupport {
	private long _qt;
	private boolean _allocatedInJavaWorld = true;
	protected KRootProp(Class dummy){}

	/**	
		 Constructs a KRootProp object for the property <code>rProp.</code>
			@param rProp the property that will be searched, null to
		              do nothing
				@short    Constructs a KRootProp object for the property <code>rProp.</code>
		@see #setProp
	*/
	public KRootProp(String rProp) {
		newKRootProp(rProp);
	}
	private native void newKRootProp(String rProp);
	public KRootProp() {
		newKRootProp();
	}
	private native void newKRootProp();
	/**	
		 Sets the property in which keys will be searched.
			@param rProp the property that will be searched
				@short    Sets the property in which keys will be searched.
	*/
	public native void setProp(String rProp);
	public native void setProp();
	/**	
		 Returns the name of the property under which keys are searched.
				@return the property that will be searched

		@short    Returns the name of the property under which keys are searched.
	*/
	public native String prop();
	/**	
		 Destroys the property completely.
			 I.e. all entries will be cleared
		 and the property will be removed from the root window.
				@short    Destroys the property completely.
	*/
	public native void destroy();
	/**	
		 Reads the value of an entry specified by <code>rKey</code> in the current property.
			@param rKey The key to search for.
			@param pDefault A default value returned if the key was not found.
				@return The value for this key or the default if no value
	  was found.

		@short    Reads the value of an entry specified by <code>rKey</code> in the current property.
	*/
	public native String readEntry(String rKey, String pDefault);
	public native String readEntry(String rKey);
	/**	
		 Reads a numerical value.
			 Reads the value of an entry specified by <code>rKey</code> in the current property
		 and interprets it numerically.
			@param rKey The key to search for.
			@param nDefault A default value returned if the key was not found.
				@return The value for this key or the default if no value was found.
  
		@short    Reads a numerical value.
	*/
	public native int readNumEntry(String rKey, int nDefault);
	public native int readNumEntry(String rKey);
	/**	
		 Reads a TQFont value.
			 Reads the value of an entry specified by <code>rKey</code> in the current property
		 and interpret it as a font object.
			@param rKey The key to search for.
			@param pDefault A default value returned if the key was not found.
				@return The value for this key or a default font if no value was found.
  
		@short    Reads a TQFont value.
	*/
	public native TQFont readFontEntry(String rKey, TQFont pDefault);
	public native TQFont readFontEntry(String rKey);
	/**	
		 Reads a TQColor.
			 Reads the value of an entry specified by <code>rKey</code> in the current property
		 and interprets it as a color.
			@param rKey The key to search for.
			@param pDefault A default value returned if the key was not found.
				@return The value for this key or a default color if no value
 was found.
  
		@short    Reads a TQColor.
	*/
	public native TQColor readColorEntry(String rKey, TQColor pDefault);
	public native TQColor readColorEntry(String rKey);
	/**	
		 Writes a (key/value) pair.
			 This is stored to the current property when destroying the
		 config object or when calling sync().
			@param rKey The key to write.
			@param rValue The value to write.
				@return The old value for this key. If this key did not exist,
	  a null string is returned.

		@short    Writes a (key/value) pair.
	*/
	public native String writeEntry(String rKey, String rValue);
	/**	
		 Writes the (key/value) pair.
		 Same as above, but writes a numerical value.
			@param rKey The key to write.
			@param nValue The value to write.
				@return The old value for this key. If this key did not
 exist, a null string is returned.

		@short    Writes the (key/value) pair.
	*/
	public native String writeEntry(String rKey, int nValue);
	/**	
		 Writes the (key/value) pair.
		 Same as above, but writes a font.
			@param rKey The key to write.
			@param rFont The font to write.
				@return The old value for this key. If this key did not
 exist, a null string is returned.

		@short    Writes the (key/value) pair.
	*/
	public native String writeEntry(String rKey, TQFont rFont);
	/**	
		 Writes the (key/value) pair.
		 Same as above, but writes a color.
			@param rKey The key to write.
			@param rColor The color to write.
				@return The old value for this key. If this key did not
  exist, a null string is returned.

		@short    Writes the (key/value) pair.
	*/
	public native String writeEntry(String rKey, TQColor rColor);
	/**	
		 Removes an entry.
			@param rKey The key to remove.
				@return The old value for this key. If this key did not
  exist, a null string is returned.

		@short    Removes an entry.
	*/
	public native String removeEntry(String rKey);
	/**	
		 Returns a list of all keys.
				@return An ArrayList containing all the keys.

		@short    Returns a list of all keys.
	*/
	public native ArrayList listEntries();
	/**	
		 Flushes the entry cache.
		 Writes back dirty configuration entries to the current property,
		 This is called automatically from the destructor.
				@short    Flushes the entry cache.
	*/
	public native void sync();
	/** Deletes the wrapped C++ instance */
	protected native void finalize() throws InternalError;
	/** Delete the wrapped C++ instance ahead of finalize() */
	public native void dispose();
	/** Has the wrapped C++ instance been deleted? */
	public native boolean isDisposed();
}