sd/source/ui/framework/configuration/UpdateRequest.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: UpdateRequest.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_FRAMEWORK_UPDATE_REQUEST_HXX
  32 #define SD_FRAMEWORK_UPDATE_REQUEST_HXX
  33
  34 #include "MutexOwner.hxx"
  35 #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
  36 #include <com/sun/star/container/XNamed.hpp>
  37 #include <com/sun/star/drawing/framework/XConfiguration.hpp>
  38 #include <cppuhelper/compbase2.hxx>
  39
  40
  41 namespace {
  42
  43 typedef ::cppu::WeakComponentImplHelper2 <
  44       ::com::sun::star::drawing::framework::XConfigurationChangeRequest,
  45       ::com::sun::star::container::XNamed
  46     > UpdateRequestInterfaceBase;
  47
  48 } // end of anonymous namespace.
  49
  50
  51
  52 namespace sd { namespace framework {
  53
  54 /** This update request is used to request configuration updates
  55     asynchronous when no other requests are being processed.  When there are
  56     other requests then we can simply wait until the last one is executed:
  57     the configuration is updated when the request queue becomes empty.  This
  58     is use by this implementation as well.  The execute() method does not
  59     really do anything.  This request just triggers the update of the
  60     configuration when it is removed as last request from the queue.
  61 */
  62 class UpdateRequest
  63     : private MutexOwner,
  64       public UpdateRequestInterfaceBase
  65 {
  66 public:
  67     UpdateRequest (void) throw();
  68     virtual ~UpdateRequest (void) throw();
  69
  70
  71     // XConfigurationChangeOperation
  72
  73     virtual void SAL_CALL execute (
  74         const ::com::sun::star::uno::Reference<
  75             com::sun::star::drawing::framework::XConfiguration>& rxConfiguration)
  76         throw (::com::sun::star::uno::RuntimeException);
  77
  78
  79     // XNamed
  80
  81     /** Return a human readable string representation.  This is used for
  82         debugging purposes.
  83     */
  84     virtual ::rtl::OUString SAL_CALL getName (void)
  85         throw (::com::sun::star::uno::RuntimeException);
  86
  87     /** This call is ignored because the XNamed interface is (mis)used to
  88         give access to a human readable name for debugging purposes.
  89     */
  90     virtual void SAL_CALL setName (const ::rtl::OUString& rName)
  91         throw (::com::sun::star::uno::RuntimeException);
  92 };
  93
  94 } } // end of namespace sd::framework
  95
  96 #endif