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