/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (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.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef nsITextContent_h___ #define nsITextContent_h___ #include "nsIContent.h" #include "nsIDocument.h" class nsString; class nsTextFragment; // IID for the nsITextContent interface // e4ef843f-1061-45e6-9c81-30eac2673f41 #define NS_ITEXT_CONTENT_IID \ { 0xe4ef843f, 0x1061, 0x45e6, \ { 0x9c, 0x81, 0x30, 0xea, 0xc2, 0x67, 0x3f, 0x41 } } /** * Interface for textual content. This interface is used to provide * an efficient access to text content. */ class nsITextContent : public nsIContent { public: NS_DECLARE_STATIC_IID_ACCESSOR(NS_ITEXT_CONTENT_IID) nsITextContent(nsINodeInfo *aNodeInfo) : nsIContent(aNodeInfo) { } /** * Get direct access (but read only) to the text in the text content. */ virtual const nsTextFragment *Text() = 0; /** * Get the length of the text content. */ virtual PRUint32 TextLength() = 0; /** * Set the text to the given value. If aNotify is PR_TRUE then * the document is notified of the content change. */ virtual void SetText(const PRUnichar* aBuffer, PRUint32 aLength, PRBool aNotify) = 0; /** * Set the text to the given value. If aNotify is PR_TRUE then * the document is notified of the content change. */ void SetText(const nsAString& aStr, PRBool aNotify) { SetText(aStr.BeginReading(), aStr.Length(), aNotify); } /** * Query method to see if the frame is nothing but whitespace */ virtual PRBool IsOnlyWhitespace() = 0; /** * Append the text content to aResult. */ virtual void AppendTextTo(nsAString& aResult) = 0; }; NS_DEFINE_STATIC_IID_ACCESSOR(nsITextContent, NS_ITEXT_CONTENT_IID) // XXX These belong elsewhere /** * aNodeInfoManager must not be null. */ nsresult NS_NewTextNode(nsITextContent **aResult, nsNodeInfoManager *aNodeInfoManager); /** * aNodeInfoManager must not be null. */ nsresult NS_NewCommentNode(nsIContent **aResult, nsNodeInfoManager *aNodeInfoManager); #endif /* nsITextContent_h___ */