summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart2/XLegend.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/chart2/XLegend.idl')
-rw-r--r--offapi/com/sun/star/chart2/XLegend.idl59
1 files changed, 59 insertions, 0 deletions
diff --git a/offapi/com/sun/star/chart2/XLegend.idl b/offapi/com/sun/star/chart2/XLegend.idl
new file mode 100644
index 000000000000..309aa148dd2a
--- /dev/null
+++ b/offapi/com/sun/star/chart2/XLegend.idl
@@ -0,0 +1,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