1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_TabulatorCycle_idl__
28#define __com_sun_star_form_TabulatorCycle_idl__
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module form {
34
35//=============================================================================
36
37/** specifies how the TAB key should be used in a form.
38
39	<p>If the last control of a form is focused, and the user pressed the TAB key, there are
40	several possibilities how a <type>FormController</type> should handle this.
41	<type>TabulatorCycle</type> specifies these possibilities.</p>
42
43	<p>Note that the <type>TabulatorCycle</type> determines what happens when SHIFT-TAB
44	is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the
45	<em>last</em> control.</p>
46
47	<p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p>
48
49	@see FormControlModel::TabIndex
50	@see FormController
51 */
52published enum TabulatorCycle
53{
54	//-------------------------------------------------------------------------
55
56	/** pressing the TAB key from the last control moves the focus to
57		the first control in the tab order of the next record.
58	 */
59	RECORDS,
60
61	//-------------------------------------------------------------------------
62
63	/** pressing the TAB key from the last control moves the focus to
64		the first control in the tab order of the same record.
65	 */
66	CURRENT,
67
68	//-------------------------------------------------------------------------
69
70	/** pressing the TAB key from the last control of a form moves
71		the focus to the first control of the next form in the tab order.
72	 */
73	PAGE
74
75};
76
77//=============================================================================
78
79}; }; }; };
80
81/*=============================================================================
82
83=============================================================================*/
84#endif
85