summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/accessibility/AccessibleRelationType.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/accessibility/AccessibleRelationType.idl')
-rw-r--r--offapi/com/sun/star/accessibility/AccessibleRelationType.idl123
1 files changed, 123 insertions, 0 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleRelationType.idl b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl
new file mode 100644
index 000000000..0ea803a81
--- /dev/null
+++ b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl
@@ -0,0 +1,123 @@
+/* -*- 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_accessibility_AccessibleRelationType_idl__
+#define __com_sun_star_accessibility_AccessibleRelationType_idl__
+
+module com { module sun { module star { module accessibility {
+
+/** Collection of relation types.
+
+ <p>This list of constants defines the available types of relations that
+ are usable by AccessibleRelation.</p>
+
+ <p>We are using constants instead of a more typesafe enum. The reason
+ for this is that IDL enums may not be extended. Therefore, in order to
+ include future extensions to the set of roles we have to use constants
+ here.</p>
+
+ @since OOo 1.1.2
+*/
+constants AccessibleRelationType
+{
+ /** Invalid relation type.
+
+ <p>Indicates an invalid relation type. This is used to indicate
+ that a retrieval method could not find a requested relation.</p>
+ */
+ const short INVALID = 0;
+
+ /** Content-flows-from relation.
+
+ <p>Indicates a content flow between the related objects.</p>
+ */
+ const short CONTENT_FLOWS_FROM = 1;
+
+ /** Content-flows-to relation.
+
+ <p>Indicates a content flow between the related objects.</p>
+ */
+ const short CONTENT_FLOWS_TO = 2;
+
+ /** Controlled-by relation type.
+
+ <p>Indicates an object is controlled by one or more target
+ objects.</p>
+ */
+ const short CONTROLLED_BY = 3;
+
+ /** Controller-for relation type.
+
+ <p>Indicates an object is a controller for one or more target
+ objects.</p>
+ */
+ const short CONTROLLER_FOR = 4;
+
+ /** Label-for relation type.
+
+ <p>Indicates an object is a label for one or more target
+ objects.</p>
+ */
+ const short LABEL_FOR = 5;
+
+ /** Labeled-by relation type.
+
+ <p>Indicates an object is labeled by one or more target objects.</p>
+ */
+ const short LABELED_BY = 6;
+
+ /** Member-of relation type.
+
+ <p>Indicates an object is a member of a group of one or more target
+ objects.</p>
+ */
+ const short MEMBER_OF = 7;
+
+ /** Sub-Window-of relation type.
+
+ <p>With this relation you can realize an alternative parent-child
+ relationship. The target of the relation contains the parent
+ window. Note that there is no relation that points the other way,
+ from the parent window to the child window.</p>
+ */
+ const short SUB_WINDOW_OF = 8;
+
+ /** Node-Child-of relation type.
+
+ <p>Indicates an object is a cell in a tree or tree table which is
+ displayed because a cell in the same column is expanded and
+ identifies that cell.</p>
+
+ @since OOo 3.0
+ */
+ const short NODE_CHILD_OF = 9;
+
+ /** Described-by relation type.
+
+ <p>Indicates an object is described by the target object.</p>
+
+ @since OOo 3.5
+ */
+ const short DESCRIBED_BY = 10;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */