offapi/com/sun/star/embed/XInsertObjectDialog.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_embed_XInsertObjectDialog_idl__
  20 #define __com_sun_star_embed_XInsertObjectDialog_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/embed/XStorage.idl>
  24 #include <com/sun/star/embed/InsertedObjectInfo.idl>
  25 #include <com/sun/star/io/IOException.idl>
  26 #include <com/sun/star/embed/WrongStateException.idl>
  27 #include <com/sun/star/lang/IllegalArgumentException.idl>
  28 #include <com/sun/star/beans/PropertyValue.idl>
  29
  30
  31  module com {  module sun {  module star {  module embed {
  32
  33 /** allows to create and initialize a new embedded object using GUI dialog.
  34  */
  35 published interface XInsertObjectDialog: com::sun::star::uno::XInterface
  36 {
  37     /** creates a new object using GUI dialog.
  38
  39         <p>
  40         The dialog allows for user to do a number of choices that are container
  41         related. This information will be returned in the
  42         InsertedObjectInfo object.
  43         <p>
  44
  45         @param xStorage
  46             a parent storage the entry should be created/opened in
  47
  48         @param sEntName
  49             a name for the entry
  50
  51         @param lObjArgs
  52             optional parameters for the object persistence initialization
  53             see also com::sun::star::embed::EmbeddedObjectDescriptor
  54
  55         @returns
  56             the structure containing the object and container related options
  57
  58         @throws ::com::sun::star::lang::IllegalArgumentException
  59             one of arguments is illegal
  60
  61         @throws com::sun::star::io::IOException
  62             in case of io problems during opening or creation
  63
  64         @throws com::sun::star::uno::Exception
  65             in case of other problems
  66      */
  67     InsertedObjectInfo createInstanceByDialog(
  68                             [in] ::com::sun::star::embed::XStorage xStorage,
  69                             [in] string sEntName,
  70                             [in] sequence< ::com::sun::star::beans::PropertyValue > lObjArgs )
  71         raises( ::com::sun::star::lang::IllegalArgumentException,
  72                 ::com::sun::star::io::IOException,
  73                 ::com::sun::star::uno::Exception );
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */