1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#ifndef __com_sun_star_awt_XMessageBoxFactory_idl__
23#define __com_sun_star_awt_XMessageBoxFactory_idl__
24
25#include <com/sun/star/awt/XWindowPeer.idl>
26#include <com/sun/star/awt/XMessageBox.idl>
27#include <com/sun/star/awt/MessageBoxButtons.idl>
28#include <com/sun/star/awt/MessageBoxType.idl>
29
30module com { module sun { module star { module awt {
31
32/** specifies a factory interface for creating message boxes.
33 */
34published interface XMessageBoxFactory : com::sun::star::uno::XInterface
35{
36    /** creates a message box.
37
38        @returns
39            the created message box or a null reference if it cannot be
40            created.
41
42        @param aParent
43            a valid XWindowPeer reference which is used as a parent.
44
45            <p>This parameter must not be null.</p>
46
47        @param aType
48            the message box type.
49
50        @param aButtons
51            specifies which buttons should be available on the message box.
52
53            <p>A combination of <type>MessageBoxButtons</type>.</p>
54            <p>A <member scope="com::sun::star::awt">MessageBoxType::INFOBOX</member>
55            ignores this paramter, instead it uses a
56            <member scope="com::sun::star::awt">MessageBoxButtons::BUTTONS_OK</member>.</p>
57
58        @param aTitle
59                specifies the title of the message box.
60
61        @param aMessage
62            specifies text which will be shown by the message box.
63            Line-breaks must be added using 'CR' or 'CR+LF'.
64    */
65    XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent,
66                                  [in] MessageBoxType eType,
67                                  [in] long nButtons,
68                                  [in] string sTitle,
69                                  [in] string sMessage );
70};
71
72}; }; }; };
73
74#endif
75