include/test/unoapi_property_testers.hxx

   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 #ifndef INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX
  11 #define INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX
  12
  13 #include <com/sun/star/beans/XPropertySet.hpp>
  14 #include <com/sun/star/uno/Reference.hxx>
  15 #include <com/sun/star/util/Color.hpp>
  16
  17 #include <sal/config.h>
  18 #include <test/testdllapi.hxx>
  19
  20 namespace apitest
  21 {
  22 /** @brief Tester for property type 'boolean' of a @see com::sun::star::beans::XPropertySet.
  23  *
  24  * @param   xPropertySet    The property set, which contains the property to test against.
  25  * @param   name            Name of property to test.
  26  */
  27 void OOO_DLLPUBLIC_TEST testBooleanProperty(
  28     css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name);
  29
  30 /** @brief Tester for optional property type 'boolean' of a @see com::sun::star::beans::XPropertySet.
  31  *
  32  * Pass the test also if the property doesn't exists (throws a com::sun::star::beans::UnknownPropertyException)
  33  *
  34  * @param   xPropertySet    The property set, which contains the property to test against.
  35  * @param   name            Name of property to test.
  36  */
  37 void OOO_DLLPUBLIC_TEST testBooleanOptionalProperty(
  38     css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name);
  39
  40 /** @brief Tester for read-only property type 'boolean' of a @see com::sun::star::beans::XPropertySet.
  41  *
  42  * @param   xPropertySet    The property set, which contains the property to test against.
  43  * @param   name            Name of property to test.
  44  */
  45 void OOO_DLLPUBLIC_TEST testBooleanReadonlyProperty(
  46     css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name);
  47
  48 /** @brief Tester for property type 'double' of a @see com::sun::star::beans::XPropertySet.
  49  *
  50  * @param   xPropertySet    The property set, which contains the property to test against.
  51  * @param   name            Name of property to test.
  52  * @param   nValue          Value to use when setting a new value.
  53  */
  54 void OOO_DLLPUBLIC_TEST
  55 testDoubleProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
  56                    const OUString& name, const double& dValue = 42.0);
  57
  58 /** @brief Tester for read-only property type 'double' of a @see com::sun::star::beans::XPropertySet.
  59  *
  60  * @param   xPropertySet    The property set, which contains the property to test against.
  61  * @param   name            Name of property to test.
  62  * @param   nValue          Value to use when setting a new value.
  63  */
  64 void OOO_DLLPUBLIC_TEST
  65 testDoubleReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
  66                            const OUString& name, const double& dValue = 42.0);
  67
  68 /** @brief Tester for property type 'long' of a @see com::sun::star::beans::XPropertySet.
  69  *
  70  * @param   xPropertySet    The property set, which contains the property to test against.
  71  * @param   name            Name of property to test.
  72  * @param   nValue          Value to use when setting a new value.
  73  */
  74 void OOO_DLLPUBLIC_TEST
  75 testLongProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
  76                  const OUString& name, const sal_Int32& nValue = 42);
  77
  78 /** @brief Tester for optional property type 'long' of a @see com::sun::star::beans::XPropertySet.
  79  *
  80  * @param   xPropertySet    The property set, which contains the property to test against.
  81  * @param   name            Name of property to test.
  82  * @param   nValue          Value to use when setting a new value.
  83  */
  84 void OOO_DLLPUBLIC_TEST
  85 testLongOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
  86                          const OUString& name, const sal_Int32& nValue = 42);
  87
  88 /** @brief Tester for read-only property type 'long' of a @see com::sun::star::beans::XPropertySet.
  89  *
  90  * @param   xPropertySet    The property set, which contains the property to test against.
  91  * @param   name            Name of property to test.
  92  * @param   nValue          Value to use when setting a new value.
  93  */
  94 void OOO_DLLPUBLIC_TEST
  95 testLongReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
  96                          const OUString& name, const sal_Int32& nValue = 42);
  97
  98 /** @brief Tester for property type 'short' of a @see com::sun::star::beans::XPropertySet.
  99  *
 100  * @param   xPropertySet    The property set, which contains the property to test against.
 101  * @param   name            Name of property to test.
 102  * @param   nValue          Value to use when setting a new value.
 103  */
 104 void OOO_DLLPUBLIC_TEST
 105 testShortProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 106                   const OUString& name, const sal_Int16& nValue = 42);
 107
 108 /** @brief Tester for optional property type 'short' of a @see com::sun::star::beans::XPropertySet.
 109  *
 110  * @param   xPropertySet    The property set, which contains the property to test against.
 111  * @param   name            Name of property to test.
 112  * @param   nValue          Value to use when setting a new value.
 113  */
 114 void OOO_DLLPUBLIC_TEST
 115 testShortOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 116                           const OUString& name, const sal_Int16& nValue = 42);
 117
 118 /** @brief Tester for read-only property type 'short' of a @see com::sun::star::beans::XPropertySet.
 119  *
 120  * @param   xPropertySet    The property set, which contains the property to test against.
 121  * @param   name            Name of property to test.
 122  * @param   nValue          Value to use when setting a new value.
 123  */
 124 void OOO_DLLPUBLIC_TEST
 125 testShortReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 126                           const OUString& name, const sal_Int16& nValue = 42);
 127
 128 /** @brief Tester for property type 'string' of a @see com::sun::star::beans::XPropertySet.
 129  *
 130  * @param   xPropertySet    The property set, which contains the property to test against.
 131  * @param   name            Name of property to test.
 132  * @param   rValue          Value to use when setting a new value.
 133  */
 134 void OOO_DLLPUBLIC_TEST
 135 testStringProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 136                    const OUString& name, const OUString& rValue);
 137
 138 /** @brief Tester for optional property type 'string' of a @see com::sun::star::beans::XPropertySet.
 139  *
 140  * Pass the test also if the property doesn't exists (throws a com::sun::star::beans::UnknownPropertyException)
 141  *
 142  * @param   xPropertySet    The property set, which contains the property to test against.
 143  * @param   name            Name of property to test.
 144  * @param   rValue          Value to use when setting a new value.
 145  */
 146 void OOO_DLLPUBLIC_TEST
 147 testStringOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 148                            const OUString& name, const OUString& rValue = u"StringValue"_ustr);
 149
 150 /** @brief Tester for read-only property type 'string' of a @see com::sun::star::beans::XPropertySet.
 151  *
 152  * @param   xPropertySet    The property set, which contains the property to test against.
 153  * @param   name            Name of property to test.
 154  * @param   rValue          Value to use when setting a new value.
 155  */
 156 void OOO_DLLPUBLIC_TEST
 157 testStringReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet,
 158                            const OUString& name, const OUString& rValue);
 159
 160 /** @brief Tester for property type com::sun::star::util::Color of a @see com::sun::star::beans::XPropertySet.
 161  *
 162  * @param   xPropertySet    The property set, which contains the property to test against.
 163  * @param   name            Name of property to test.
 164  * @param   rValue          Value to use when setting a new value.
 165  */
 166 void OOO_DLLPUBLIC_TEST testColorProperty(
 167     css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name,
 168     const css::util::Color& rValue = css::util::Color(0x12345678));
 169
 170 } // namespace apitest
 171 #endif // INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */