offapi/com/sun/star/text/XTextViewCursor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XTextViewCursor_idl__
  28 #define __com_sun_star_text_XTextViewCursor_idl__
  29
  30 #ifndef __com_sun_star_text_XTextCursor_idl__
  31 #include <com/sun/star/text/XTextCursor.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_awt_Point_idl__
  35 #include <com/sun/star/awt/Point.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::text::XTextViewCursor
  46 /** describes a cursor in a text document's view.
  47  */
  48 published interface XTextViewCursor: com::sun::star::text::XTextCursor
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     // DocMerge from idl: method com::sun::star::text::XTextViewCursor::isVisible
  53     /** @returns
  54                 <TRUE/> if this cursor is visible for the user.
  55      */
  56     boolean isVisible();
  57
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from xml: method com::sun::star::text::XTextViewCursor::setVisible
  61     /** shows or hides this cursor for the user.
  62      */
  63     [oneway] void setVisible( [in] boolean bVisible );
  64
  65     //-------------------------------------------------------------------------
  66
  67     // DocMerge from idl: method com::sun::star::text::XTextViewCursor::getPosition
  68     /** @returns
  69                 the cursor's coordinates relative to the top left position of
  70                 the first page of the document.
  71      */
  72     com::sun::star::awt::Point getPosition();
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif