summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart2/XLegend.idl
blob: 309aa148dd2ac3486a94d203f7f6b1588aac8569 (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
#ifndef com_sun_star_chart_XLegend_idl
#define com_sun_star_chart_XLegend_idl

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

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

#include <com/sun/star/chart2/XLegendEntry.idl>

module com
{
module sun
{
module star
{
module chart2
{

/** interface for the legend of a diagram
 */
interface XLegend : ::com::sun::star::uno::XInterface
{
    /** The entry added is appended to the list, such that it appears
        at the end of the legend.

        @param xEntry

            If it supports <type>CustomLegendEntry</type>,
            the <type>XTitle</type> is used for displaying a text, and
            the symbol is displayed according to the
            <member>CustomLegendEntry::SymbolStyle</member> property.
     */
    void registerEntry( [in] XLegendEntry xEntry )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** Removes an entry that was registered before

        <p>(see <member>registerEntry</member>)</p>
     */
    void revokeEntry( [in] XLegendEntry xEntry )
        raises( com::sun::star::container::NoSuchElementException );

    /** Returns a list of all legend entries in the order in which
        they were registered.
     */
    sequence< XLegendEntry > getEntries();
};

} ; // chart2
} ; // com
} ; // sun
} ; // star

#endif