1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/accessible/public/msaa/ISimpleDOMText.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,79 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1.5 + *
1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +import "objidl.idl";
1.11 +import "oaidl.idl";
1.12 +
1.13 +cpp_quote("///////////////////////////////////////////////////////////////////////////////////////////////////////")
1.14 +cpp_quote("//")
1.15 +cpp_quote("// ISimpleDOMText")
1.16 +cpp_quote("// ---------------------------------------------------------------------------------------------------=")
1.17 +cpp_quote("// An interface that extends MSAA's IAccessible to provide important additional capabilities on text nodes")
1.18 +cpp_quote("//")
1.19 +cpp_quote("// [propget] domText(/* out,retval */ BSTR *domText")
1.20 +cpp_quote("// ---------------------------------------------------------------------------------------------------=")
1.21 +cpp_quote("// Similar to IAccessible::get_accName, but does not strip out whitespace characters.")
1.22 +cpp_quote("// Important for retrieving the correct start/end substring indices to use with other")
1.23 +cpp_quote("// methods in ISimpleDOMText.")
1.24 +cpp_quote("//")
1.25 +cpp_quote("//")
1.26 +cpp_quote("// get_[un]clippedSubstringBounds(")
1.27 +cpp_quote("// /* [in] */ unsigned int startIndex,")
1.28 +cpp_quote("// /* [in] */ unsigned int endIndex,")
1.29 +cpp_quote("// /* [out] */ int *x,")
1.30 +cpp_quote("// /* [out] */ int *y,")
1.31 +cpp_quote("// /* [out] */ int *width,")
1.32 +cpp_quote("// /* [out] */ int *height);")
1.33 +cpp_quote("// ---------------------------------------------------------------------------------------------------=")
1.34 +cpp_quote("// Both methods get_clippedSubstringBounds and get_unclippedSubstringBounds return the screen pixel")
1.35 +cpp_quote("// coordinates of the given text substring. The in parameters for start and end indices refer")
1.36 +cpp_quote("// to the string returned by ISimpleDOMText::get_domText().")
1.37 +cpp_quote("//")
1.38 +cpp_quote("//")
1.39 +cpp_quote("// scrollToSubstring(")
1.40 +cpp_quote("// /* [in] */ unsigned int startIndex,")
1.41 +cpp_quote("// /* [in] */ unsigned int endIndex);")
1.42 +cpp_quote("// ---------------------------------------------------------------------------------------------------=")
1.43 +cpp_quote("// In scrollable views, scrolls to ensure that the specified substring is visible onscreen.")
1.44 +cpp_quote("// The in parameters for start and end indices refer to the string returned")
1.45 +cpp_quote("// by ISimpleDOMText::get_domText().")
1.46 +cpp_quote("//")
1.47 +cpp_quote("//")
1.48 +cpp_quote("// [propget] fontFamily(/* out,retval */ BSTR *fontFamily);")
1.49 +cpp_quote("// ---------------------------------------------------------------------------------------------------=")
1.50 +cpp_quote("// Return a single computed font family name, which is better than the comma delineated list")
1.51 +cpp_quote("// that is returned by the ISimpleDOMNode computed style methods for font-family.")
1.52 +cpp_quote("// In other words, return something like 'Arial' instead of 'Arial, Helvetica, Sans-serif'.")
1.53 +cpp_quote("///////////////////////////////////////////////////////////////////////////////////////////////////////")
1.54 +cpp_quote("")
1.55 +cpp_quote("")
1.56 +
1.57 +[object, uuid(4e747be5-2052-4265-8af0-8ecad7aad1c0)]
1.58 +interface ISimpleDOMText: IUnknown
1.59 +{
1.60 + // Includes whitespace in DOM
1.61 + [propget] HRESULT domText([out, retval] BSTR *domText);
1.62 +
1.63 + HRESULT get_clippedSubstringBounds([in] unsigned int startIndex,
1.64 + [in] unsigned int endIndex,
1.65 + [out] int *x,
1.66 + [out] int *y,
1.67 + [out] int *width,
1.68 + [out] int *height);
1.69 +
1.70 + HRESULT get_unclippedSubstringBounds([in] unsigned int startIndex,
1.71 + [in] unsigned int endIndex,
1.72 + [out] int *x,
1.73 + [out] int *y,
1.74 + [out] int *width,
1.75 + [out] int *height);
1.76 +
1.77 + HRESULT scrollToSubstring([in] unsigned int startIndex,
1.78 + [in] unsigned int endIndex);
1.79 +
1.80 + [propget] HRESULT fontFamily([out, retval] BSTR *fontFamily);
1.81 +};
1.82 +
