summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/AccessibleEdit.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/awt/AccessibleEdit.idl')
-rw-r--r--offapi/com/sun/star/awt/AccessibleEdit.idl110
1 files changed, 110 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/AccessibleEdit.idl b/offapi/com/sun/star/awt/AccessibleEdit.idl
new file mode 100644
index 000000000..3c4cce690
--- /dev/null
+++ b/offapi/com/sun/star/awt/AccessibleEdit.idl
@@ -0,0 +1,110 @@
+/* -*- 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_awt_AccessibleEdit_idl__
+#define __com_sun_star_awt_AccessibleEdit_idl__
+
+#include <com/sun/star/accessibility/XAccessibleContext.idl>
+#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
+#include <com/sun/star/accessibility/XAccessibleComponent.idl>
+#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
+#include <com/sun/star/accessibility/XAccessibleText.idl>
+#include <com/sun/star/accessibility/XAccessibleEditableText.idl>
+
+module com { module sun { module star { module awt {
+
+/** specifies accessibility support for an edit.
+
+ @since OOo 1.1.2
+ */
+service AccessibleEdit
+{
+ /** This interface gives access to the structural information of an edit:
+
+ <ul>
+ <li>Role: The role of an edit is
+ com::sun::star::accessibility::AccessibleRole::TEXT.
+ If the text content of the edit is password protected
+ the role is
+ com::sun::star::accessibility::AccessibleRole::PASSWORD_TEXT.</li>
+ <li>Name: If the relation of type
+ com::sun::star::accessibility::AccessibleRelationType::LABELED_BY
+ is set, the name of the edit is the localized label of the target
+ object, otherwise there is no name.</li>
+ <li>Description: The description of an edit is its localized
+ help text.</li>
+ <li>Children: There are no children.</li>
+ <li>Parent: The parent is the window that contains the edit.</li>
+ <li>Relations: The relations supported by this service are
+ <ul>
+ <li>com::sun::star::accessibility::AccessibleRelationType::LABELED_BY
+ is set if the object is labeled by one or more target
+ objects.</li>
+ </ul>
+ </li>
+ <li>States: The states supported by this service are
+ <ul>
+ <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
+ is set if the object has already been disposed
+ and subsequent calls to this object result in
+ com::sun::star::lang::DisposedException
+ exceptions.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::EDITABLE
+ is set
+ if the content of the object can be changed by the user.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
+ is set if the object is enabled.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
+ is always set.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
+ is set if the object currently has the keyboard focus.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
+ is set if the object is displayed on the screen.</li>
+ <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
+ is always set.</li>
+ </ul>
+ </li>
+ </ul>
+ */
+ interface ::com::sun::star::accessibility::XAccessibleContext;
+
+ interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
+
+ interface ::com::sun::star::accessibility::XAccessibleComponent;
+
+ interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
+
+ /** This interface gives read-only access to the text representation
+ of an edit.
+ */
+ interface ::com::sun::star::accessibility::XAccessibleText;
+
+ /** This interface extends the
+ com::sun::star::accessibility::XAccessibleText
+ interface and gives read and write access to the text representation
+ of an edit.
+ */
+ interface ::com::sun::star::accessibility::XAccessibleEditableText;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */