framework/inc/helper/dockingareadefaultacceptor.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: dockingareadefaultacceptor.hxx,v $
  10  * $Revision: 1.6 $
  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 __FRAMEWORK_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX_
  32 #define __FRAMEWORK_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <classes/framecontainer.hxx>
  39 #include <threadhelp/threadhelpbase.hxx>
  40 #include <macros/generic.hxx>
  41 #include <macros/xinterface.hxx>
  42 #include <macros/xtypeprovider.hxx>
  43 #include <macros/debug.hxx>
  44
  45 //_________________________________________________________________________________________________________________
  46 //      interface includes
  47 //_________________________________________________________________________________________________________________
  48 #include <com/sun/star/ui/XDockingAreaAcceptor.hpp>
  49 #include <com/sun/star/frame/XFrame.hpp>
  50
  51 //_________________________________________________________________________________________________________________
  52 //      other includes
  53 //_________________________________________________________________________________________________________________
  54 #include <cppuhelper/implbase1.hxx>
  55 #include <cppuhelper/weakref.hxx>
  56
  57 //_________________________________________________________________________________________________________________
  58 //      namespace
  59 //_________________________________________________________________________________________________________________
  60
  61 namespace framework{
  62
  63 //_________________________________________________________________________________________________________________
  64
  65
  66 class DockingAreaDefaultAcceptor    :   private ThreadHelpBase                                      ,
  67                                         public ::cppu::WeakImplHelper1< ::com::sun::star::ui::XDockingAreaAcceptor >
  68 {
  69     public:
  70
  71         //---------------------------------------------------------------------------------------------------------
  72         //      constructor / destructor
  73         //---------------------------------------------------------------------------------------------------------
  74
  75         /*-****************************************************************************************************//**
  76             @short              constructor to initialize this instance
  77             @descr              A docking area acceptor
  78                         But we need a instance to create more then one enumerations to the same tasklist!
  79
  80             @seealso    class Desktop
  81             @seealso    class OTasksEnumeration
  82
  83             @param              "xOwner" is a reference to ouer owner and must be the desktop!
  84             @param              "pTasks" is a pointer to the taskcontainer of the desktop. We need it to create a new enumeration.
  85             @return             -
  86
  87             @onerror    Do nothing and reset this object to default with an empty list.
  88         *//*-*****************************************************************************************************/
  89
  90          DockingAreaDefaultAcceptor(    const css::uno::Reference< css::frame::XFrame >& xOwner );
  91         virtual ~DockingAreaDefaultAcceptor();
  92
  93         //---------------------------------------------------------------------------------------------------------
  94         //      XDockingAreaAcceptor
  95         //---------------------------------------------------------------------------------------------------------
  96
  97         virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getContainerWindow() throw (css::uno::RuntimeException);
  98         virtual sal_Bool SAL_CALL requestDockingAreaSpace( const css::awt::Rectangle& RequestedSpace ) throw (css::uno::RuntimeException);
  99         virtual void SAL_CALL setDockingAreaSpace( const css::awt::Rectangle& BorderSpace ) throw (css::uno::RuntimeException);
 100
 101
 102     //-------------------------------------------------------------------------------------------------------------
 103     //  variables
 104     //  (should be private everyway!)
 105     //-------------------------------------------------------------------------------------------------------------
 106
 107     private:
 108
 109         css::uno::WeakReference< css::frame::XFrame >           m_xOwner                        ;       /// weak reference to our frame object!
 110 };
 111
 112 } // namespace framework
 113
 114 #endif // __FRAMEWORK_HELPER_DOCKINGAREADEFAULTACCEPTOR_HXX_