xref: /AOO41X/main/offapi/com/sun/star/form/NavigationBarMode.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_NavigationBarMode_idl__
24#define __com_sun_star_form_NavigationBarMode_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module form {
30
31//=============================================================================
32
33/** describes in which way the navigation of the records of a database form is performed.
34 */
35published enum NavigationBarMode
36{
37    //-------------------------------------------------------------------------
38
39    /** no navigation bar is provided and navigation on the current
40        form is only possible with the keyboard (TAB/SHIFT TAB).
41
42        <p>Note that when this mode is set, a simultaneous <type>TabulatorCycle</type>
43        value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel
44        between records anymore.</p>
45
46        @see TabulatorCycle
47     */
48    NONE,
49
50    //-------------------------------------------------------------------------
51
52    /** a navigation bar is provided and navigation will be performed
53        on the current/active form.
54        <p>This is the default and most often encountered mode.</p>
55     */
56    CURRENT,
57
58    //-------------------------------------------------------------------------
59
60    /** a navigation bar is provided and navigation will be performed
61        on the parent of the current/active form.
62
63        <p>This options is usually used for forms containing an grid control only.
64        In such a form, the control has it's own navigation elements, so there is
65        no need to use the navigation bar for the form, but rather for it's parent.
66        </p>
67     */
68    PARENT
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76/*=============================================================================
77
78=============================================================================*/
79#endif
80