xref: /aoo41x/main/offapi/com/sun/star/text/XTextDocument.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_text_XTextDocument_idl__
#define __com_sun_star_text_XTextDocument_idl__

#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif

#ifndef __com_sun_star_text_XText_idl__
#include <com/sun/star/text/XText.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: interface com::sun::star::text::XTextDocument
/** is the main interface of a text document.@see com::sun::star::text::TextDocument
 */
published interface XTextDocument: com::sun::star::frame::XModel
{
	//-------------------------------------------------------------------------

	// DocMerge from idl: method com::sun::star::text::XTextDocument::getText
	/** @returns
                the major <type scope="com::sun::star::text">Text</type> of the text document.

				<p>This text does not contain texts in <type>TextFrame</type>s,
				or cells of <type>TextTable</type>s etc. directly. These are
				accessible from the contents via <code>X...Supplier</code>
				(e.g. <type>XTextTablesSupplier</type>).
	 */
	com::sun::star::text::XText getText();

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::text::XTextDocument::reformat
	/** reformats the contents of the document.
	 */
	void reformat();

};

//=============================================================================

}; }; }; };

#endif