offapi/com/sun/star/form/TabulatorCycle.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: TabulatorCycle.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_TabulatorCycle_idl__
  31 #define __com_sun_star_form_TabulatorCycle_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module form {
  37
  38 //=============================================================================
  39
  40 /** specifies how the TAB key should be used in a form.
  41
  42     <p>If the last control of a form is focused, and the user pressed the TAB key, there are
  43     several possibilities how a <type>FormController</type> should handle this.
  44     <type>TabulatorCycle</type> specifies these possibilities.</p>
  45
  46     <p>Note that the <type>TabulatorCycle</type> determines what happens when SHIFT-TAB
  47     is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the
  48     <em>last</em> control.</p>
  49
  50     <p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p>
  51
  52     @see FormControlModel::TabIndex
  53     @see FormController
  54  */
  55 published enum TabulatorCycle
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** pressing the TAB key from the last control moves the focus to
  60         the first control in the tab order of the next record.
  61      */
  62     RECORDS,
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** pressing the TAB key from the last control moves the focus to
  67         the first control in the tab order of the same record.
  68      */
  69     CURRENT,
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** pressing the TAB key from the last control of a form moves
  74         the focus to the first control of the next form in the tab order.
  75      */
  76     PAGE
  77
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 /*=============================================================================
  85
  86 =============================================================================*/
  87 #endif