framework/inc/classes/taskcreator.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: taskcreator.hxx,v $
  10  * $Revision: 1.11 $
  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_CLASSES_TASKCREATOR_HXX_
  32 #define __FRAMEWORK_CLASSES_TASKCREATOR_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <threadhelp/threadhelpbase.hxx>
  39 #include <macros/generic.hxx>
  40 #include <macros/debug.hxx>
  41 #include <general.h>
  42
  43 //_________________________________________________________________________________________________________________
  44 //      interface includes
  45 //_________________________________________________________________________________________________________________
  46 #include <com/sun/star/frame/XFramesSupplier.hpp>
  47 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  48
  49 //_________________________________________________________________________________________________________________
  50 //      other includes
  51 //_________________________________________________________________________________________________________________
  52 #include <com/sun/star/uno/Reference.hxx>
  53 #include <rtl/ustring.hxx>
  54
  55 //_________________________________________________________________________________________________________________
  56 //      namespace
  57 //_________________________________________________________________________________________________________________
  58
  59 namespace framework{
  60
  61 //_________________________________________________________________________________________________________________
  62 //      exported const
  63 //_________________________________________________________________________________________________________________
  64
  65 //_________________________________________________________________________________________________________________
  66 //      exported definitions
  67 //_________________________________________________________________________________________________________________
  68
  69 /*-************************************************************************************************************//**
  70     @short          a helper to create new tasks or sub frames for "_blank" or FrameSearchFlag::CREATE
  71     @descr          There are different places to create new (task)frames. Its not easy to service this code!
  72                     Thats the reason for this helper. He capsulate asynchronous/synchronous creation by calling
  73                     a simple interface.
  74
  75     @devstatus          ready to use
  76     @threadsafe     yes
  77     @modified       20.08.2003 08:37, as96863
  78 *//*-*************************************************************************************************************/
  79 class TaskCreator : private ThreadHelpBase
  80 {
  81     //_______________________
  82     // member
  83     private:
  84
  85         css::uno::Reference< css::lang::XMultiServiceFactory >  m_xSMGR;
  86
  87     //_______________________
  88     // interface
  89     public:
  90
  91                  TaskCreator( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR );
  92         virtual ~TaskCreator(                                                                     );
  93
  94         css::uno::Reference< css::frame::XFrame > createTask( const ::rtl::OUString& sName    ,
  95                                                                     sal_Bool         bVisible );
  96
  97     //_______________________
  98     // helper
  99     private:
 100
 101 }; // class TaskCreator
 102
 103 } // namespace framework
 104
 105 #endif // #ifndef __FRAMEWORK_CLASSES_TASKCREATOR_HXX_