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