presethandler.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 .
 */
 
#pragma once
 
#include <sal/config.h>
 
#include <string_view>
 
#include <accelerators/storageholder.hxx>
 
#include <com/sun/star/embed/XStorage.hpp>
 
#include <com/sun/star/uno/XComponentContext.hpp>
 
#include <i18nlangtag/languagetag.hxx>
 
namespace framework
{
class PresetHandler
{
    public:
 
        enum EConfigType
        {
            E_GLOBAL,
            E_MODULES,
            E_DOCUMENT
        };
 
    private:
 
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
        EConfigType m_eConfigType;
 
        StorageHolder m_lDocumentStorages;
 
        css::uno::Reference< css::embed::XStorage > m_xWorkingStorageShare;
 
        css::uno::Reference< css::embed::XStorage > m_xWorkingStorageNoLang;
 
        css::uno::Reference< css::embed::XStorage > m_xWorkingStorageUser;
 
        OUString m_sRelPathShare;
        OUString m_sRelPathUser;
 
    // native interface
 
    public:
 
        PresetHandler(css::uno::Reference< css::uno::XComponentContext >  xContext);
 
        PresetHandler(const PresetHandler& rCopy);
 
        ~PresetHandler();
 
        void forgetCachedStorages();
 
        css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageShare();
        css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageUser();
 
        css::uno::Reference< css::embed::XStorage > getWorkingStorageUser() const;
 
        css::uno::Reference< css::embed::XStorage > getParentStorageShare();
        css::uno::Reference< css::embed::XStorage > getParentStorageUser ();
 
        void connectToResource(      EConfigType                                  eConfigType   ,
                               std::u16string_view                             sResourceType ,
                               std::u16string_view                             sModule       ,
                               const css::uno::Reference< css::embed::XStorage >& xDocumentRoot ,
                               const LanguageTag&                                 rLanguageTag  = LanguageTag(LANGUAGE_USER_PRIV_NOTRANSLATE));
 
        void copyPresetToTarget(std::u16string_view sPreset,
                                std::u16string_view sTarget);
 
        css::uno::Reference< css::io::XStream > openPreset(std::u16string_view sPreset);
 
        css::uno::Reference< css::io::XStream > openTarget(
                std::u16string_view sTarget, sal_Int32 nMode);
 
        void commitUserChanges();
 
        void addStorageListener(XMLBasedAcceleratorConfiguration* pListener);
        void removeStorageListener(XMLBasedAcceleratorConfiguration* pListener);
 
    // helper
 
    private:
 
        css::uno::Reference< css::embed::XStorage > impl_openPathIgnoringErrors(const OUString& sPath ,
                                                                                      sal_Int32        eMode ,
                                                                                      bool         bShare);
 
        ::std::vector< OUString >::const_iterator impl_findMatchingLocalizedValue(const ::std::vector< OUString >& lLocalizedValues,
                                                                                               OUString&             rLanguageTag         ,
                                                                                               bool                          bAllowFallbacks );
 
        css::uno::Reference< css::embed::XStorage > impl_openLocalizedPathIgnoringErrors(OUString&      sPath         ,
                                                                                         sal_Int32             eMode         ,
                                                                                         bool              bShare        ,
                                                                                         OUString&             rLanguageTag  ,
                                                                                         bool              bAllowFallback);
 
        ::std::vector< OUString > impl_getSubFolderNames(const css::uno::Reference< css::embed::XStorage >& xFolder);
};
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */