offapi/com/sun/star/chart2/XLegend.idl

   1 #ifndef com_sun_star_chart_XLegend_idl
   2 #define com_sun_star_chart_XLegend_idl
   3
   4 #include <com/sun/star/uno/XInterface.idl>
   5
   6 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
   7 #include <com/sun/star/lang/IllegalArgumentException.idl>
   8 #endif
   9 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  10 #include <com/sun/star/container/NoSuchElementException.idl>
  11 #endif
  12
  13 #include <com/sun/star/chart2/XLegendEntry.idl>
  14
  15 module com
  16 {
  17 module sun
  18 {
  19 module star
  20 {
  21 module chart2
  22 {
  23
  24 /** interface for the legend of a diagram
  25  */
  26 interface XLegend : ::com::sun::star::uno::XInterface
  27 {
  28     /** The entry added is appended to the list, such that it appears
  29         at the end of the legend.
  30
  31         @param xEntry
  32
  33             If it supports <type>CustomLegendEntry</type>,
  34             the <type>XTitle</type> is used for displaying a text, and
  35             the symbol is displayed according to the
  36             <member>CustomLegendEntry::SymbolStyle</member> property.
  37      */
  38     void registerEntry( [in] XLegendEntry xEntry )
  39         raises( com::sun::star::lang::IllegalArgumentException );
  40
  41     /** Removes an entry that was registered before
  42
  43         <p>(see <member>registerEntry</member>)</p>
  44      */
  45     void revokeEntry( [in] XLegendEntry xEntry )
  46         raises( com::sun::star::container::NoSuchElementException );
  47
  48     /** Returns a list of all legend entries in the order in which
  49         they were registered.
  50      */
  51     sequence< XLegendEntry > getEntries();
  52 };
  53
  54 } ; // chart2
  55 } ; // com
  56 } ; // sun
  57 } ; // star
  58
  59 #endif