include/svx/ClassificationCommon.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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
  11 #ifndef INCLUDED_SVX_CLASSIFICATIONCOMMON_HXX
  12 #define INCLUDED_SVX_CLASSIFICATIONCOMMON_HXX
  13
  14 #include <sal/config.h>
  15 #include <svx/svxdllapi.h>
  16 #include <vector>
  17 #include <sfx2/classificationhelper.hxx>
  18
  19 namespace com::sun::star::beans
  20 {
  21 class XPropertyContainer;
  22 }
  23 namespace com::sun::star::beans
  24 {
  25 struct Property;
  26 }
  27 namespace svx
  28 {
  29 class ClassificationResult;
  30 }
  31
  32 namespace svx::classification
  33 {
  34 SVX_DLLPUBLIC OUString
  35 convertClassificationResultToString(std::vector<svx::ClassificationResult> const& rResults);
  36
  37 SVX_DLLPUBLIC OUString
  38 getProperty(css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer,
  39             OUString const& rName);
  40
  41 SVX_DLLPUBLIC bool containsProperty(css::uno::Sequence<css::beans::Property> const& rProperties,
  42                                     std::u16string_view rName);
  43
  44 SVX_DLLPUBLIC void
  45 removeAllProperties(css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer);
  46
  47 SVX_DLLPUBLIC bool addOrInsertDocumentProperty(
  48     css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer,
  49     OUString const& rsKey, OUString const& rsValue);
  50
  51 SVX_DLLPUBLIC void insertFullTextualRepresentationAsDocumentProperty(
  52     css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer,
  53     sfx::ClassificationKeyCreator const& rKeyCreator,
  54     std::vector<svx::ClassificationResult> const& rResults);
  55
  56 SVX_DLLPUBLIC void
  57 insertCreationOrigin(css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer,
  58                      sfx::ClassificationKeyCreator const& rKeyCreator,
  59                      sfx::ClassificationCreationOrigin eOrigin);
  60
  61 } // end svx::classification namespace
  62
  63 #endif // INCLUDED_SVX_CLASSIFICATIONCOMMON_HXX
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */