summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KShortcutList.java
blob: dc19b35fdcfe984f6db5fbf3f4bc73ba1f60dc28 (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
//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.Qt;
import org.kde.qt.QtSupport;
import org.kde.qt.TQVariant;

/**

 KShortcutList is an abstract base class for
 KAccelShortcutList and KStdAccel.ShortcutList. It gives
 you an unified interface for accessing the accelerator lists
 of KAccel (using KAccelShortcutList),
 KGlobalAccel (using KAccelShortcutList), and
 KStdAccel (using KStdAccel.ShortcutList).
		@short Base class for accessing accelerator lists.

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


	/**	
		 Default constructor.
			 		@short    Default constructor.
	*/
	/**	
		 Returns the number of entries.
				@return the number of entries
	 
		@short    Returns the number of entries.
	*/
	public native int count();
	/**	
		 Returns the name of the shortcut with the given <code>index.</code>
			@param index the index of the shortcut (must be < count())
				@return the name of the shortcut
	 
		@short    Returns the name of the shortcut with the given <code>index.</code>
	*/
	public native String name(int index);
	/**	
		 Returns the (i18n'd) label of the shortcut with the given <code>index.</code>
			@param index the index of the shortcut (must be < count())
				@return the label (i18n'd) of the shortcut
	 
		@short    Returns the (i18n'd) label of the shortcut with the given <code>index.</code>
	*/
	public native String label(int index);
	/**	
		 Returns the (i18n'd) What's This text of the shortcut with the given <code>index.</code>
			@param index the index of the shortcut (must be < count())
				@return the What's This text (i18n'd) of the shortcut
	 
		@short    Returns the (i18n'd) What's This text of the shortcut with the given <code>index.</code>
	*/
	public native String whatsThis(int index);
	/**	
		 Returns the shortcut with the given <code>index.</code>
			@param index the index of the shortcut (must be < count())
				@return the shortcut

		@short    Returns the shortcut with the given <code>index.</code>
		@see #shortcutDefault
	*/
	public native KShortcut shortcut(int index);
	/**	
		 Returns default shortcut with the given <code>index.</code>
			@param index the index of the shortcut (must be < count())
				@return the default shortcut

		@short    Returns default shortcut with the given <code>index.</code>
		@see #shortcut
	*/
	public native KShortcut shortcutDefault(int index);
	/**	
		 Checks whether the shortcut with the given <code>index</code> is configurable.
			@param index the index of the shortcut (must be < count())
				@return true if configurable, false otherwise
	 
		@short    Checks whether the shortcut with the given <code>index</code> is configurable.
	*/
	public native boolean isConfigurable(int index);
	/**	
		 Sets the shortcut of the given entry
			@param index the index of the shortcut (must be < count())
			@param shortcut the shortcut
			 		@short    Sets the shortcut of the given entry
	*/
	public native boolean setShortcut(int index, KShortcut shortcut);
	/**	
		 Checks whether the shortcut with the given <code>index</code> is saved in the
		 global configuration.
			@param index the index of the shortcut (must be < count())
				@return true if global, false otherwise
	 
		@short    Checks whether the shortcut with the given <code>index</code> is saved in the  global configuration.
	*/
	public native boolean isGlobal(int index);
	/**	
		 Returns the index of the shortcut with he given name.
			@param sName the name of the shortcut to search
				@return the index of the shortcut, of -1 if not found
	 
		@short    Returns the index of the shortcut with he given name.
	*/
	public native int index(String sName);
	/**	
		 Returns the index of the shortcut with he given key sequence.
			@param keySeq the key sequence to search for
				@return the index of the shortcut, of -1 if not found
	 
		@short    Returns the index of the shortcut with he given key sequence.
	*/
	public native int index(KKeySequence keySeq);
	/**	
		 The TDEInstance.
				@return the TDEInstance of the list, can be 0 if not available
	 
		@short    The TDEInstance.
	*/
	public native TDEInstanceInterface instance();
	/**	 \internal 		@short   \internal
	*/
	public native TQVariant getOther(int arg1, int index);
	/**	 \internal 		@short   \internal
	*/
	public native boolean setOther(int arg1, int index, TQVariant arg3);
	/**	
		 Save the shortcut list.
				@return true if successful, false otherwise
	 
		@short    Save the shortcut list.
	*/
	public native boolean save();
	/**	
		 Loads the shortcuts from the given configuration file.
			@param sConfigGroup the group in the configuration file
			@param pConfig the configuration file to load from
				@return true if successful, false otherwise
	 
		@short    Loads the shortcuts from the given configuration file.
	*/
	public native boolean readSettings(String sConfigGroup, KConfigBase pConfig);
	public native boolean readSettings(String sConfigGroup);
	public native boolean readSettings();
	/**	
		 Writes the shortcuts to the given configuration file.
			@param sConfigGroup the group in the configuration file
			@param pConfig the configuration file to save to
			@param bWriteAll true to write all actions
			@param bGlobal true to write to the global configuration file
				@return true if successful, false otherwise
	 
		@short    Writes the shortcuts to the given configuration file.
	*/
	public native boolean writeSettings(String sConfigGroup, KConfigBase pConfig, boolean bWriteAll, boolean bGlobal);
	public native boolean writeSettings(String sConfigGroup, KConfigBase pConfig, boolean bWriteAll);
	public native boolean writeSettings(String sConfigGroup, KConfigBase pConfig);
	public native boolean writeSettings(String sConfigGroup);
	public native boolean writeSettings();
}