LibreOffice: com/sun/star/drawing/XSlidePreviewCache.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XSlidePreviewCache.idl
Go to the documentation of this file.
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
20#ifndef __com_sun_star_drawing_XSlidePreviewCache_idl__
21#define __com_sun_star_drawing_XSlidePreviewCache_idl__
22
23#include <com/sun/star/container/XIndexAccess.idl>
24#include <com/sun/star/geometry/IntegerSize2D.idl>
25#include <com/sun/star/lang/IllegalArgumentException.idl>
26#include <com/sun/star/rendering/XBitmap.idl>
27#include <com/sun/star/rendering/XCanvas.idl>
28#include <com/sun/star/drawing/XSlidePreviewCacheListener.idl>
29
30module com { module sun { module star { module drawing {
31
43 interface XSlidePreviewCache
44{
55 void setDocumentSlides (
56 [in] ::com::sun::star::container::XIndexAccess xSlides,
57 [in] ::com::sun::star::uno::XInterface xDocument);
58
64 void setVisibleRange ([in] long nFirstVisibleSlideIndex, [in] long nLastVisibleSlideIndex);
65
69 void setPreviewSize ([in] ::com::sun::star::geometry::IntegerSize2D aSize);
70
80 ::com::sun::star::rendering::XBitmap getSlidePreview (
81 [in] long nSlideIndex,
82 [in] ::com::sun::star::rendering::XCanvas xCanvas)
83 raises(::com::sun::star::lang::IllegalArgumentException);
84
88 void addPreviewCreationNotifyListener ([in] XSlidePreviewCacheListener xListener);
89
92 void removePreviewCreationNotifyListener ([in] XSlidePreviewCacheListener xListener);
93
97 void pause ();
98
101 void resume ();
102};
103
104}; }; }; }; // ::com::sun::star::drawing
105
106#endif
107
108/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
IntegerSize2D.idl
XCanvas.idl
XIndexAccess.idl
XSlidePreviewCacheListener.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::container::XIndexAccess
provides access to the elements of a collection through an index.
Definition: XIndexAccess.idl:40
com::sun::star::drawing::XSlidePreviewCacheListener
Listener for asynchronous preview creations.
Definition: XSlidePreviewCacheListener.idl:34
com::sun::star::drawing::XSlidePreviewCache
A cache of preview bitmaps for the slides of one Impress or Draw document in one size.
Definition: XSlidePreviewCache.idl:44
com::sun::star::drawing::XSlidePreviewCache::setVisibleRange
void setVisibleRange([in] long nFirstVisibleSlideIndex, [in] long nLastVisibleSlideIndex)
Define which slides are currently visible on the screen and which are not.
com::sun::star::drawing::XSlidePreviewCache::resume
void resume()
Resume the asynchronous creation of slide previews.
com::sun::star::drawing::XSlidePreviewCache::addPreviewCreationNotifyListener
void addPreviewCreationNotifyListener([in] XSlidePreviewCacheListener xListener)
Register a listener that is called when a preview has been created asynchronously.
com::sun::star::drawing::XSlidePreviewCache::pause
void pause()
Stop the asynchronous creation of previews temporarily.
com::sun::star::drawing::XSlidePreviewCache::removePreviewCreationNotifyListener
void removePreviewCreationNotifyListener([in] XSlidePreviewCacheListener xListener)
Remove a previously registered listener for preview creations.
com::sun::star::drawing::XSlidePreviewCache::getSlidePreview
::com::sun::star::rendering::XBitmap getSlidePreview([in] long nSlideIndex, [in] ::com::sun::star::rendering::XCanvas xCanvas)
Return a preview for the given slide index.
com::sun::star::drawing::XSlidePreviewCache::setDocumentSlides
void setDocumentSlides([in] ::com::sun::star::container::XIndexAccess xSlides, [in] ::com::sun::star::uno::XInterface xDocument)
Set the set of slides for which the cache will provide the previews.
com::sun::star::drawing::XSlidePreviewCache::setPreviewSize
void setPreviewSize([in] ::com::sun::star::geometry::IntegerSize2D aSize)
Define the size of the previews that are managed by the called cache.
com::sun::star::rendering::XBitmap
This is a generic interface to a bitmap.
Definition: XBitmap.idl:41
com::sun::star::rendering::XCanvas
Central interface for rendering.
Definition: XCanvas.idl:114
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22
XBitmap.idl
com::sun::star::geometry::IntegerSize2D
This structure contains data representing a two-dimensional size.
Definition: IntegerSize2D.idl:31