diff options
Diffstat (limited to 'include/test/unoapi_property_testers.hxx')
| -rw-r--r-- | include/test/unoapi_property_testers.hxx | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/include/test/unoapi_property_testers.hxx b/include/test/unoapi_property_testers.hxx new file mode 100644 index 000000000..4d83e8179 --- /dev/null +++ b/include/test/unoapi_property_testers.hxx @@ -0,0 +1,173 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#ifndef INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX +#define INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX + +#include <com/sun/star/beans/XPropertySet.hpp> +#include <com/sun/star/uno/Reference.hxx> +#include <com/sun/star/util/Color.hpp> + +#include <sal/config.h> +#include <test/testdllapi.hxx> + +namespace apitest +{ +/** @brief Tester for property type 'boolean' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + */ +void OOO_DLLPUBLIC_TEST testBooleanProperty( + css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name); + +/** @brief Tester for optional property type 'boolean' of a @see com::sun::star::beans::XPropertySet. + * + * Pass the test also if the property doesn't exists (throws a com::sun::star::beans::UnknownPropertyException) + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + */ +void OOO_DLLPUBLIC_TEST testBooleanOptionalProperty( + css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name); + +/** @brief Tester for read-only property type 'boolean' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + */ +void OOO_DLLPUBLIC_TEST testBooleanReadonlyProperty( + css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name); + +/** @brief Tester for property type 'double' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testDoubleProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const double& dValue = 42.0); + +/** @brief Tester for read-only property type 'double' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testDoubleReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const double& dValue = 42.0); + +/** @brief Tester for property type 'long' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testLongProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int32& nValue = 42); + +/** @brief Tester for optional property type 'long' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testLongOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int32& nValue = 42); + +/** @brief Tester for read-only property type 'long' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testLongReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int32& nValue = 42); + +/** @brief Tester for property type 'short' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testShortProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int16& nValue = 42); + +/** @brief Tester for optional property type 'short' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testShortOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int16& nValue = 42); + +/** @brief Tester for read-only property type 'short' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param nValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testShortReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const sal_Int16& nValue = 42); + +/** @brief Tester for property type 'string' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param rValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testStringProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const OUString& rValue); + +/** @brief Tester for optional property type 'string' of a @see com::sun::star::beans::XPropertySet. + * + * Pass the test also if the property doesn't exists (throws a com::sun::star::beans::UnknownPropertyException) + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param rValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testStringOptionalProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const OUString& rValue = OUString("StringValue")); + +/** @brief Tester for read-only property type 'string' of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param rValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST +testStringReadonlyProperty(css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, + const OUString& name, const OUString& rValue); + +/** @brief Tester for property type com::sun::star::util::Color of a @see com::sun::star::beans::XPropertySet. + * + * @param xPropertySet The property set, which contains the property to test against. + * @param name Name of property to test. + * @param rValue Value to use when setting a new value. + */ +void OOO_DLLPUBLIC_TEST testColorProperty( + css::uno::Reference<css::beans::XPropertySet> const& xPropertySet, const OUString& name, + const css::util::Color& rValue = css::util::Color(0x12345678)); + +} // namespace apitest +#endif // INCLUDED_TEST_INC_UNOAPIPROPERTYTESTERS_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ |