office-gobmx/offapi/com/sun/star/text/AccessibleTextEmbeddedObject.idl
Noel Grandin 2a1b850b78 clean up all the UNO IDL module header guards
.. so I don't keep tripping over the bad ones during my UNO cleanup work.

(1) make them all use a similar syntax, makes it easier to run my automatic checker
(2) some of them were just cut'n'paste accidents waiting to happen
(3) remove unnecessary header guards in the __including__ file. That is very brittle.

Change-Id: I4e679c15161483ad93aeb316a25d6db6d97e9d4e
2012-12-21 09:12:07 +02:00

116 lines
5.3 KiB
Text

/* -*- 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_text_AccessibleTextEmbeddedObject_idl__
#define __com_sun_star_text_AccessibleTextEmbeddedObject_idl__
#include <com/sun/star/accessibility/XAccessibleContext.idl>
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#include <com/sun/star/accessibility/XAccessibleImage.idl>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
module com { module sun { module star { module text {
/** The accessible view of an inactive embedded object. If an embedded
object gets active, the active document gets an accessible object
tree of its own. This tree is not a subtree of the object that supports
this service but of the document service itself. The tree exist only
until the object is deactivated.
@since OOo 1.1.2
*/
service AccessibleTextEmbeddedObject
{
/** This interface comprises the basic accessibility of embedded objects.
<ul>
<li>The parent returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleParent</method> is the
accessible view of a paragraph if the embedded object is
bound as character, and the accessible view of the document
(or of a page in the page preview) in any other case.
<li>There are no children returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleChild</method>. See above.
<li>The role is <const scope="::com::sun::star::accessibility"
>AccessibleRole::EMBEDDED_OBJECT</const>
<li>The name is the one assigned to the object in the text
document. This means that it is not internationalized.
<li>The description is the one assigned to the object in the text
document. This means that it is not internationalized. If no
description has been set, the description equals the name.
<li>There are no relations.
<li>The following states might be contained in the state set
returned by <method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleStateSet</method>:
<ul>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::DEFUNC</const> (indicates that
the document window has been closed or the graphic
is not existing any longer)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::EDITABLE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::ENABLED</const> (always
contained)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::OPAQUE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTABLE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTED</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::FOCUSABLE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::FOCUSED</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SHOWING</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::VISIBLE</const>
</ul>
<li>The locale is the one the text document itself.
</ul>
*/
interface ::com::sun::star::accessibility::XAccessibleContext;
/** This interface describes the graphical representation of an
embedded object.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This interface gives access to the object's size and its description.
*/
interface ::com::sun::star::accessibility::XAccessibleImage;
/** This is the interface for listeners
*/
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */