/* -*- 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_SVTOOLS_TEMPLATEFOLDERCACHE_HXX #define INCLUDED_SVTOOLS_TEMPLATEFOLDERCACHE_HXX #include #include #include #include namespace svt { //= TemplateFolderCache class TemplateFolderCacheImpl; /** allows to cache the state of the template directories of OOo

Usually, this class is used together with an instance of a the DocumentTemplates service. It allows to scan the template folders of the Office, and updates the configuration so that it reflects the most recent state of the folders.
As this is an expensive, the TemplateFolderCache has been introduced. It caches the state of the template folders, and allows to determine if the DocumentTemplates service needs to be invoked to do the (much more expensive) update.

@example C++ TemplateFolderCache aTemplateFolders; if ( aTemplateFolders.needsUpdate() ) { // store the current state aCache.storeState(); // create the DocumentTemplates instance Reference< XDocumentTemplates > xTemplates = ...; // update the templates configuration xTemplates->update(); } // do anything which relies on a up-to-date template configuration */ class SVT_DLLPUBLIC TemplateFolderCache { private: std::unique_ptr> m_pImpl; public: /** ctor. @param _bAutoStoreState Set this to if you want the instance to automatically store the state of the template folders upon destruction.
If set to , you would explicitly need to call storeState to do this.
If the current state is not known (e.g. because you did not call needsUpdate, which retrieves it), it is not retrieved in the dtor, regardless of the _bAutoStoreState flag. */ TemplateFolderCache( bool _bAutoStoreState = false ); ~TemplateFolderCache( ); /** determines whether or not the template configuration needs to be updated @return if the template configuration needs to be updated */ bool needsUpdate(); /** stores the current state of the template folders in the cache */ void storeState(); }; } // namespace svt #endif // INCLUDED_SVTOOLS_TEMPLATEFOLDERCACHE_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ cp-4.2 LibreOffice 核心代码仓库文档基金会
summaryrefslogtreecommitdiff
AgeCommit message (Expand)Author
2019-04-01tdf#42949 Fix IWYU warnings in include/sfx2/[sS]*Gabor Kelemen
2019-01-11Resolves: tdf#122404 unlock just the toplevels that were lockedCaolán McNamara
2019-01-09tdf#122273 modal dialog on modeless dialog needs special handlingCaolán McNamara
2018-12-20Enable --help=html for flatpakStephan Bergmann
2018-11-23weld SfxMacroTabPageCaolán McNamara
2018-03-20tdf#116494: Don't ask parent if no help textMuhammet Kara
2018-02-16native dialog initial basisCaolán McNamara
2018-01-24loplugin:unused-returns in vclNoel Grandin
2017-04-06Resolves: rhbz#1438876 detect preferred help module for csv dialogCaolán McNamara
2016-10-07loplugin:staticmethods: sfx2Stephan Bergmann
2016-09-13loplugin:override: No more need for the "MSVC dtor override" workaroundStephan Bergmann
2016-06-02loplugin:unusedfieldsNoel Grandin
2016-05-26tdf#89329: use unique_ptr for pImpl in sfxhelpXisco Fauli
2015-10-12Replace "SAL_OVERRIDE" with "override" in LIBO_INTERNAL_ONLY codeStephan Bergmann
2015-07-16-Werror,-Wunused-private-fieldStephan Bergmann
2015-07-16loplugin:unusedmethods sfx2Noel Grandin
2014-09-23fdo#82577: Handle WindowNoel Grandin
2014-04-01Explicitly mark overriding destructors as "virtual"Stephan Bergmann
2014-03-27Second batch of adding SAL_OVERRIDE to overriding function declarationsStephan Bergmann
2014-03-18sfx2: sal_Bool->boolNoel Grandin
2014-02-21vcl: sal_Bool -> boolStephan Bergmann
2013-11-09fdo#65108 inter-module includes <> include/sfx2Norbert Thiebaud
2013-10-23fixincludeguards.sh: include/s*Thomas Arnhold
2013-07-10removed unused language/country string member variablesEike Rathke
2013-06-06Remove remnants of help agentCaolán McNamara
2013-04-23execute move of global headersBjoern Michaelsen