offapi/com/sun/star/awt/XDialog.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: XDialog.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_awt_XDialog_idl__
  31 #define __com_sun_star_awt_XDialog_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** makes it possible to show and hide a dialog and gives access to
  45     the title of the dialog.
  46  */
  47 published interface XDialog: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** sets the title of the dialog.
  52      */
  53     [oneway] void setTitle( [in] string Title );
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** gets the title of the dialog.
  58      */
  59     string getTitle();
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** shows the dialog.
  64      */
  65     short execute();
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** hides the dialog and then causes <member>XDialog::execute</member>
  70         to return.
  71      */
  72     void endExecute();
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif