summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/graphic/XGraphic.idl
blob: 3acabcf2f2d713907ec8de55f78c47dd7e03c865 (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
/* -*- 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_graphic_XGraphic_idl
#define com_sun_star_graphic_XGraphic_idl

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/graphic/GraphicType.idl>

module com { module sun { module star { module graphic
{

/** This interface acts as a container for the loaded graphic.

    <p>The interface itself can be retrieved by using the appropriate
    methods of XGraphicProvider interface.
    XGraphicProvider also offers a method to store
    the graphic content at a specific location</p>

    <p>To render the graphic content onto a specific device, you
    have to create a XGraphicRenderer interface and pass
    this interface appropriately</p>

    @see XGraphicProvider
    @see XGraphicRenderer
  */
published interface XGraphic : ::com::sun::star::uno::XInterface
{
    /** Get the type of the contained graphic

        @returns
            The type of the contained graphic

        @see GraphicType
    */
    byte getType();
};

} ; } ; } ; } ;

#endif


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