summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/office/XAnnotationAccess.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/office/XAnnotationAccess.idl')
-rw-r--r--offapi/com/sun/star/office/XAnnotationAccess.idl72
1 files changed, 72 insertions, 0 deletions
diff --git a/offapi/com/sun/star/office/XAnnotationAccess.idl b/offapi/com/sun/star/office/XAnnotationAccess.idl
new file mode 100644
index 000000000000..201151b7c0fc
--- /dev/null
+++ b/offapi/com/sun/star/office/XAnnotationAccess.idl
@@ -0,0 +1,72 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * 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_office_XAnnotationAccess_idl__
+#define __com_sun_star_office_XAnnotationAccess_idl__
+
+#ifndef __com_sun_star_office_XAnnotationEnumeration_idl__
+#include <com/sun/star/office/XAnnotationEnumeration.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/office/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_office_XAnnotation_idl__
+#include <com/sun/star/office/XAnnotation.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module office {
+
+//=============================================================================
+
+/** This interface gives access to the annotation for a document content.
+ */
+interface XAnnotationAccess
+{
+ /** creates a new annotation and inserts it into the document content.
+ */
+ XAnnotation createAndInsertAnnotation();
+
+ /** removes the annotation from this document content.
+ */
+ void removeAnnotation( [in] XAnnotation annotation ) raises ( com::sun::star::lang::IllegalArgumentException );
+
+ /** @returns
+ a new enumeration object for this annotation container.
+ It returns NULL if there are no objects in this container.
+ */
+ XAnnotationEnumeration createAnnotationEnumeration();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif