offapi/com/sun/star/awt/XMessageBoxFactory.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: XMessageBoxFactory.idl,v $
  10  * $Revision: 1.5 $
  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_XMessageBoxFactory_idl__
  32 #define __com_sun_star_awt_XMessageBoxFactory_idl__
  33
  34 #ifndef __com_sun_star_awt_XWindowPeer_idl__
  35 #include <com/sun/star/awt/XWindowPeer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_XMessageBox_idl__
  39 #include <com/sun/star/awt/XMessageBox.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_awt_MessageBoxButtons_idl__
  43 #include <com/sun/star/awt/MessageBoxButtons.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_awt_Rectangle_idl__
  47 #include <com/sun/star/awt/Rectangle.idl>
  48 #endif
  49
  50
  51 //=============================================================================
  52
  53 module com { module sun { module star { module awt {
  54
  55 //=============================================================================
  56
  57 /** specifies a factory interface for creating message boxes.
  58  */
  59 published interface XMessageBoxFactory : com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** creates a message box.
  64
  65         @returns
  66         the created message box or a null reference if it cannot be
  67         created.
  68
  69         @param aParent
  70         a valid XWindowPeer reference which is used as a parent. This parameter
  71         must not be null.
  72
  73         @param aPosSize
  74         a rectangle which defines the position and size of the message
  75         box in pixel.
  76
  77         @param aType
  78         a string which determines the message box type.
  79         The following strings are defined.
  80         <ul>
  81             <li><b>infobox</b>A message box to inform the user about a certain event.
  82                 <b>Attention:</b><br/>This type of message box ignores the argument
  83                 aButton because a info box always shows a OK button.
  84             </li>
  85             <li><b>warningbox</b>A message to warn the user about a certain problem.</li>
  86             <li><b>errorbox</b>A message box to provide an error message to the user.</li>
  87             <li><b>querybox</b>A message box to query information from the user.</li>
  88             <li><b>messbox</b>A normal message box.</li>
  89         </ul>
  90
  91         @param aButtons
  92         specifies which buttons should be available on the
  93         message box. A combination of
  94         <type scope="com::sun::star::awt">MessageBoxButtons</type>. An <b>infobox</b>
  95         ignores this paramter and always use button "OK".
  96
  97         @param aTitle
  98         specifies the title of the message box.
  99
 100         @param aMessage
 101         specifies text which will be shown by the message box.
 102         Line-breaks must be added using 'CR' or 'CR+LF'.
 103     */
 104     XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent, [in] com::sun::star::awt::Rectangle aPosSize, [in] string aType, [in] long aButtons, [in] string aTitle, [in] string aMessage );
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif