Back to index

lightning-sunbird  0.9+nobinonly
ISimpleDOMText.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 import "objidl.idl";
00040 import "oaidl.idl";
00041         
00042 cpp_quote("///////////////////////////////////////////////////////////////////////////////////////////////////////")
00043 cpp_quote("//")
00044 cpp_quote("// ISimpleDOMText")
00045 cpp_quote("// ---------------------------------------------------------------------------------------------------=")
00046 cpp_quote("// An interface that extends MSAA's IAccessible to provide important additional capabilities on text nodes")
00047 cpp_quote("//")
00048 cpp_quote("// @STATUS UNDER_REVIEW")
00049 cpp_quote("//")
00050 cpp_quote("// [propget] domText(/* out,retval */ BSTR *domText")
00051 cpp_quote("// ---------------------------------------------------------------------------------------------------=")
00052 cpp_quote("// Similar to IAccessible::get_accName, but does not strip out whitespace characters.")
00053 cpp_quote("// Important for retrieving the correct start/end substring indices to use with other")
00054 cpp_quote("// methods in ISimpleDOMText.")
00055 cpp_quote("//")
00056 cpp_quote("//")
00057 cpp_quote("// get_[un]clippedSubstringBounds(")
00058 cpp_quote("//   /* [in] */ unsigned int startIndex,")
00059 cpp_quote("//   /* [in] */ unsigned int endIndex,")
00060 cpp_quote("//   /* [out] */ int *x,")
00061 cpp_quote("//   /* [out] */ int *y,")
00062 cpp_quote("//   /* [out] */ int *width,")
00063 cpp_quote("//   /* [out] */ int *height);")
00064 cpp_quote("// ---------------------------------------------------------------------------------------------------=")
00065 cpp_quote("// Both methods get_clippedSubstringBounds and get_unclippedSubstringBounds return the screen pixel")
00066 cpp_quote("// coordinates of the given text substring. The in parameters for start and end indices refer")
00067 cpp_quote("// to the string returned by ISimpleDOMText::get_domText().")
00068 cpp_quote("//")
00069 cpp_quote("//")
00070 cpp_quote("// scrollToSubstring(")
00071 cpp_quote("//   /* [in] */ unsigned int startIndex,")
00072 cpp_quote("//   /* [in] */ unsigned int endIndex);")
00073 cpp_quote("// ---------------------------------------------------------------------------------------------------=")
00074 cpp_quote("// In scrollable views, scrolls to ensure that the specified substring is visible onscreen.")
00075 cpp_quote("// The in parameters for start and end indices refer to the string returned")
00076 cpp_quote("// by ISimpleDOMText::get_domText().")
00077 cpp_quote("//")
00078 cpp_quote("//")
00079 cpp_quote("// [propget] fontFamily(/* out,retval */ BSTR *fontFamily);")
00080 cpp_quote("// ---------------------------------------------------------------------------------------------------=")
00081 cpp_quote("// Return a single computed font family name, which is better than the comma delineated list")
00082 cpp_quote("// that is returned by the ISimpleDOMNode computed style methods for font-family.")
00083 cpp_quote("// In other words, return something like 'Arial' instead of 'Arial, Helvetica, Sans-serif'.")
00084 cpp_quote("
00085 cpp_quote("")
00086 cpp_quote("")
00087 
00088 [object, uuid(4e747be5-2052-4265-8af0-8ecad7aad1c0)]
00089 interface ISimpleDOMText: IUnknown
00090 {
00091   // Includes whitespace in DOM
00092   [propget] HRESULT domText([out, retval] BSTR *domText);
00093 
00094   HRESULT get_clippedSubstringBounds([in] unsigned int startIndex, 
00095                                      [in] unsigned int endIndex, 
00096                                      [out] int *x,
00097                                      [out] int *y,
00098                                      [out] int *width,
00099                                      [out] int *height);
00100 
00101   HRESULT get_unclippedSubstringBounds([in] unsigned int startIndex, 
00102                                        [in] unsigned int endIndex, 
00103                                        [out] int *x,
00104                                        [out] int *y,
00105                                        [out] int *width,
00106                                        [out] int *height);
00107 
00108   HRESULT scrollToSubstring([in] unsigned int startIndex, 
00109                             [in] unsigned int endIndex);
00110 
00111   [propget] HRESULT fontFamily([out, retval] BSTR *fontFamily);
00112 };
00113