offapi/com/sun/star/embed/XInsertObjectDialog.idl

   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: XInsertObjectDialog.idl,v $
  10  * $Revision: 1.5 $
  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 #ifndef __com_sun_star_embed_XInsertObjectDialog_idl__
  31 #define __com_sun_star_embed_XInsertObjectDialog_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_embed_XStorage_idl__
  38 #include <com/sun/star/embed/XStorage.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_embed_InsertedObjectInfo_idl__
  42 #include <com/sun/star/embed/InsertedObjectInfo.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_io_IOException_idl__
  46 #include <com/sun/star/io/IOException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_embed_WrongStateException_idl__
  50 #include <com/sun/star/embed/WrongStateException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  54 #include <com/sun/star/lang/IllegalArgumentException.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_PropertyValue_idl__
  58 #include <com/sun/star/beans/PropertyValue.idl>
  59 #endif
  60
  61 //=============================================================================
  62
  63  module com {  module sun {  module star {  module embed {
  64
  65 //=============================================================================
  66 /** allows to create and initialize a new embedded object using GUI dialog.
  67  */
  68 interface XInsertObjectDialog: com::sun::star::uno::XInterface
  69 {
  70     //-------------------------------------------------------------------------
  71     /** creates a new object using GUI dialog.
  72
  73         <p>
  74         The dialog allows for user to do a number of choices that are container
  75         related. This infomation will be returned in the
  76         <type>InsertedObjectInfo</type> object.
  77         <p>
  78
  79         @param xStorage
  80             a parent storage the entry should be created/opened in
  81
  82         @param sEntName
  83             a name for the entry
  84
  85         @param lObjArgs
  86             optional parameters for the object persistence initialization
  87             see also <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
  88
  89         @returns
  90             the structure containing the object and container related options
  91
  92         @thrown ::com::sun::star::lang::IllegalArgumentException
  93             one of arguments is illegal
  94
  95         @throws com::sun::star::io::IOException
  96             in case of io problems during opening\creation
  97
  98         @throws com::sun::star::uno::Exception
  99             in case of other problems
 100      */
 101     InsertedObjectInfo createInstanceByDialog(
 102                             [in] ::com::sun::star::embed::XStorage xStorage,
 103                             [in] string sEntName,
 104                             [in] sequence< ::com::sun::star::beans::PropertyValue > lObjArgs )
 105         raises( ::com::sun::star::lang::IllegalArgumentException,
 106                 ::com::sun::star::io::IOException,
 107                 ::com::sun::star::uno::Exception );
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif
 115