offapi/com/sun/star/text/TextDocumentView.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_TextDocumentView_idl__
  20 #define __com_sun_star_text_TextDocumentView_idl__
  21
  22 #include <com/sun/star/view/OfficeDocumentView.idl>
  23
  24 #include <com/sun/star/view/XViewSettingsSupplier.idl>
  25
  26 #include <com/sun/star/text/XTextViewCursorSupplier.idl>
  27
  28 #include <com/sun/star/beans/XPropertySet.idl>
  29
  30
  31  module com {  module sun {  module star {  module text {
  32
  33
  34 /** specifies the view of a TextDocument.
  35  */
  36 published service TextDocumentView
  37 {
  38     service com::sun::star::view::OfficeDocumentView;
  39
  40
  41     /** This interface permits access to the properties of the view.
  42      */
  43     interface com::sun::star::view::XViewSettingsSupplier;
  44
  45
  46     /** This interface makes it possible to access the cursor which belongs
  47                 to the view and can be visible for the user.
  48      */
  49     interface com::sun::star::text::XTextViewCursorSupplier;
  50
  51
  52     /** Gives access to the objects properties.
  53
  54         @since OOo 2.0
  55      */
  56     [optional] interface com::sun::star::beans::XPropertySet;
  57
  58
  59     /** returns the number of pages in the document
  60
  61         <p>Since the document needs to be formatted to get the result
  62         obtaining this value may take some time.</p>
  63
  64         @since OOo 2.0
  65      */
  66     [optional, property, readonly] long PageCount;
  67
  68     /** returns the number of lines in the document
  69
  70         <p>Since the document needs to be formatted to get the result
  71         obtaining this value may take some time.</p>
  72
  73         <p>Empty paragraphs are not counted.</p>
  74
  75         @since OOo 2.0
  76      */
  77     [optional, property, readonly] long LineCount;
  78
  79     /** specifies if spell checking should be done while typing.
  80
  81         @since OOo 2.0
  82      */
  83     [optional, property] boolean IsConstantSpellcheck;
  84
  85     /** specifies if the marks for misspelled text should be displayed.
  86
  87         @since OOo 2.0
  88      */
  89     [optional, property] boolean IsHideSpellMarks;
  90
  91 };
  92
  93
  94 }; }; }; };
  95
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */