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