summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/TabulatorCycle.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/TabulatorCycle.idl')
-rw-r--r--offapi/com/sun/star/form/TabulatorCycle.idl69
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/TabulatorCycle.idl b/offapi/com/sun/star/form/TabulatorCycle.idl
new file mode 100644
index 000000000..f6ab1e94a
--- /dev/null
+++ b/offapi/com/sun/star/form/TabulatorCycle.idl
@@ -0,0 +1,69 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_form_TabulatorCycle_idl__
+#define __com_sun_star_form_TabulatorCycle_idl__
+
+
+
+ module com { module sun { module star { module form {
+
+
+/** specifies how the TAB key should be used in a form.
+
+ <p>If the last control of a form is focused, and the user pressed the TAB key, there are
+ several possibilities how a FormController should handle this.
+ TabulatorCycle specifies these possibilities.</p>
+
+ <p>Note that the TabulatorCycle determines what happens when SHIFT-TAB
+ is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the
+ <em>last</em> control.</p>
+
+ <p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p>
+
+ @see FormControlModel::TabIndex
+ @see FormController
+ */
+published enum TabulatorCycle
+{
+
+ /** pressing the TAB key from the last control moves the focus to
+ the first control in the tab order of the next record.
+ */
+ RECORDS,
+
+
+ /** pressing the TAB key from the last control moves the focus to
+ the first control in the tab order of the same record.
+ */
+ CURRENT,
+
+
+ /** pressing the TAB key from the last control of a form moves
+ the focus to the first control of the next form in the tab order.
+ */
+ PAGE
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */