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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NavigationBarMode.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_form_NavigationBarMode_idl__
  31 #define __com_sun_star_form_NavigationBarMode_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module form {
  37
  38 //=============================================================================
  39
  40 /** describes in which way the navigation of the records of a database form is performed.
  41  */
  42 published enum NavigationBarMode
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** no navigation bar is provided and navigation on the current
  47         form is only possible with the keyboard (TAB/SHIFT TAB).
  48
  49         <p>Note that when this mode is set, a simultaneous <type>TabulatorCycle</type>
  50         value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel
  51         between records anymore.</p>
  52
  53         @see TabulatorCycle
  54      */
  55     NONE,
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** a navigation bar is provided and navigation will be performed
  60         on the current/active form.
  61         <p>This is the default and most often encountered mode.</p>
  62      */
  63     CURRENT,
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** a navigation bar is provided and navigation will be performed
  68         on the parent of the current/active form.
  69
  70         <p>This options is usually used for forms containing an grid control only.
  71         In such a form, the control has it's own navigation elements, so there is
  72         no need to use the navigation bar for the form, but rather for it's parent.
  73         </p>
  74      */
  75     PARENT
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 /*=============================================================================
  84
  85 =============================================================================*/
  86 #endif