sc test for XSheetAnnotations

Change-Id: Ie5ceb7f8d828eb9c1f4c92996ebb02c8a83f4cac
Reviewed-on: https://gerrit.libreoffice.org/1738
Reviewed-by: Noel Power <noel.power@suse.com>
Tested-by: Noel Power <noel.power@suse.com>
Reviewed-by: Markus Mohrhard <markus.mohrhard@googlemail.com>
Tested-by: Markus Mohrhard <markus.mohrhard@googlemail.com>

4 files changed, 190 insertions, 0 deletions

diff --git a/test/Library_subsequenttest.mk b/test/Library_subsequenttest.mk
index 77cc573b1818..1546fcb66078 100644
--- a/test/Library_subsequenttest.mk
+++ b/test/Library_subsequenttest.mk
@@ -81,6 +81,7 @@ $(eval $(call gb_Library_add_exception_objects,subsequenttest,\
     test/source/sheet/xspreadsheetdocument \
     test/source/sheet/xspreadsheets2 \
     test/source/sheet/xsheetannotation \
+    test/source/sheet/xsheetannotations \
     test/source/text/xtext \
     test/source/text/xtextfield \
     test/source/text/xtextcontent \
diff --git a/test/Package_inc.mk b/test/Package_inc.mk
index 7e236a7abb14..2abda25a7b01 100644
--- a/test/Package_inc.mk
+++ b/test/Package_inc.mk
@@ -53,6 +53,7 @@ $(eval $(call gb_Package_add_file,test_inc,inc/test/sheet/xprintareas.hxx,test/s
 $(eval $(call gb_Package_add_file,test_inc,inc/test/sheet/xspreadsheetdocument.hxx,test/sheet/xspreadsheetdocument.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/sheet/xspreadsheets2.hxx,test/sheet/xspreadsheets2.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/sheet/xsheetannotation.hxx,test/sheet/xsheetannotation.hxx))
+$(eval $(call gb_Package_add_file,test_inc,inc/test/sheet/xsheetannotations.hxx,test/sheet/xsheetannotations.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/text/xtext.hxx,test/text/xtext.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/text/xtextfield.hxx,test/text/xtextfield.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/text/xtextcontent.hxx,test/text/xtextcontent.hxx))
diff --git a/test/inc/test/sheet/xsheetannotations.hxx b/test/inc/test/sheet/xsheetannotations.hxx
new file mode 100644
index 000000000000..9c1c2111008c
--- /dev/null
+++ b/test/inc/test/sheet/xsheetannotations.hxx
@@ -0,0 +1,56 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License or as specified alternatively below. You may obtain a copy of
+ * the License at http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * Major Contributor(s):
+ * Copyright (C) 2013 Laurent Godard lgodard.libre@laposte.net (initial developer)
+ *
+ * All Rights Reserved.
+ *
+ * For minor contributions see the git repository.
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+#include <rtl/ustring.hxx>
+#include <com/sun/star/sheet/XSheetAnnotations.hpp>
+#include <test/testdllapi.hxx>
+
+using namespace com::sun::star;
+
+namespace apitest {
+
+class OOO_DLLPUBLIC_TEST XSheetAnnotations
+{
+public:
+    virtual uno::Reference< uno::XInterface > init() = 0;
+
+    // XSheetAnnotations
+    void testInsertNew();
+    void testRemoveByIndex();
+
+
+protected:
+    ~XSheetAnnotations() {}
+
+    virtual uno::Reference< sheet::XSheetAnnotations> getAnnotations() = 0;
+
+};
+
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/test/source/sheet/xsheetannotations.cxx b/test/source/sheet/xsheetannotations.cxx
new file mode 100644
index 000000000000..7f2d63862afb
--- /dev/null
+++ b/test/source/sheet/xsheetannotations.cxx
@@ -0,0 +1,132 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License or as specified alternatively below. You may obtain a copy of
+ * the License at http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * Major Contributor(s):
+ * Copyright (C) 2011 Laurent Godard lgodard.libre@laposte.net (initial developer)
+ *
+ * All Rights Reserved.
+ *
+ * For minor contributions see the git repository.
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+#include <test/sheet/xsheetannotations.hxx>
+
+#include <com/sun/star/table/CellAddress.hpp>
+#include <com/sun/star/container/XIndexAccess.hpp>
+#include <com/sun/star/sheet/XSheetAnnotation.hpp>
+#include <com/sun/star/text/XTextRange.hpp>
+
+#include "cppunit/extensions/HelperMacros.h"
+#include <rtl/ustring.hxx>
+
+using namespace com::sun::star::uno;
+
+namespace apitest {
+
+void XSheetAnnotations::testInsertNew()
+{
+    uno::Reference< sheet::XSheetAnnotations > aSheetAnnotations (init(), UNO_QUERY_THROW);
+
+    // count before inserting
+    uno::Reference< container::XIndexAccess > xAnnotationsIndex (aSheetAnnotations, UNO_QUERY_THROW);
+    sal_Int32 nBefore = xAnnotationsIndex->getCount();
+
+    // insert the annotation
+    table::CellAddress xTargetCellAddress (0,3,4);
+    aSheetAnnotations->insertNew(xTargetCellAddress, "an inserted annotation");
+
+    // count after inserting
+    //uno::Reference< container::XIndexAccess > xAnnotationsIndexAfter (aSheetAnnotations, UNO_QUERY_THROW);
+    sal_Int32 nAfter = xAnnotationsIndex->getCount();
+
+    CPPUNIT_ASSERT_MESSAGE("Annotations index not updated", nAfter == nBefore + 1);
+
+    // is the position ok ?
+    uno::Reference< sheet::XSheetAnnotation > aLastSheetAnnotation (xAnnotationsIndex->getByIndex(nAfter-1), UNO_QUERY_THROW);
+    table::CellAddress xResultCellAddress = aLastSheetAnnotation->getPosition();
+
+    CPPUNIT_ASSERT_MESSAGE("Insert Annotation - Wrong SHEET reference position", xResultCellAddress.Sheet == xTargetCellAddress.Sheet);
+    CPPUNIT_ASSERT_MESSAGE("Insert Annotation - Wrong COLUMN reference position", xResultCellAddress.Column == xTargetCellAddress.Column);
+    CPPUNIT_ASSERT_MESSAGE("Insert Annotation - Wrong ROW reference position", xResultCellAddress.Row == xTargetCellAddress.Row);
+
+    // is the string ok ?
+    uno::Reference< text::XTextRange > aTextSheetAnnotation(aLastSheetAnnotation, UNO_QUERY_THROW);
+    rtl::OUString aString = aTextSheetAnnotation->getString();
+
+    CPPUNIT_ASSERT_MESSAGE("Insert Annotation - Wrong string", aString == "an inserted annotation");
+
+}
+
+void XSheetAnnotations::testRemoveByIndex()
+{
+    uno::Reference< sheet::XSheetAnnotations > aSheetAnnotations (init(), UNO_QUERY_THROW);
+
+    // insert some annotations
+    table::CellAddress xTargetCellAddress (0,4,5);
+    aSheetAnnotations->insertNew(xTargetCellAddress, "an inserted annotation 1");
+    table::CellAddress xToBeRemovedCellAddress (0,5,6);
+    aSheetAnnotations->insertNew(xToBeRemovedCellAddress, "an inserted annotation 2");
+    table::CellAddress xOtherCellAddress (0,7,8);
+    aSheetAnnotations->insertNew(xOtherCellAddress, "an inserted annotation 3");
+
+    // count before removing
+    uno::Reference< container::XIndexAccess > xAnnotationsIndex (aSheetAnnotations, UNO_QUERY_THROW);
+    sal_Int32 nBefore = xAnnotationsIndex->getCount();
+
+    // remove the xToBeRemovedCellAddress
+    aSheetAnnotations->removeByIndex(nBefore-2);
+
+    // count after removing
+    //uno::Reference< container::XIndexAccess > xAnnotationsIndex (aSheetAnnotations, UNO_QUERY_THROW);
+    sal_Int32 nAfter = xAnnotationsIndex->getCount();
+
+    // the last position should be xOtherCellAddress
+    uno::Reference< sheet::XSheetAnnotation > aLastSheetAnnotation (xAnnotationsIndex->getByIndex(nAfter-1), UNO_QUERY_THROW);
+    table::CellAddress xResultCellAddress = aLastSheetAnnotation->getPosition();
+
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong SHEET reference position", xResultCellAddress.Sheet == xOtherCellAddress.Sheet);
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong COLUMN reference position", xResultCellAddress.Column == xOtherCellAddress.Column);
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong ROW reference position", xResultCellAddress.Row == xOtherCellAddress.Row);
+
+    // is the string ok ?
+    uno::Reference< text::XTextRange > aLastTextSheetAnnotation(aLastSheetAnnotation, UNO_QUERY_THROW);
+    rtl::OUString aLastString = aLastTextSheetAnnotation->getString();
+
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong string", aLastString == "an inserted annotation 3");
+
+    // the previous should be xTargetCellAddress
+    uno::Reference< sheet::XSheetAnnotation > aPreviousSheetAnnotation (xAnnotationsIndex->getByIndex(nAfter-2), UNO_QUERY_THROW);
+    table::CellAddress xPreviousCellAddress = aPreviousSheetAnnotation->getPosition();
+
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong SHEET reference position", xPreviousCellAddress.Sheet == xTargetCellAddress.Sheet);
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong COLUMN reference position", xPreviousCellAddress.Column == xTargetCellAddress.Column);
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong ROW reference position", xPreviousCellAddress.Row == xTargetCellAddress.Row);
+
+    // is the string ok ?
+    uno::Reference< text::XTextRange > aPreviousTextSheetAnnotation(aPreviousSheetAnnotation, UNO_QUERY_THROW);
+    rtl::OUString aPreviousString = aPreviousTextSheetAnnotation->getString();
+
+    CPPUNIT_ASSERT_MESSAGE("Remove Annotation - Wrong string", aPreviousString == "an inserted annotation 1");
+
+}
+
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */