office-gobmx/offapi/com/sun/star/text/XTextViewCursor.idl
2011-04-02 00:08:53 +02:00

76 lines
2.7 KiB
Text

/*************************************************************************
*
* 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_XTextViewCursor_idl__
#define __com_sun_star_text_XTextViewCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#include <com/sun/star/awt/Point.idl>
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
// DocMerge from xml: interface com::sun::star::text::XTextViewCursor
/** describes a cursor in a text document's view.
*/
published interface XTextViewCursor: com::sun::star::text::XTextCursor
{
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::text::XTextViewCursor::isVisible
/** @returns
<TRUE/> if this cursor is visible for the user.
*/
boolean isVisible();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::text::XTextViewCursor::setVisible
/** shows or hides this cursor for the user.
*/
[oneway] void setVisible( [in] boolean bVisible );
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::text::XTextViewCursor::getPosition
/** @returns
the cursor's coordinates relative to the top left position of
the first page of the document.
*/
com::sun::star::awt::Point getPosition();
};
//=============================================================================
}; }; }; };
#endif