Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*************************************************************************
       3                 :            :  *
       4                 :            :  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       5                 :            :  *
       6                 :            :  * Copyright 2000, 2010 Oracle and/or its affiliates.
       7                 :            :  *
       8                 :            :  * OpenOffice.org - a multi-platform office productivity suite
       9                 :            :  *
      10                 :            :  * This file is part of OpenOffice.org.
      11                 :            :  *
      12                 :            :  * OpenOffice.org is free software: you can redistribute it and/or modify
      13                 :            :  * it under the terms of the GNU Lesser General Public License version 3
      14                 :            :  * only, as published by the Free Software Foundation.
      15                 :            :  *
      16                 :            :  * OpenOffice.org is distributed in the hope that it will be useful,
      17                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      18                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      19                 :            :  * GNU Lesser General Public License version 3 for more details
      20                 :            :  * (a copy is included in the LICENSE file that accompanied this code).
      21                 :            :  *
      22                 :            :  * You should have received a copy of the GNU Lesser General Public License
      23                 :            :  * version 3 along with OpenOffice.org.  If not, see
      24                 :            :  * <http://www.openoffice.org/license.html>
      25                 :            :  * for a copy of the LGPLv3 License.
      26                 :            :  *
      27                 :            :  ************************************************************************/
      28                 :            : #ifndef _CPPUHELPER_COMPONENT_CONTEXT_HXX_
      29                 :            : #define _CPPUHELPER_COMPONENT_CONTEXT_HXX_
      30                 :            : 
      31                 :            : #include <com/sun/star/uno/XComponentContext.hpp>
      32                 :            : #include <com/sun/star/lang/XSingleComponentFactory.hpp>
      33                 :            : #include "cppuhelperdllapi.h"
      34                 :            : 
      35                 :            : 
      36                 :            : namespace cppu
      37                 :            : {
      38                 :            : 
      39                 :            : /** Context entries init struct calling createComponentContext().
      40                 :            : */
      41                 :      43803 : struct ContextEntry_Init
      42                 :            : {
      43                 :            :     /** late init denotes a object that will be raised when first get() is calling for it
      44                 :            : 
      45                 :            :         The context implementation expects either a ::com::sun::star::lang::XSingleComponentFactory
      46                 :            :         object as value (to instanciate the object) or a string as value for raising
      47                 :            :         a service via the used service manager.
      48                 :            :     */
      49                 :            :     bool bLateInitService;
      50                 :            :     /** name of context value
      51                 :            :     */
      52                 :            :     ::rtl::OUString name;
      53                 :            :     /** context value
      54                 :            :     */
      55                 :            :     ::com::sun::star::uno::Any value;
      56                 :            : 
      57                 :            :     /** Default ctor.
      58                 :            :     */
      59                 :       8913 :     inline ContextEntry_Init() SAL_THROW(())
      60                 :       8913 :         : bLateInitService( false )
      61                 :       8913 :         {}
      62                 :            :     /** Ctor.
      63                 :            : 
      64                 :            :         @param name_
      65                 :            :                name of entry
      66                 :            :         @param value_
      67                 :            :                value of entry
      68                 :            :         @param bLateInitService_
      69                 :            :                whether this entry is a late-init named object entry
      70                 :            :                (value is object factory or service string)
      71                 :            :     */
      72                 :       4686 :     inline ContextEntry_Init(
      73                 :            :         ::rtl::OUString const & name_,
      74                 :            :         ::com::sun::star::uno::Any const & value_,
      75                 :            :         bool bLateInitService_ = false ) SAL_THROW(())
      76                 :            :             : bLateInitService( bLateInitService_ ),
      77                 :            :               name( name_ ),
      78                 :       4686 :               value( value_ )
      79                 :       4686 :         {}
      80                 :            : };
      81                 :            : 
      82                 :            : /** Creates a component context with the given entries.
      83                 :            : 
      84                 :            :     @param pEntries array of entries
      85                 :            :     @param nEntries number of entries
      86                 :            :     @param xDelegate delegation to further context, if value was not found
      87                 :            :     @return new context object
      88                 :            : */
      89                 :            : CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
      90                 :            : SAL_CALL createComponentContext(
      91                 :            :     ContextEntry_Init const * pEntries, sal_Int32 nEntries,
      92                 :            :     ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > const & xDelegate =
      93                 :            :     ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >() )
      94                 :            :     SAL_THROW(());
      95                 :            : 
      96                 :            : }
      97                 :            : 
      98                 :            : #endif
      99                 :            : 
     100                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */