sd/source/ui/framework/configuration/UpdateRequest.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 #pragma once
  21
  22 #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
  23 #include <com/sun/star/container/XNamed.hpp>
  24 #include <comphelper/compbase.hxx>
  25
  26 namespace com::sun::star::drawing::framework { class XConfiguration; }
  27
  28 namespace sd::framework {
  29
  30 typedef comphelper::WeakComponentImplHelper <
  31       css::drawing::framework::XConfigurationChangeRequest,
  32       css::container::XNamed
  33     > UpdateRequestInterfaceBase;
  34
  35 /** This update request is used to request configuration updates
  36     asynchronous when no other requests are being processed.  When there are
  37     other requests then we can simply wait until the last one is executed:
  38     the configuration is updated when the request queue becomes empty.  This
  39     is use by this implementation as well.  The execute() method does not
  40     really do anything.  This request just triggers the update of the
  41     configuration when it is removed as last request from the queue.
  42 */
  43 class UpdateRequest final
  44     : public UpdateRequestInterfaceBase
  45 {
  46 public:
  47     UpdateRequest() noexcept;
  48     virtual ~UpdateRequest() noexcept override;
  49
  50     // XConfigurationChangeOperation
  51
  52     virtual void SAL_CALL execute (
  53         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration) override;
  54
  55     // XNamed
  56
  57     /** Return a human readable string representation.  This is used for
  58         debugging purposes.
  59     */
  60     virtual OUString SAL_CALL getName() override;
  61
  62     /** This call is ignored because the XNamed interface is (mis)used to
  63         give access to a human readable name for debugging purposes.
  64     */
  65     virtual void SAL_CALL setName (const OUString& rName) override;
  66 };
  67
  68 } // end of namespace sd::framework
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */