offapi/com/sun/star/form/TabulatorCycle.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_TabulatorCycle_idl__
  20 #define __com_sun_star_form_TabulatorCycle_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module form {
  25
  26
  27 /** specifies how the TAB key should be used in a form.
  28
  29     <p>If the last control of a form is focused, and the user pressed the TAB key, there are
  30     several possibilities how a FormController should handle this.
  31     TabulatorCycle specifies these possibilities.</p>
  32
  33     <p>Note that the TabulatorCycle determines what happens when SHIFT-TAB
  34     is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the
  35     <em>last</em> control.</p>
  36
  37     <p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p>
  38
  39     @see FormControlModel::TabIndex
  40     @see FormController
  41  */
  42 published enum TabulatorCycle
  43 {
  44
  45     /** pressing the TAB key from the last control moves the focus to
  46         the first control in the tab order of the next record.
  47      */
  48     RECORDS,
  49
  50
  51     /** pressing the TAB key from the last control moves the focus to
  52         the first control in the tab order of the same record.
  53      */
  54     CURRENT,
  55
  56
  57     /** pressing the TAB key from the last control of a form moves
  58         the focus to the first control of the next form in the tab order.
  59      */
  60     PAGE
  61
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */