1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_TabulatorCycle_idl__
24#define __com_sun_star_form_TabulatorCycle_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module form {
30
31//=============================================================================
32
33/** specifies how the TAB key should be used in a form.
34
35	<p>If the last control of a form is focused, and the user pressed the TAB key, there are
36	several possibilities how a <type>FormController</type> should handle this.
37	<type>TabulatorCycle</type> specifies these possibilities.</p>
38
39	<p>Note that the <type>TabulatorCycle</type> determines what happens when SHIFT-TAB
40	is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the
41	<em>last</em> control.</p>
42
43	<p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p>
44
45	@see FormControlModel::TabIndex
46	@see FormController
47 */
48published enum TabulatorCycle
49{
50	//-------------------------------------------------------------------------
51
52	/** pressing the TAB key from the last control moves the focus to
53		the first control in the tab order of the next record.
54	 */
55	RECORDS,
56
57	//-------------------------------------------------------------------------
58
59	/** pressing the TAB key from the last control moves the focus to
60		the first control in the tab order of the same record.
61	 */
62	CURRENT,
63
64	//-------------------------------------------------------------------------
65
66	/** pressing the TAB key from the last control of a form moves
67		the focus to the first control of the next form in the tab order.
68	 */
69	PAGE
70
71};
72
73//=============================================================================
74
75}; }; }; };
76
77/*=============================================================================
78
79=============================================================================*/
80#endif
81