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