framework/inc/helper/dockingareadefaultacceptor.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_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX
  21 #define INCLUDED_FRAMEWORK_INC_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX
  22
  23 #include <classes/framecontainer.hxx>
  24 #include <macros/generic.hxx>
  25 #include <macros/xinterface.hxx>
  26 #include <macros/xtypeprovider.hxx>
  27
  28 #include <com/sun/star/ui/XDockingAreaAcceptor.hpp>
  29 #include <com/sun/star/frame/XFrame.hpp>
  30
  31 #include <cppuhelper/implbase1.hxx>
  32 #include <cppuhelper/weakref.hxx>
  33
  34 namespace framework{
  35
  36 class DockingAreaDefaultAcceptor    :   public ::cppu::WeakImplHelper1< ::com::sun::star::ui::XDockingAreaAcceptor >
  37 {
  38     public:
  39
  40         //  constructor / destructor
  41
  42         /*-****************************************************************************************************
  43             @short      constructor to initialize this instance
  44             @descr      A docking area acceptor
  45                         But we need a instance to create more than one enumerations to the same tasklist!
  46
  47             @seealso    class Desktop
  48             @seealso    class OTasksEnumeration
  49
  50             @param      "xOwner" is a reference to our owner and must be the desktop!
  51             @param      "pTasks" is a pointer to the taskcontainer of the desktop. We need it to create a new enumeration.
  52             @onerror    Do nothing and reset this object to default with an empty list.
  53         *//*-*****************************************************************************************************/
  54
  55          DockingAreaDefaultAcceptor(    const css::uno::Reference< css::frame::XFrame >& xOwner );
  56         virtual ~DockingAreaDefaultAcceptor();
  57
  58         //  XDockingAreaAcceptor
  59
  60         virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getContainerWindow() throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  61         virtual sal_Bool SAL_CALL requestDockingAreaSpace( const css::awt::Rectangle& RequestedSpace ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  62         virtual void SAL_CALL setDockingAreaSpace( const css::awt::Rectangle& BorderSpace ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  63
  64     //  variables
  65     //  (should be private everyway!)
  66
  67     private:
  68
  69         css::uno::WeakReference< css::frame::XFrame >       m_xOwner;   /// weak reference to our frame object!
  70 };
  71
  72 } // namespace framework
  73
  74 #endif // INCLUDED_FRAMEWORK_INC_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */