xref: /aoo41x/main/offapi/com/sun/star/text/XSentenceCursor.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XSentenceCursor_idl__
#define __com_sun_star_text_XSentenceCursor_idl__

#ifndef __com_sun_star_text_XTextCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#endif


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

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

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

/** makes it possible to perform cursor movements through sentences.
 */
published interface XSentenceCursor: com::sun::star::text::XTextCursor
{
	//-------------------------------------------------------------------------

	/** determines if the cursor is positioned at the start of a sentence.
	 */
	boolean isStartOfSentence();

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

	/** determines if the cursor is positioned at the end of a sentence.
	 */
	boolean isEndOfSentence();

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

	/** moves the cursor to the start of the next sentence.

        @returns
            <true/> if the cursor was moved. It returns <false/> it the
            cursor can not advance further.
     */
	boolean gotoNextSentence( [in] boolean Expand );

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

	/** moves the cursor to the start of the previous sentence.

        @returns
            <true/> if the cursor was moved. It returns <false/> it the
            cursor can not advance further.
     */
	boolean gotoPreviousSentence( [in] boolean Expand );

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

	/** moves the cursor to the start of the current sentence.

        @returns
            <true/> if the cursor is now at the start of a sentence,
            <false/> otherwise. If <false/> was returned the cursor
            will remain at its original position.
	 */
	boolean gotoStartOfSentence( [in] boolean Expand );

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

	/** moves the cursor to the end of the current sentence.

        @returns
            <true/> if the cursor is now at the end of a sentence,
            <false/> otherwise. If <false/> was returned the cursor
            will remain at its original position.
	 */
	boolean gotoEndOfSentence( [in] boolean Expand );

};

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

}; }; }; };

#endif