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 #pragma once
  21
  22 #include <com/sun/star/frame/XFrame.hpp>
  23 #include <com/sun/star/uno/XComponentContext.hpp>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <rtl/ustring.hxx>
  27 #include <unotools/mediadescriptor.hxx>
  28
  29 namespace framework{
  30
  31 /*
  32     @short          a helper to create new tasks or sub frames for "_blank" or FrameSearchFlag::CREATE
  33     @descr          There are different places to create new (task)frames and it's not easy to service this code.
  34                     That's the reason for this helper. It encapsulates asynchronous/synchronous creation
  35                     by providing a simple interface.
  36
  37     @devstatus      ready to use
  38     @threadsafe     yes
  39 */
  40 class TaskCreator final
  41 {
  42
  43     // member
  44     private:
  45
  46         css::uno::Reference< css::uno::XComponentContext >  m_xContext;
  47
  48     // interface
  49     public:
  50
  51                  TaskCreator( css::uno::Reference< css::uno::XComponentContext > xContext );
  52                  ~TaskCreator(                                                                     );
  53
  54         css::uno::Reference< css::frame::XFrame > createTask( const OUString& sName, const utl::MediaDescriptor& rDescriptor );
  55
  56 }; // class TaskCreator
  57
  58 } // namespace framework
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */