LibreOffice LibreOffice 25.8 SDK API Reference

XFilePreview.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
21module com { module sun { module star { module ui { module dialogs {
22
27published interface XFilePreview: com::sun::star::uno::XInterface
28{
36 sequence< short > getSupportedImageFormats( );
37
45 com::sun::star::util::Color getTargetColorDepth( );
46
55 long getAvailableWidth( );
56
65 long getAvailableHeight( );
66
83 void setImage( [in] short aImageFormat, [in] any aImage )
84 raises( ::com::sun::star::lang::IllegalArgumentException );
85
98 boolean setShowState( [in] boolean bShowState );
99
106 boolean getShowState( );
107};
108
109
110}; }; }; }; };
111
112
113/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::ui::dialogs::XFilePreview
FilePicker that support the preview of various file formats should implement this interface.
Definition: XFilePreview.idl:28
com::sun::star::ui::dialogs::XFilePreview::setShowState
boolean setShowState([in] boolean bShowState)
Optionally sets the current show state of the preview.
com::sun::star::ui::dialogs::XFilePreview::getAvailableHeight
long getAvailableHeight()
The method returns the available height of the preview window even if the window is invisible or coul...
com::sun::star::ui::dialogs::XFilePreview::getSupportedImageFormats
sequence< short > getSupportedImageFormats()
The method returns all image formats that the preview supports.
com::sun::star::ui::dialogs::XFilePreview::setImage
void setImage([in] short aImageFormat, [in] any aImage)
Sets a new image.
com::sun::star::ui::dialogs::XFilePreview::getAvailableWidth
long getAvailableWidth()
The method returns the available width of the preview window even if the window is invisible or could...
com::sun::star::ui::dialogs::XFilePreview::getTargetColorDepth
com::sun::star::util::Color getTargetColorDepth()
The method returns the supported color depth of the target device.
com::sun::star::ui::dialogs::XFilePreview::getShowState
boolean getShowState()
Returns the current show state of the preview.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com
Definition: Ambiguous.idl:20