summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/XSlidePreviewCache.idl
blob: a7977ccfd3db73ceb8550a6420da6a2dfda82423 (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_drawing_XSlidePreviewCache_idl__
#define __com_sun_star_drawing_XSlidePreviewCache_idl__

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/geometry/IntegerSize2D.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/rendering/XBitmap.idl>
#include <com/sun/star/rendering/XCanvas.idl>
#include <com/sun/star/drawing/XSlidePreviewCacheListener.idl>

module com { module sun { module star { module drawing {

/** A cache of preview bitmaps for the slides of one Impress or Draw
    document in one size.  There may be more than one cache for one
    document.  These are internally connected and for missing previews one
    cache may take it from another cache and scale it to the desired size.
    When a preview is not present then it is created asynchronously.  On
    creation all registered listeners are notified.

    Slides are referenced via their index in an XIndexAccess container in
    order to allow multiple references to a single slide (custom
    presentations).
*/
published interface XSlidePreviewCache
{
    /** Set the set of slides for which the cache will provide the
        previews.  All slides in the given XIndexAccess are required to come
        from the given model.
        @param xSlides
            The set of slides for which the called cache will provide the
            previews.  This container defines the indices that are used to
            look up slides.
        @param xDocument
            The model that contains the slides reference by the xSlides argument.
    */
    void setDocumentSlides (
        [in] ::com::sun::star::container::XIndexAccess xSlides,
        [in] ::com::sun::star::uno::XInterface xDocument);

    /** Define which slides are currently visible on the screen and which
        are not.  This information is used for give preview creation for
        visible slides a higher priority than for those slides that are not
        visible.
    */
    void setVisibleRange ([in] long nFirstVisibleSlideIndex, [in] long nLastVisibleSlideIndex);

    /** Define the size of the previews that are managed by the called
        cache.
    */
    void setPreviewSize ([in] ::com::sun::star::geometry::IntegerSize2D aSize);

    /** Return a preview for the given slide index.
        The returned bitmap may be the requested preview, a preview of the
        preview, i.e. a scaled up or down version, or an empty reference
        when the preview is not yet present.

        This call may lead to the asynchronous creation of the requested
        preview.  In that case all registered listeners are notified when
        the preview has been created.
    */
    ::com::sun::star::rendering::XBitmap getSlidePreview (
        [in] long nSlideIndex,
        [in] ::com::sun::star::rendering::XCanvas xCanvas)
          raises(::com::sun::star::lang::IllegalArgumentException);

    /** Register a listener that is called when a preview has been created
        asynchronously.
    */
    void addPreviewCreationNotifyListener ([in] XSlidePreviewCacheListener xListener);

    /** Remove a previously registered listener for preview creations.
    */
    void removePreviewCreationNotifyListener ([in] XSlidePreviewCacheListener xListener);

    /** Stop the asynchronous creation of previews temporarily.
        Call <method>resume()</method> to restart it.
    */
    void pause ();

    /** Resume the asynchronous creation of slide previews.
    */
    void resume ();
};

}; }; }; }; // ::com::sun::star::drawing

#endif