framework/inc/classes/taskcreator.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_CLASSES_TASKCREATOR_HXX
  21 #define INCLUDED_FRAMEWORK_INC_CLASSES_TASKCREATOR_HXX
  22
  23 #include <macros/generic.hxx>
  24 #include <general.h>
  25
  26 #include <com/sun/star/frame/XFramesSupplier.hpp>
  27 #include <com/sun/star/uno/XComponentContext.hpp>
  28
  29 #include <com/sun/star/uno/Reference.hxx>
  30 #include <rtl/ustring.hxx>
  31
  32 namespace framework{
  33
  34 /*-************************************************************************************************************
  35     @short          a helper to create new tasks or sub frames for "_blank" or FrameSearchFlag::CREATE
  36     @descr          There are different places to create new (task)frames. Its not easy to service this code!
  37                     Thats the reason for this helper. He capsulate asynchronous/synchronous creation by calling
  38                     a simple interface.
  39
  40     @devstatus      ready to use
  41     @threadsafe     yes
  42 *//*-*************************************************************************************************************/
  43 class TaskCreator
  44 {
  45
  46     // member
  47     private:
  48
  49         css::uno::Reference< css::uno::XComponentContext >  m_xContext;
  50
  51     // interface
  52     public:
  53
  54                  TaskCreator( const css::uno::Reference< css::uno::XComponentContext >& xContext );
  55         virtual ~TaskCreator(                                                                     );
  56
  57         css::uno::Reference< css::frame::XFrame > createTask( const OUString& sName    ,
  58                                                                     bool         bVisible );
  59
  60     // helper
  61     private:
  62
  63 }; // class TaskCreator
  64
  65 } // namespace framework
  66
  67 #endif // INCLUDED_FRAMEWORK_INC_CLASSES_TASKCREATOR_HXX
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */