summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/NavigationBarMode.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/NavigationBarMode.idl')
-rw-r--r--offapi/com/sun/star/form/NavigationBarMode.idl68
1 files changed, 68 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/NavigationBarMode.idl b/offapi/com/sun/star/form/NavigationBarMode.idl
new file mode 100644
index 000000000..5056f11ca
--- /dev/null
+++ b/offapi/com/sun/star/form/NavigationBarMode.idl
@@ -0,0 +1,68 @@
+/* -*- 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_NavigationBarMode_idl__
+#define __com_sun_star_form_NavigationBarMode_idl__
+
+
+
+ module com { module sun { module star { module form {
+
+
+/** describes in which way the navigation of the records of a database form is performed.
+ */
+published enum NavigationBarMode
+{
+
+ /** no navigation bar is provided and navigation on the current
+ form is only possible with the keyboard (TAB/SHIFT TAB).
+
+ <p>Note that when this mode is set, a simultaneous TabulatorCycle
+ value of TabulatorCycle::CURRENT means that you cannot travel
+ between records anymore.</p>
+
+ @see TabulatorCycle
+ */
+ NONE,
+
+
+ /** a navigation bar is provided and navigation will be performed
+ on the current/active form.
+ <p>This is the default and most often encountered mode.</p>
+ */
+ CURRENT,
+
+
+ /** a navigation bar is provided and navigation will be performed
+ on the parent of the current/active form.
+
+ <p>This option is usually used for forms containing a grid control only.
+ In such a form, the control has its own navigation elements, so there is
+ no need to use the navigation bar for the form, but rather for its parent.
+ </p>
+ */
+ PARENT
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */