xref: /aoo41x/main/offapi/com/sun/star/text/XWordCursor.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_XWordCursor_idl__
#define __com_sun_star_text_XWordCursor_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 move a cursor word by word.
 */
published interface XWordCursor: com::sun::star::text::XTextCursor
{
	//-------------------------------------------------------------------------

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

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

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

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

	/** moves the cursor to the next word.

        <p>Note: the function returning <true/> does not necessarily mean
        that the cursor is located at the next word, or any word at all!
        This may happen for example if it travels over empty paragraphs.</p>

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

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

	/** moves the cursor to the previous word.

        <p>Note: the function returning <true/> does not necessarily mean
        that the cursor is located at the previous word, or any word at all!
        This may happen for example if it travels over empty paragraphs.</p>

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

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

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

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

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

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

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

};

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

}; }; }; };

#endif