sc/qa/extras/scannotationobj.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <test/calc_unoapi_test.hxx>
  11 #include <test/container/xchild.hxx>
  12 #include <test/lang/xserviceinfo.hxx>
  13 #include <test/sheet/xsheetannotation.hxx>
  14 #include <test/sheet/xsheetannotationshapesupplier.hxx>
  15 #include <test/text/xsimpletext.hxx>
  16 #include <test/text/xtextrange.hxx>
  17
  18 #include <com/sun/star/lang/XComponent.hpp>
  19 #include <com/sun/star/sheet/XSheetAnnotationAnchor.hpp>
  20 #include <com/sun/star/sheet/XSpreadsheet.hpp>
  21 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  22 #include <com/sun/star/table/CellAddress.hpp>
  23 #include <com/sun/star/table/XCell.hpp>
  24 #include <com/sun/star/uno/XInterface.hpp>
  25
  26 #include <com/sun/star/uno/Reference.hxx>
  27
  28 using namespace css;
  29
  30 namespace sc_apitest
  31 {
  32 class ScAnnontationObj : public CalcUnoApiTest,
  33                          public apitest::XChild,
  34                          public apitest::XServiceInfo,
  35                          public apitest::XSheetAnnotation,
  36                          public apitest::XSheetAnnotationShapeSupplier,
  37                          public apitest::XSimpleText,
  38                          public apitest::XTextRange
  39 {
  40 public:
  41     ScAnnontationObj();
  42
  43     virtual void setUp() override;
  44     virtual void tearDown() override;
  45
  46     virtual uno::Reference<uno::XInterface> init() override;
  47     virtual uno::Reference<sheet::XSheetAnnotation> getAnnotation(table::CellAddress&) override;
  48
  49     CPPUNIT_TEST_SUITE(ScAnnontationObj);
  50
  51     // XChild
  52     CPPUNIT_TEST(testGetSetParent);
  53
  54     // XServiceInfo
  55     CPPUNIT_TEST(testGetImplementationName);
  56     CPPUNIT_TEST(testGetSupportedServiceNames);
  57     CPPUNIT_TEST(testSupportsService);
  58
  59     // XSheetAnnotation
  60     CPPUNIT_TEST(testGetPosition);
  61     CPPUNIT_TEST(testGetAuthor);
  62     CPPUNIT_TEST(testGetDate);
  63     CPPUNIT_TEST(testGetIsVisible);
  64     CPPUNIT_TEST(testSetIsVisible);
  65
  66     // XSheetAnnotationShapeSupplier
  67     CPPUNIT_TEST(testGetAnnotationShape);
  68
  69     // XSimpleText
  70     CPPUNIT_TEST(testCreateTextCursor);
  71     CPPUNIT_TEST(testCreateTextCursorByRange);
  72     CPPUNIT_TEST(testInsertString);
  73     CPPUNIT_TEST(testInsertControlCharacter);
  74
  75     // XTextRange
  76     CPPUNIT_TEST(testGetEnd);
  77     CPPUNIT_TEST(testGetSetString);
  78     CPPUNIT_TEST(testGetStart);
  79     CPPUNIT_TEST(testGetText);
  80
  81     CPPUNIT_TEST_SUITE_END();
  82
  83 private:
  84     uno::Reference<lang::XComponent> mxComponent;
  85 };
  86
  87 ScAnnontationObj::ScAnnontationObj()
  88     : CalcUnoApiTest("/sc/qa/extras/testdocuments")
  89     , XServiceInfo("ScAnnotationObj", "com.sun.star.sheet.CellAnnotation")
  90 {
  91 }
  92
  93 uno::Reference<sheet::XSheetAnnotation>
  94 ScAnnontationObj::getAnnotation(table::CellAddress& xCellAddress)
  95 {
  96     // get the sheet
  97     uno::Reference<sheet::XSpreadsheetDocument> xDoc(mxComponent, uno::UNO_QUERY_THROW);
  98     uno::Reference<container::XIndexAccess> xIndex(xDoc->getSheets(), uno::UNO_QUERY_THROW);
  99     uno::Reference<sheet::XSpreadsheet> xSheet(xIndex->getByIndex(xCellAddress.Sheet),
 100                                                uno::UNO_QUERY_THROW);
 101
 102     // get the cell
 103     uno::Reference<table::XCell> xCell(
 104         xSheet->getCellByPosition(xCellAddress.Column, xCellAddress.Row), uno::UNO_SET_THROW);
 105
 106     // get the annotation from cell
 107     uno::Reference<sheet::XSheetAnnotationAnchor> xAnnotationAnchor(xCell, uno::UNO_QUERY_THROW);
 108     uno::Reference<sheet::XSheetAnnotation> xSheetAnnotation(xAnnotationAnchor->getAnnotation(),
 109                                                              uno::UNO_SET_THROW);
 110
 111     return xSheetAnnotation;
 112 }
 113
 114 uno::Reference<uno::XInterface> ScAnnontationObj::init()
 115 {
 116     // tested annotation is in sheet 0 cell C2
 117     table::CellAddress aCellAddress;
 118     aCellAddress.Sheet = 0;
 119     aCellAddress.Row = 1;
 120     aCellAddress.Column = 2;
 121
 122     return getAnnotation(aCellAddress);
 123 }
 124
 125 void ScAnnontationObj::setUp()
 126 {
 127     CalcUnoApiTest::setUp();
 128
 129     // get the test file
 130     OUString aFileURL;
 131     createFileURL("ScAnnotationObj.ods", aFileURL);
 132     mxComponent = loadFromDesktop(aFileURL);
 133 }
 134
 135 void ScAnnontationObj::tearDown()
 136 {
 137     closeDocument(mxComponent);
 138     CalcUnoApiTest::tearDown();
 139 }
 140
 141 CPPUNIT_TEST_SUITE_REGISTRATION(ScAnnontationObj);
 142
 143 } // namespace sc_apitest
 144
 145 CPPUNIT_PLUGIN_IMPLEMENT();
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */