offapi/com/sun/star/awt/XDialogProvider.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: XDialogProvider.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_awt_XDialogProvider_idl__
  32 #define __com_sun_star_awt_XDialogProvider_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_awt_XDialog_idl__
  38 #include <com/sun/star/awt/XDialog.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  41 #include <com/sun/star/lang/IllegalArgumentException.idl>
  42 #endif
  43
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module awt {
  48
  49 //=============================================================================
  50
  51 /** provides dialogs implementing the
  52     <type scope="com::sun::star::awt">XDialog</type> interface.
  53  */
  54 interface XDialogProvider : ::com::sun::star::uno::XInterface {
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** creates a dialog for the given URL.
  59
  60         @param URL
  61             is the URL.
  62
  63         @returns
  64             a dialog implementing the <type scope="com::sun::star::awt">XDialog</type> interface.
  65
  66         @throws com::sun::star::lang::IllegalArgumentException
  67             if no dialog for the given URL is found or if the URL is invalid.
  68      */
  69     com::sun::star::awt::XDialog createDialog( [in] string URL )
  70         raises ( com::sun::star::lang::IllegalArgumentException );
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif