merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / text / TextDocumentView.idl
blobcd87a4f31404eeb5f835801e1f43fd315edf1ac1
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
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.
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).
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.
26 ************************************************************************/
27 #ifndef __com_sun_star_text_TextDocumentView_idl__
28 #define __com_sun_star_text_TextDocumentView_idl__
30 #ifndef __com_sun_star_view_OfficeDocumentView_idl__
31 #include <com/sun/star/view/OfficeDocumentView.idl>
32 #endif
34 #ifndef __com_sun_star_view_XViewSettingsSupplier_idl__
35 #include <com/sun/star/view/XViewSettingsSupplier.idl>
36 #endif
38 #ifndef __com_sun_star_text_XTextViewCursorSupplier_idl__
39 #include <com/sun/star/text/XTextViewCursorSupplier.idl>
40 #endif
42 #ifndef __com_sun_star_beans_XPropertySet_idl__
43 #include <com/sun/star/beans/XPropertySet.idl>
44 #endif
46 //=============================================================================
48 module com { module sun { module star { module text {
50 //=============================================================================
52 /** specifies the view of a <type>TextDocument</type>.
54 published service TextDocumentView
56 service com::sun::star::view::OfficeDocumentView;
59 /** This interface permits access to the properties of the view.
61 interface com::sun::star::view::XViewSettingsSupplier;
64 /** This interface makes it possible to access the cursor which belongs
65 to the view and can be visible for the user.
67 interface com::sun::star::text::XTextViewCursorSupplier;
70 /** Gives access to the objects properties.
72 @since OOo 2.0
74 [optional] interface com::sun::star::beans::XPropertySet;
77 //-------------------------------------------------------------------------
78 /** returns the number of pages in the document
80 <p>Since the document needs to be formatted to get the result
81 obtaining this value may take some time.</p>
83 @since OOo 2.0
85 [optional, property, readonly] long PageCount;
87 //-------------------------------------------------------------------------
88 /** returns the number of lines in the document
90 <p>Since the document needs to be formatted to get the result
91 obtaining this value may take some time.</p>
93 <p>Empty paragraphs are not counted.</p>
95 @since OOo 2.0
97 [optional, property, readonly] long LineCount;
99 //-------------------------------------------------------------------------
100 /** specifies if spellchecking should be done while typing.
102 @since OOo 2.0
104 [optional, property] boolean IsConstantSpellcheck;
106 //-------------------------------------------------------------------------
107 /** specifies if the marks for misspelled text should be displayed.
109 @since OOo 2.0
111 [optional, property] boolean IsHideSpellMarks;
113 //-------------------------------------------------------------------------
116 //=============================================================================
118 }; }; }; };
120 #endif