PresenterConfigurationAccess.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERCONFIGURATIONACCESS_HXX
#define INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERCONFIGURATIONACCESS_HXX
 
#include <rtl/ustring.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
 
#include <vector>
#include <functional>
 
namespace sdext::presenter {
 
class PresenterConfigurationAccess
{
public:
    enum WriteMode { READ_WRITE, READ_ONLY };
    typedef ::std::function<bool (
        const OUString&,
        const css::uno::Reference<css::beans::XPropertySet>&)> Predicate;
    static constexpr OUStringLiteral msPresenterScreenRootName =
        u"/org.openoffice.Office.PresenterScreen/";
 
    PresenterConfigurationAccess(
        const css::uno::Reference<css::uno::XComponentContext>& rxContext,
        const OUString& rsRootName,
        WriteMode eMode);
 
    ~PresenterConfigurationAccess();
 
    css::uno::Any GetConfigurationNode (
        const OUString& rsPathToNode);
 
    bool IsValid() const;
 
    bool GoToChild (const OUString& rsPathToNode);
 
    bool GoToChild (const Predicate& rPredicate);
 
    bool SetProperty (const OUString& rsPropertyName, const css::uno::Any& rValue);
 
    static css::uno::Any GetConfigurationNode (
        const css::uno::Reference<css::container::XHierarchicalNameAccess>& rxNode,
        const OUString& rsPathToNode);
 
    static css::uno::Reference<css::beans::XPropertySet> GetNodeProperties (
        const css::uno::Reference<css::container::XHierarchicalNameAccess>& rxNode,
        const OUString& rsPathToNode);
 
    void CommitChanges();
 
    typedef ::std::function<void (
        const ::std::vector<css::uno::Any>&) > ItemProcessor;
    typedef ::std::function<void (
        const OUString&,
        const css::uno::Reference<css::beans::XPropertySet>&) > PropertySetProcessor;
 
    static void ForAll (
        const css::uno::Reference<css::container::XNameAccess>& rxContainer,
        const ::std::vector<OUString>& rArguments,
        const ItemProcessor& rProcessor);
    static void ForAll (
        const css::uno::Reference<css::container::XNameAccess>& rxContainer,
        const PropertySetProcessor& rProcessor);
 
    static css::uno::Any Find (
        const css::uno::Reference<css::container::XNameAccess>& rxContainer,
        const Predicate& rPredicate);
 
    static bool IsStringPropertyEqual (
        std::u16string_view rsValue,
        const OUString& rsPropertyName,
        const css::uno::Reference<css::beans::XPropertySet>& rxNode);
 
    static css::uno::Any GetProperty (
        const css::uno::Reference<css::beans::XPropertySet>& rxProperties,
        const OUString& rsKey);
 
private:
    css::uno::Reference<css::uno::XInterface> mxRoot;
    css::uno::Any maNode;
};
 
} // end of namespace sdext::tools
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */