summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/gallery/GalleryItem.idl
blob: 8408ee8816c0f558c180b33363929307585ab667 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: GalleryItem.idl,v $
 * $Revision: 1.4 $
 *
 * 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_gallery_GalleryItem_idl__
#define __com_sun_star_gallery_GalleryItem_idl__

#ifndef __com_sun_star_gallery_XGalleryItem_idl__
#include <com/sun/star/gallery/XGalleryItem.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_graphic_XGraphic_idl__
#include <com/sun/star/graphic/XGraphic.idl>
#endif
#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module gallery {

//=============================================================================

/** service to get access to the properties of a single Gallery item
 */
service GalleryItem
{
    interface ::com::sun::star::gallery::XGalleryItem;

    interface ::com::sun::star::beans::XPropertySet;

    /** The type of the Gallery item

        @see GalleryItemType
    */
    [readonly, property] byte GalleryItemType;

    /** the URL of the Gallery item

        <p>The interpretation of the URL depends on the type
        of the Gallery item. In case of graphic and media items,
        the URL is a 'real' URL, in case of drawings it is a private
        URL</p>
     */
    [readonly, property] string URL;

    /** the title of the Gallery item
     */
    [property] string Title;

    /** the thumbnail of the Gallery item

        <p>The thumbnail may be either a pixel or a vector graphic</p>
     */
    [readonly, property] com::sun::star::graphic::XGraphic Thumbnail;

    /** the graphic content of the Gallery item

        <p>This is an optional property and may not available for every item</p>
     */
    [optional, readonly, property ] ::com::sun::star::graphic::XGraphic Graphic;

    /** the drawing content of the Gallery item

        <p>This is an optional property and may not available for every item</p>
     */
    [optional, readonly, property ] ::com::sun::star::lang::XComponent Drawing;
};

//=============================================================================

}; }; }; };

#endif