offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
  29 #define __com_sun_star_ui_dialogs_XExecutableDialog_idl__
  30
  31 #ifndef __com_sun_star_uno_RuntimeException_idl__
  32 #include <com/sun/star/uno/RuntimeException.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_uno_XInterface_idl__
  36 #include <com/sun/star/uno/XInterface.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module ui { module dialogs {
  42
  43 //=============================================================================
  44 /** Specifies an interface for an executable dialog.
  45 */
  46
  47
  48 published interface XExecutableDialog: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51     /** Sets the title of the dialog.
  52
  53         @param aTitle
  54         Set an abitrary title for the dialog,
  55         may be an empty string if the dialog should not
  56         have a title.
  57     */
  58     void setTitle( [in] string aTitle );
  59
  60     //-------------------------------------------------------------------------
  61     /** Executes (shows) the dialog.
  62
  63         @returns
  64         A status code of type <type>ExecutableDialogResults</type>.
  65     */
  66     short execute();
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; }; };
  72
  73
  74 #endif
  75