offapi/com/sun/star/form/NavigationBarMode.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module form {
  23
  24
  25 /** describes in which way the navigation of the records of a database form is performed.
  26  */
  27 published enum NavigationBarMode
  28 {
  29
  30     /** no navigation bar is provided and navigation on the current
  31         form is only possible with the keyboard (TAB/SHIFT TAB).
  32
  33         <p>Note that when this mode is set, a simultaneous TabulatorCycle
  34         value of TabulatorCycle::CURRENT means that you cannot travel
  35         between records anymore.</p>
  36
  37         @see TabulatorCycle
  38      */
  39     NONE,
  40
  41
  42     /** a navigation bar is provided and navigation will be performed
  43         on the current/active form.
  44         <p>This is the default and most often encountered mode.</p>
  45      */
  46     CURRENT,
  47
  48
  49     /** a navigation bar is provided and navigation will be performed
  50         on the parent of the current/active form.
  51
  52         <p>This option is usually used for forms containing a grid control only.
  53         In such a form, the control has its own navigation elements, so there is
  54         no need to use the navigation bar for the form, but rather for its parent.
  55         </p>
  56      */
  57     PARENT
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */