michael@0: /*************************************************************************
michael@0:  *
michael@0:  *  File Name (AccessibleImage.idl)
michael@0:  * 
michael@0:  *  IAccessible2 IDL Specification 
michael@0:  * 
michael@0:  *  Copyright (c) 2007, 2010 Linux Foundation 
michael@0:  *  Copyright (c) 2006 IBM Corporation 
michael@0:  *  Copyright (c) 2000, 2006 Sun Microsystems, Inc. 
michael@0:  *  All rights reserved. 
michael@0:  *   
michael@0:  *   
michael@0:  *  Redistribution and use in source and binary forms, with or without 
michael@0:  *  modification, are permitted provided that the following conditions 
michael@0:  *  are met: 
michael@0:  *   
michael@0:  *   1. Redistributions of source code must retain the above copyright 
michael@0:  *      notice, this list of conditions and the following disclaimer. 
michael@0:  *   
michael@0:  *   2. Redistributions in binary form must reproduce the above 
michael@0:  *      copyright notice, this list of conditions and the following 
michael@0:  *      disclaimer in the documentation and/or other materials 
michael@0:  *      provided with the distribution. 
michael@0:  *
michael@0:  *   3. Neither the name of the Linux Foundation nor the names of its 
michael@0:  *      contributors may be used to endorse or promote products 
michael@0:  *      derived from this software without specific prior written 
michael@0:  *      permission. 
michael@0:  *   
michael@0:  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
michael@0:  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
michael@0:  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
michael@0:  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
michael@0:  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
michael@0:  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
michael@0:  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
michael@0:  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
michael@0:  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
michael@0:  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
michael@0:  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
michael@0:  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
michael@0:  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
michael@0:  *   
michael@0:  *  This BSD License conforms to the Open Source Initiative "Simplified 
michael@0:  *  BSD License" as published at: 
michael@0:  *  http://www.opensource.org/licenses/bsd-license.php 
michael@0:  *   
michael@0:  *  IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 
michael@0:  *  mark may be used in accordance with the Linux Foundation Trademark 
michael@0:  *  Policy to indicate compliance with the IAccessible2 specification. 
michael@0:  * 
michael@0:  ************************************************************************/ 
michael@0: 
michael@0: import "objidl.idl";
michael@0: import "oaidl.idl";
michael@0: import "oleacc.idl";
michael@0: import "IA2CommonTypes.idl";
michael@0: 
michael@0: /** @brief This interface represents images and icons.
michael@0: 
michael@0:  This interface is used for a representation of images like icons on buttons.
michael@0:   %IAccessibleImage only needs to be implemented in certain situations.  Some
michael@0:   examples are:
michael@0:   <ol>
michael@0:    <li>The accessible name and description are not enough to fully
michael@0:     describe the image, e.g. when the accessible description is used to define the
michael@0:     behavior of an actionable image and the image itself conveys semantically
michael@0:     significant information.
michael@0:    <li>The user can edit the content that includes an
michael@0:     image and therefore the user needs to be able to review the image's position.
michael@0:   </ol>
michael@0: */
michael@0: [object, uuid(FE5ABB3D-615E-4f7b-909F-5F0EDA9E8DDE)]
michael@0: interface IAccessibleImage : IUnknown
michael@0: {
michael@0:   /** @brief Returns the localized description of the image.          
michael@0:    @param [out] description
michael@0:    @retval S_OK
michael@0:    @retval S_FALSE if there is nothing to return, [out] value is NULL
michael@0:   */
michael@0:   [propget] HRESULT description
michael@0:     (
michael@0:      [out, retval] BSTR *description
michael@0:     );
michael@0: 
michael@0:   /** @brief Returns the coordinates of the image.
michael@0:    @param [in] coordinateType
michael@0:     Specifies whether the returned coordinates should be relative to the screen or the parent object.
michael@0:    @param [out] x
michael@0:    @param [out] y
michael@0:    @retval S_OK
michael@0:   */
michael@0:   [propget] HRESULT imagePosition
michael@0:     (
michael@0: 	 [in] enum IA2CoordinateType coordinateType,
michael@0: 	 [out] long *x,
michael@0:      [out, retval] long *y
michael@0:     );
michael@0: 
michael@0:   /** @brief Returns the size of the image in units specified by parent's coordinate system.
michael@0:    @param [out] height
michael@0:    @param [out] width
michael@0:    @retval S_OK
michael@0:   */
michael@0: 
michael@0:   [propget] HRESULT imageSize
michael@0:     (
michael@0:      [out] long *height,
michael@0: 	 [out, retval] long *width
michael@0:     );
michael@0: }