offapi/com/sun/star/ucb/XSourceInitialization.idl

   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 #ifndef __com_sun_star_ucb_XSourceInitialization_idl__
  20 #define __com_sun_star_ucb_XSourceInitialization_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/AlreadyInitializedException.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** provides the initialization of a component with any source object.
  29 */
  30
  31 published interface XSourceInitialization: com::sun::star::uno::XInterface
  32 {
  33     /** provides the initialization of a component with any source object.
  34
  35         <p>The service description has to specify which type of interface must
  36         be set as parameter.
  37
  38         <p>Hopefully you will only use this, when <var>Source</var>
  39         is an com::sun::star::lang::XComponent and this
  40         is an com::sun::star::lang::XEventListener.
  41         Than you should call
  42         com::sun::star::lang::XComponent::addEventListener()
  43         from inside the implementation of this method.
  44
  45         @param Source
  46         the source.
  47
  48         @throws AlreadyInitializedException
  49         if this method is called more than once during the lifetime of the
  50         object implementing this interface.
  51
  52     */
  53     void setSource( [in] com::sun::star::uno::XInterface Source )
  54          raises (AlreadyInitializedException);
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */