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

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