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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XTextViewCursor_idl__
  20 #define __com_sun_star_text_XTextViewCursor_idl__
  21
  22 #include <com/sun/star/text/XTextCursor.idl>
  23
  24 #include <com/sun/star/awt/Point.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30 /** describes a cursor in a text document's view.
  31  */
  32 published interface XTextViewCursor: com::sun::star::text::XTextCursor
  33 {
  34     /** @returns
  35                 `TRUE` if this cursor is visible for the user.
  36      */
  37     boolean isVisible();
  38
  39     /** shows or hides this cursor for the user.
  40      */
  41     void setVisible( [in] boolean bVisible );
  42
  43     /** @returns
  44                 the cursor's coordinates relative to the top left position of
  45                 the first page of the document.
  46      */
  47     com::sun::star::awt::Point getPosition();
  48
  49 };
  50
  51
  52 }; }; }; };
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */