AOO410/main/offapi/com/sun/star/text/XDocumentIndexMark.idl

/**************************************************************
 * 
 * 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_XDocumentIndexMark_idl__ 
#define __com_sun_star_text_XDocumentIndexMark_idl__ 
 
#ifndef __com_sun_star_text_XTextContent_idl__ 
#include <com/sun/star/text/XTextContent.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module text { 
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::text::XDocumentIndexMark
/** gives access to the mark of a document index entry.@see DocumentIndexMark
 */
published interface XDocumentIndexMark: com::sun::star::text::XTextContent
{ 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from idl: method com::sun::star::text::XDocumentIndexMark::getMarkEntry
	/** @returns 
				the explicitly set string for the index mark. 

		 @see setMarkEntry
	 */
	string getMarkEntry(); 
 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::text::XDocumentIndexMark::setMarkEntry
	/** sets an explicit string for this index mark to use
		in the index.
		
		
		
		<p>If empty, the string of the <type>TextRange</type> to which
		the <type>TextContent</type> refers is used in the index.</p>
	 */
	void setMarkEntry( [in] string aIndexEntry ); 
 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 

#endif