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