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

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