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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TextDocumentView.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_TextDocumentView_idl__
  31 #define __com_sun_star_text_TextDocumentView_idl__
  32
  33 #ifndef __com_sun_star_view_OfficeDocumentView_idl__
  34 #include <com/sun/star/view/OfficeDocumentView.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_view_XViewSettingsSupplier_idl__
  38 #include <com/sun/star/view/XViewSettingsSupplier.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_XTextViewCursorSupplier_idl__
  42 #include <com/sun/star/text/XTextViewCursorSupplier.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XPropertySet_idl__
  46 #include <com/sun/star/beans/XPropertySet.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module text {
  52
  53 //=============================================================================
  54
  55 /** specifies the view of a <type>TextDocument</type>.
  56  */
  57 published service TextDocumentView
  58 {
  59     service com::sun::star::view::OfficeDocumentView;
  60
  61
  62     /** This interface permits access to the properties of the view.
  63      */
  64     interface com::sun::star::view::XViewSettingsSupplier;
  65
  66
  67     /** This interface makes it possible to access the cursor which belongs
  68                 to the view and can be visible for the user.
  69      */
  70     interface com::sun::star::text::XTextViewCursorSupplier;
  71
  72
  73     /** Gives access to the objects properties.
  74
  75         @since OOo 2.0
  76      */
  77     [optional] interface com::sun::star::beans::XPropertySet;
  78
  79
  80     //-------------------------------------------------------------------------
  81     /** returns the number of pages in the document
  82
  83         <p>Since the document needs to be formatted to get the result
  84         obtaining this value may take some time.</p>
  85
  86         @since OOo 2.0
  87      */
  88     [optional, property, readonly] long PageCount;
  89
  90     //-------------------------------------------------------------------------
  91     /** returns the number of lines in the document
  92
  93         <p>Since the document needs to be formatted to get the result
  94         obtaining this value may take some time.</p>
  95
  96         <p>Empty paragraphs are not counted.</p>
  97
  98         @since OOo 2.0
  99      */
 100     [optional, property, readonly] long LineCount;
 101
 102     //-------------------------------------------------------------------------
 103     /** specifies if spellchecking should be done while typing.
 104
 105         @since OOo 2.0
 106      */
 107     [optional, property] boolean IsConstantSpellcheck;
 108
 109     //-------------------------------------------------------------------------
 110     /** specifies if the marks for misspelled text should be displayed.
 111
 112         @since OOo 2.0
 113      */
 114     [optional, property] boolean IsHideSpellMarks;
 115
 116     //-------------------------------------------------------------------------
 117 };
 118
 119 //=============================================================================
 120
 121 }; }; }; };
 122
 123 #endif