summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/TextDocumentView.idl
blob: 220dc9ead5cf059575f61d4370ee761312aa61da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_TextDocumentView_idl__
#define __com_sun_star_text_TextDocumentView_idl__

#include <com/sun/star/view/OfficeDocumentView.idl>

#include <com/sun/star/view/XViewSettingsSupplier.idl>

#include <com/sun/star/text/XTextViewCursorSupplier.idl>

#include <com/sun/star/beans/XPropertySet.idl>


 module com {  module sun {  module star {  module text {


/** specifies the view of a TextDocument.
 */
published service TextDocumentView
{
    service com::sun::star::view::OfficeDocumentView;


    /** This interface permits access to the properties of the view.
     */
    interface com::sun::star::view::XViewSettingsSupplier;


    /** This interface makes it possible to access the cursor which belongs
                to the view and can be visible for the user.
     */
    interface com::sun::star::text::XTextViewCursorSupplier;


    /** Gives access to the objects properties.

        @since OOo 2.0
     */
    [optional] interface com::sun::star::beans::XPropertySet;


    /** returns the number of pages in the document

        <p>Since the document needs to be formatted to get the result
        obtaining this value may take some time.</p>

        @since OOo 2.0
     */
    [optional, property, readonly] long PageCount;

    /** returns the number of lines in the document

        <p>Since the document needs to be formatted to get the result
        obtaining this value may take some time.</p>

        <p>Empty paragraphs are not counted.</p>

        @since OOo 2.0
     */
    [optional, property, readonly] long LineCount;

    /** specifies if spell checking should be done while typing.

        @since OOo 2.0
     */
    [optional, property] boolean IsConstantSpellcheck;

    /** specifies if the marks for misspelled text should be displayed.

        @since OOo 2.0
     */
    [optional, property] boolean IsHideSpellMarks;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */