framework/inc/xml/acceleratorconfigurationwriter.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_FRAMEWORK_INC_XML_ACCELERATORCONFIGURATIONWRITER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_XML_ACCELERATORCONFIGURATIONWRITER_HXX
  22
  23 #include <accelerators/acceleratorcache.hxx>
  24 #include <accelerators/keymapping.hxx>
  25 #include <general.h>
  26
  27 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
  28
  29 #include <salhelper/singletonref.hxx>
  30 #include <rtl/ustring.hxx>
  31
  32 namespace framework{
  33
  34 class AcceleratorConfigurationWriter
  35 {
  36
  37     // member
  38
  39     private:
  40
  41         /** @short  needed to write the xml configuration. */
  42         css::uno::Reference< css::xml::sax::XDocumentHandler > m_xConfig;
  43
  44         /** @short  reference to the outside container, where this
  45                     writer must work on. */
  46         const AcceleratorCache& m_rContainer;
  47
  48         /** @short  is used to map key codes to its
  49                     string representation.
  50
  51             @descr  To perform this operatio is
  52                     created only one times and holded
  53                     alive forever ...*/
  54         ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
  55
  56     // interface
  57
  58     public:
  59
  60         /** @short  connect this new writer instance
  61                     to an outside container, which should be
  62                     flushed to the underlying XML configuration.
  63
  64             @param  rContainer
  65                     a reference to the outside container.
  66
  67             @param  xConfig
  68                     used to write the configuration there.
  69           */
  70         AcceleratorConfigurationWriter(const AcceleratorCache&                                       rContainer,
  71                                        const css::uno::Reference< css::xml::sax::XDocumentHandler >& xConfig   );
  72
  73         /** @short  does nothing real ... */
  74         virtual ~AcceleratorConfigurationWriter();
  75
  76         /** @short  TODO */
  77         void flush();
  78
  79     // helper
  80
  81     private:
  82
  83         /** @short  TODO */
  84         void impl_ts_writeKeyCommandPair(const css::awt::KeyEvent&                                     aKey    ,
  85                                          const OUString&                                        sCommand,
  86                                          const css::uno::Reference< css::xml::sax::XDocumentHandler >& xConfig );
  87 };
  88
  89 } // namespace framework
  90
  91 #endif // INCLUDED_FRAMEWORK_INC_XML_ACCELERATORCONFIGURATIONWRITER_HXX
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */